Previous Next

使用法

データコレクションのページ処理

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

Zend_Paginator 用のアダプタ
アダプタ 説明
Array PHP の配列を使用します。
DbSelect Zend_Db_Select のインスタンスを使用し、配列を返します。
DbTableSelect Zend_Db_Table_Select のインスタンスを使用し、 Zend_Db_Table_Rowset_Abstract のインスタンスを返します。 これは、結果セットについての追加情報 (カラム名など) を提供します。
Iterator » Iterator のインスタンスを使用します。
Null データのページ処理を管理する際に Zend_Paginator を使用しません。その場合でもページ処理コントロールの機能を使うことはできます。

注意:

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

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

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

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

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

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

注意:

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;

DbSelect および DbTableSelect アダプタ

大半のアダプタの使用法は非常にわかりやすいものです。 しかし、データベースアダプタについては、 データベースからのデータの取得方法や件数の数え方についてのより詳細な説明が必要です。

DbSelect アダプタや DbTableSelect アダプタを使う際には、 事前にデータベースからデータを取得する必要はありません。 どちらのアダプタも、自動的にデータを取得して総ページ数を計算します。 もしデータベースからのデータに対して何らかの処理が必要となるのなら、 アダプタの getItems() メソッドをアプリケーション内で継承します。

さらに、これらのアダプタは、 数を数える際にデータベースの全レコードを取得するわけでは ありません。そのかわりに、アダプタが元のクエリを修正し、 それに対応する COUNT クエリを作成します。 Paginator は、その COUNT クエリを実行して行数を取得するのです。 そのぶんデータベースとの余分なやりとりが必要となりますが、結果セット全体を取得して count() を使うよりは何倍も高速になります。 大量のデータを扱う場合などは特にそうです。

データベースアダプタは、すべてのモダンなデータベース上で実行できる もっとも効率的なクエリを作成しようとします。 しかし、使用するデータベースやスキーマ設定によっては 行数を取得するのにもっと効率的な方法があるかもしれません。 そのような場合のために、データベースアダプタでは独自の COUNT クエリを設定できるようにもなっています。たとえば、 別々のテーブルにある blog の投稿の数を調べるには、 次の用に設定すればより高速な count クエリが使用できるでしょう。

$adapter = new Zend_Paginator_Adapter_DbSelect($db->select()->from('posts'));
$adapter->setRowCount(
    $db->select()
       ->from(
            'item_counts',
            array(
               Zend_Paginator_Adapter_DbSelect::ROW_COUNT_COLUMN => 'post_count'
            )
         )
);

$paginator = new Zend_Paginator($adapter);

この方法は、小規模なデータや単純な select クエリの場合にはあまり劇的な効果を得られません。 しかし、複雑なクエリや大規模なデータを扱う場合は かなりパフォーマンスが向上することでしょう。

ビュースクリプトによるページのレンダリング

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

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



Example

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

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

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

zend.paginator.usage.rendering.control.png

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

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

Zend_Paginator のスクロール形式
スクロール形式 説明
All すべてのページを返します。 総ページ数が比較的少なめのときなど、 ドロップダウンメニュー形式でページ選択をさせる際に便利です。 そのような場合は、利用できるすべてのページを 一度にユーザに見せることになるでしょう。
Elastic Google 風のスクロール形式で、 ユーザがページを移動するのにあわせて拡大・縮小します。
Jumping ユーザがページを進めるにつれて、 ページ番号が表示範囲の最後に向けて進んでいきます。 表示範囲を超えると、新しい範囲の最初の位置に移動します。
Sliding Yahoo! 風のスクロール形式で、 現在表示されているページが常にページ範囲の中央 (あるいは可能な限りそれに近い場所) にあるようにします。これがデフォルトの形式です。

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

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

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

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

paginator; ?>

注意:

もちろん、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): ?>




プロパティの一覧

次のオプションが、ページ処理コントロールのビュー partial で使用可能です。

ビュー partial のプロパティ
プロパティ 説明
first integer 最初のページ番号 (つまり 1)
firstItemNumber integer このページの最初の項目の番号
firstPageInRange integer スクロール形式で返された範囲内の最初のページ
current integer 現在のページ番号
currentItemCount integer このページの項目の数
itemCountPerPage integer 各ページに表示できる項目の最大数
last integer 最後のページ番号
lastItemNumber integer このページの最後の項目の番号
lastPageInRange integer スクロール形式で返された範囲内の最後のページ
next integer 次のページ番号
pageCount integer ページ数
pagesInRange array スクロール形式で返されたページの配列
previous integer 前のページ番号
totalItemCount integer 項目の総数
Previous Next
Zend Framework の紹介
概要
インストール
Zend Framework を学ぶ(主に英語)
クイックスタート(ごく一部のみ日本語)
Zend Framework & MVC Introduction
プロジェクトを作成
Create A Layout
モデルとデータベーステーブルの作成
Create A Form
おめでとう!
オートローディング(英語)
Introduction
Goals and Design
Basic Autoloader Usage
Resource Autoloading
Conclusion
プラグイン(英語)
Introduction
Using Plugins
Conclusion
Zend_Layout 入門(英語)
Introduction
Using Zend_Layout
Zend_Layout: Conclusions
Zend_View プレイスフォルダ入門(英語)
Introduction
Basic Placeholder Usage
Standard Placeholders
View Placeholders: Conclusion
Zend Form デコレータを理解して使う(ごく一部のみ日本語)
Introduction
Decorator Basics
Layering Decorators
Rendering Individual Decorators
Creating and Rendering Composite Elements
結論
Zend_Session, Zend_Auth, Zend_Acl 入門(英語)
Building Multi-User Applications With Zend Framework
Managing User Sessions In ZF
Authenticating Users in Zend Framework
Building an Authorization System in Zend Framework
Zend_Search_Lucene 入門(一部日本語)
Zend_Search_Lucene Introduction
Lucene Index Structure
インデックスのオープンと生成
索引付け
検索
サポートされるクエリー
検索結果のページ化
Zend_Paginator 入門(英語)
Introduction
Simple Examples
Pagination Control and ScrollingStyles
Putting it all Together
Zend Framework リファレンス
Zend_Acl
導入
アクセス制御の洗練
高度な使用法
Zend_Amf
導入
Zend_Amf_Server(日本語)
Zend_Application
導入
Zend_Application クイックスタート
Theory of Operation
コア機能
利用できるリソースプラグイン
Zend_Auth
導入
データベースのテーブルでの認証
ダイジェスト認証
HTTP 認証アダプタ
LDAP 認証
Open ID 認証
Zend_Barcode
導入
Barcode creation using Zend_Barcode class
Zend_Barcode Objects
Zend_Barcode Renderers
Zend_Cache
導入
キャッシュの仕組み
Zend_Cache のフロントエンド
Zend_Cache のバックエンド
The Cache Manager
Zend_Captcha
導入
Captcha の方法
CAPTCHA アダプタ
SimpleCloud API: Zend_Cloud
Document Service Introduction
Queue Service Introduction
StorageService Introduction
Zend_CodeGenerator
導入
Zend_CodeGeneratorサンプル
Zend_CodeGenerator リファレンス
Zend_Config
導入
動作原理
Zend_Config_Ini(日本語)
Zend_Config_Json
Zend_Config_Xml(日本語)
Zend_Config_Yaml
Zend_Config_Writer
Zend_Config_Writer(日本語)
Zend_Console_Getopt
導入
Getopt の規則の宣言
オプションおよび引数の取得
Zend_Console_Getopt の設定
Zend_Controller
Zend_Controller クイックスタート
Zend_Controller の基本
フロントコントローラ
リクエストオブジェクト
標準のルータ
ディスパッチャ
アクションコントローラ
アクションヘルパー
レスポンスオブジェクト
プラグイン
モジュラーディレクトリ構造の規約の使用
MVC での例外
Zend_Currency
Zend_Currency について
Using Zend_Currency
Options for currencies
What makes a currency?
Where is the currency?
How does the currency look like?
How much is my currency?
Calculating with currencies
Exchanging currencies
Additional informations on Zend_Currency
Zend_Date
導入
動作原理
基本メソッド
Zend_Date API の概要
日付の作成
日付関数全般用の定数
動作例
Zend_Db
Zend_Db_Adapter(日本語)
Zend_Db_Statement(日本語)
Zend_Db_Profiler(日本語)
Zend_Db_Select(日本語)
Zend_Db_Table(日本語)
Zend_Db_Table_Row(日本語)
Zend_Db_Table_Rowset(日本語)
導入
Zend_Db_Table_Definition(日本語)
Zend_Debug
変数の出力
Zend_Dojo
導入
Zend_Dojo_Data: dojo.data エンベロープ
Dojo ビューヘルパー
Dojoフォーム要素とデコレーター
Zend_Dojo build layer support
Zend_Dom
導入
Zend_Dom_Query(日本語)
Zend_Exception
例外の使用法
基本的な使用法
Previous Exceptions (前の例外)
Zend_Feed
導入
フィードの読み込み
ウェブページからのフィードの取得
RSS フィードの使用
Atom フィードの使用
単一の Atom エントリの処理
フィードおよびエントリの構造の変更
独自のフィードクラスおよびエントリクラス
Zend_Feed_Reader
Zend_Feed_Writer
Zend_Feed_Pubsubhubbub
Zend_File
Zend_File_Transfer(日本語)
Zend_File_Transfer 用のバリデータ
Filters for Zend_File_Transfer
Zend_Filter
導入
標準のフィルタクラス群
フィルタチェイン
フィルタの書き方
Zend_Filter_Input(日本語)
Zend_Filter_Inflector(日本語)
Zend_Form
Zend_Form(日本語)
Zend_Form クイックスタート
Zend_Form_Element を用いたフォーム要素の作成
Zend_Form によるフォームの作成
Zend_Form_Decorator による独自のフォームマークアップの作成
Zend Framework に同梱されている標準のフォーム要素
Zend Framework に同梱されている標準のデコレータ
Zend_Form の国際化
Zend_Form の高度な使用法
Zend_Gdata
導入
AuthSub による認証
Using the Book Search Data API
ClientLogin による認証
Google Calendar の使用法
Google Documents List Data API の使用法
Using Google Health
Google Spreadsheets の使用法
Google Apps Provisioning の使用法
Google Base の使用法
Picasa Web Albums の使用法
YouTube Data API の使用法
Gdata の例外処理
Zend_Http
導入
Zend_Http_Client - 高度な使用法
Zend_Http_Client - 接続アダプタ
Zend_Http_Cookie および Zend_Http_CookieJar
Zend_Http_Response(日本語)
Zend_Http_UserAgent
The UserAgent Device Interface
The UserAgent Features Adapter
The WURFL UserAgent Features Adapter
The DeviceAtlas UserAgent Features Adapter
The TeraWurfl UserAgent Features Adapter
The UserAgent Storage Interface
The Session UserAgent Storage Adapter
Zend_InfoCard
導入
Zend_Json
導入
基本的な使用法
Zend_Json の高度な使用法
XML から JSON への変換
Zend_Json_Server - JSON-RPCサーバー
Zend_Layout
導入
Zend_Layout クイックスタート
Zend_Layout の設定オプション
Zend_Layout の高度な使用法
Zend_Ldap
導入
API概要
利用シナリオ
ツール
Zend_Ldap_Nodeを使用してLDAPツリーへのオブジェクト指向アクセス
LDAPサーバから情報を取得
LDIFへ、または、からのLDAPデータシリアライズ
Zend_Loader
ファイルやクラスの動的な読み込み
The Autoloader
Resource Autoloaders
プラグインのロード
Zend_Locale
導入
Zend_Locale の使用法
正規化および地域化
日付および時刻の扱い
サポートするロケール
Zend_Log
概要
ライター
フォーマッタ
フィルタ
Using the Factory to Create a Log
Zend_Mail
導入
SMTP 経由での送信
SMTP 接続による複数のメールの送信
異なる転送手段の使用
HTML メール
ファイルの添付
受信者の追加
MIME バウンダリの制御
追加のヘッダ
文字セット
エンコーディング
SMTP 認証
セキュアな SMTP トランスポート
メールメッセージの読み込み
Zend_Markup
導入
さあ始めましょう
Zend_Markup パーサー
Zend_Markup レンダラー
Zend_Measure
導入
計測値の作成
計測値の出力
計測値の操作
計測値の型
Zend_Memory
概要
メモリマネージャ
メモリオブジェクト
Zend_Mime
Zend_Mime(日本語)
Zend_Mime_Message(日本語)
Zend_Mime_Part(日本語)
Zend_Navigation
導入
画面
Containers
Zend_Oauth
Introduction to OAuth
Zend_OpenId
導入
Zend_OpenId_Consumer の基本
Zend_OpenId_Provider(日本語)
Zend_Paginator
導入
使用法
設定
高度な使用法
Zend_Pdf
導入
PDF ドキュメントの作成および読み込み
PDF ドキュメントへの変更内容の保存
ページの操作
描画
Interactive Features
ドキュメントの情報およびメタデータ
Zend_Pdf モジュールの使用例
Zend_ProgressBar
Zend_ProgressBar(日本語)
Zend_Queue
導入
使用例
フレームワーク
アダプタ
Zend_Queueのカスタマイズ
Stomp(日本語)
Zend_Reflection
導入
Zend_Reflectionサンプル
Zend_Reflectionリファレンス
Zend_Registry
レジストリの使用法
Zend_Rest
導入
Zend_Rest_Client(日本語)
Zend_Rest_Server(日本語)
Zend_Search_Lucene
概要
インデックスの構築
インデックスの検索
クエリ言語
クエリ作成用の API
文字セット
拡張性
Java Lucene との相互運用
応用
ベストプラクティス
Zend_Serializer
導入
Zend_Serializer_Adapter
Zend_Server
導入
Zend_Server_Reflection(日本語)
Zend_Service
導入
Zend_Service_Akismet(日本語)
Zend_Service_Amazon(日本語)
Zend_Service_Amazon_Ec2(日本語)
Zend_Service_Amazon_Ec2: Instances
Zend_Service_Amazon_Ec2: Windows Instances
Zend_Service_Amazon_Ec2: Reserved Instances
Zend_Service_Amazon_Ec2: CloudWatch Monitoring
Zend_Service_Amazon_Ec2: Amazon Machine Images (AMI)
Zend_Service_Amazon_Ec2: Elastic Block Storage (EBS)
Zend_Service_Amazon_Ec2: Elastic IP Addresses
Zend_Service_Amazon_Ec2: Keypairs(日本語)
Zend_Service_Amazon_Ec2:リージョンおよび利用可能ゾーン
Zend_Service_Amazon_Ec2: Security Groups
Zend_Service_Amazon_S3
Zend_Service_Amazon_Sqs
Zend_Service_Audioscrobbler(日本語)
Zend_Service_Delicious(日本語)
Zend_Service_DeveloperGarden
Zend_Service_Ebay
Zend_Service_Ebay_Finding
Zend_Service_Flickr(日本語)
Zend_Service_LiveDocx
Zend_Service_Nirvanix(日本語)
Zend_Service_ReCaptcha(日本語)
Zend_Service_ShortUrl
Zend_Service_Simpy(日本語)
Zend_Service_SlideShare(日本語)
Zend_Service_StrikeIron(日本語)
Zend_Service_StrikeIron: バンドルされているサービス
Zend_Service_StrikeIron: 応用編
Zend_Service_Technorati(日本語)
Zend_Service_Twitter
Zend_Service_WindowsAzure
Zend_Service_WindowsAzure_Storage_Blob
Zend_Service_WindowsAzure_Diagnostics_Manager
Zend_Service_WindowsAzure_Storage_Queue
Zend_Service_WindowsAzure_Storage_Table
Zend_Service_Yahoo(日本語)
Zend_Session
導入
基本的な使用法
高度な使用法
グローバルセッションの管理
Zend_Session_SaveHandler_DbTable(日本語)
Zend_Soap
Zend_Soap_Server(日本語)
Zend_Soap_Client(日本語)
WSDLアクセッサ
自動検出
Zend_Tag
導入
Zend_Tag_Cloud
Zend_Test
導入
Zend_Test_PHPUnit(日本語)
Zend_Test_PHPUnit_Db(日本語)
Zend_Text
Zend_Text_Figlet(日本語)
Zend_Text_Table(日本語)
Zend_TimeSync
導入
Zend_TimeSync の動作
Zend_Tool
Using Zend_Tool On The Command Line
Extending Zend_Tool
Zend_Tool_Framework
導入
CLIツールの使用
アーキテクチャ
Zend_Tool_Frameworkを利用してプロバイダを作成する
出荷されたシステムプロバイダー
Extending and Configuring Zend_Tool_Framework
Zend_Tool_Project
導入
プロジェクトを作成
Zend_Tool Project Providers
Zend_Tool_Project Internals
Zend_Translate
導入
Zend_Translate のアダプタ
翻訳アダプタの使用法
ソースファイルの作成
翻訳用の追加機能
Plural notations for Translation
Zend_Uri
Zend_Uri(日本語)
Zend_Validate
導入
標準のバリデーションクラス群
バリデータチェイン
バリデータの書き方
検証メッセージ(一部日本語)
Zend_Version
Zend Framework のバージョンの取得
Zend_View
導入
コントローラスクリプト
ビュースクリプト
ビューヘルパー
Zend_View_Abstract(日本語)
Zend_Wildfire
Zend_Wildfire(日本語)
Zend_XmlRpc
導入
Zend_XmlRpc_Client
Zend_XmlRpc_Server(日本語)
ZendX_Console_Process_Unix
ZendX_Console_Process_Unix
ZendX_JQuery
Introduction
ZendX_JQuery View Helpers
ZendX_JQuery Form Elements and Decorators
Zend Framework のシステム要件
導入
Zend Framework 移行上の注意
Zend Framework 1.10(一部日本語)
Zend Framework 1.9(一部日本語)
Zend Framework 1.8(日本語)
Zend Framework 1.7(日本語)
Zend Framework 1.6(日本語)
Zend Framework 1.5(日本語)
Zend Framework 1.0(日本語)
Zend Framework 0.9(日本語)
Zend Framework 0.8(日本語)
Zend Framework 0.6(日本語)
Zend Framework PHP 標準コーディング規約
概要
PHP ファイルの書式
命名規約
コーディングスタイル
Zend Framework ドキュメント標準(一部日本語)
概要
ドキュメントファイル形式
推奨事項
Zend Framework MVC アプリケーションのために推奨されるプロジェクト構造
概要
推奨されるプロジェクト・ディレクトリ構造
モジュール構造
リライト設定ガイド
Zend Framework パフォーマンスガイド
導入
クラスの読み込み
Zend_Dbパフォーマンス
国際化(i18n)とローカライズ(l10n)
ビューのレンダリング
著作権に関する情報