ページ処理を行うには、Zend_Paginator がデータにアクセスするための汎用的な方法が必要です。 そのため、データへのアクセスはすべてデータソースアダプタを用いて行います。 Zend Framework には、いくつかのアダプタが標準で同梱されています。

Note:

指定したクエリにマッチするすべての行を取得するのではなく、 DbSelect アダプタや DbTableSelect アダプタは 現在のページの表示のための必要最小限のデータのみを取得します。

そのため、マッチする行の総数を得るための別のクエリが動的に生成されます。 しかし、総数を直接指定したり、総数を求めるクエリを直接指定したりすることもできます。 詳細な情報は、DbSelect アダプタの setRowCount() メソッドを参照ください。

Zend_Paginator のインスタンスを作成するには、 コンストラクタでアダプタを指定しなければなりません。

$paginator = new Zend_Paginator(new Zend_Paginator_Adapter_Array($array));

利便性を確保するために、Zend Framework に同梱されているアダプタ用の静的メソッド factory() も用意されています。

$paginator = Zend_Paginator::factory($array);

Note:

Null アダプタの場合は、 データコレクションのかわりに要素数をコンストラクタで指定します。

この状態でも技術的には既に使用可能ですが、 ユーザが要求したページ番号をコントローラのアクション内で教えてやる必要があります。 これにより、データを読み進めていくことが可能となります。

$paginator->setCurrentPageNumber($page);

ページ番号は URL で指定するのがもっともシンプルな方法でしょう。 Zend_Controller_Router_Interface 互換のルータを使うことを推奨しますが、 それが必須というわけではありません。

INI ファイルで定義するルートの例を次に示します。

routes.example.route = articles/:articleName/:page
routes.example.defaults.controller = articles
routes.example.defaults.action = view
routes.example.defaults.page = 1
routes.example.reqs.articleName = \w+
routes.example.reqs.page = \d+

この設定を使った (そして Zend Framework の MVC コンポーネントを使った) 場合、現在のページ番号を設定するコードはこのようになります。

$paginator->setCurrentPageNumber($this->_getParam('page'));

それ以外にもオプションがあります。詳細は 設定 を参照ください。

最後に、paginator のインスタンスをビューに割り当てます。 Zend_View と ViewRenderer アクションヘルパーを使っている場合は、 次のようになります。

$this->view->paginator = $paginator;

ビュースクリプトを使用してページ項目のレンダリング (Zend_Paginator を使うよう設定している場合) とページ処理コントロールの表示を行います。

Zend_Paginator は SPL の » IteratorAggregate インターフェイスを実装しているので、 項目を順次処理したり表示したりするのは簡単です。

Example
paginator)): ?>

paginator as $item): ?>
  





paginationControl($this->paginator, 'Sliding', 'my_pagination_control.phtml'); ?>

最後のほうでビューヘルパーをコールしているところに注目しましょう。 PaginationControl 4 つまでのパラメータを受け取ります。 paginator のインスタンス、スクロール形式、 そして追加パラメータの配列です。

2 番目と 3 番目のパラメータは重要です。 ビュー partial はページ処理コントロールの 見た目を決めるために用いられ、 一方スクロール形式はその 振る舞い を決めるために用いられます。ビュー partial が、次のようなページ処理コントロール形式だっととしましょう。

ここで "next" リンクを数回クリックしたときに、いったい何が起こるでしょう? そう、いろんなことが起こりえます。 クリックし続けても現在のページがずっと中央に表示される (Yahoo! 形式) かもしれませんし、 表示される範囲はそのままで現在のページの位置がどんどん右にずれていき、 表示範囲の最後をページでさらに "next" をクリックしたときに一番左に戻るかもしれません。 ページを進めるたびにページ数そのものが増加 ("scroll") していく (Google 形式) も考えられます。

4 種類のスクロール形式が Zend Framework に組み込まれています。

4 番目、そして最後のパラメータはオプションの連想配列です。 ここで、ビューパーシャルから ($this を用いて) 使用したい追加変数を指定します。 たとえば、ページ移動用のリンクに使用する追加の URL パラメータなどを含めることができます。

デフォルトのビュー partial とスクロール形式、 そしてビューのインスタンスを設定してしまえば、 PaginationControl のコールを完全に除去することができます。

Zend_Paginator::setDefaultScrollingStyle('Sliding');
Zend_View_Helper_PaginationControl::setDefaultViewPartial('my_pagination_control.phtml');
$paginator->setView($view);

これらの値をすべて設定すると、 ビュースクリプト内で単純な echo 文を使用するだけでページ処理コントロールをレンダリングできるようになります。

paginator; ?>

Note:

もちろん、Zend_Paginator を別のテンプレートエンジンで使用することもできます。 たとえば、Smarty を使用する場合は次のようになります。

$smarty->assign('pages', $paginator->getPages());

そして、テンプレートからは次のようにして paginator の値にアクセスします。

{$pages.pageCount}

pageCount): ?> 

 
previous)): ?> 
  < Previous | 
 
  < Previous | 
 


pagesInRange as $page): ?> 
  current): ?>
     | 
  
     | 
  


 
next)): ?> 
  Next >
 
  Next >
 
 

pageCount): ?> 

firstItemNumber; ?> - lastItemNumber; ?> 
of totalItemCount; ?>


previous)): ?>
  First | 

  First |
 

 
previous)): ?> 
  < Previous | 
 
  < Previous | 
 

 
next)): ?> 
  Next > |
 
  Next > |



next)): ?>
  Last

  Last
 

 

pageCount): ?> 
 
pagesInRange as $page): ?>
  current) ? ' selected="selected"' : ''; ?>
  >