HOME > ライブラリ > PHPライブラリ PEAR > パッケージ > PEAR::pager

PEAR::pager

Peagerとは？

動作サンプル

Pagerドキュメント

メソッド

Pager::factory($option:Array): Pagerのインスタンスを作成。
Pager::setOptions($option:Array): Set or change option after the Pager object has been constructed
Pager::build(): Generate or refresh the links and paged data after a call to setOptions()
Pager::getCurrentPageID(): Returns current page number
Pager::getLinks(): Returns back/next/first/last and page links, both as ordered and associative array.
Pager::getNextPageID(): Returns next page number.
Pager::getOffsetByPageId(): Returns offsets for given pageID.
Pager::getPageData(): Returns an array of current pages data
Pager::getPageIdByOffset(): Returns the page number for the given offset
Pager::getPageRangeByPageId(): Returns offsets for given pageID.
Pager::getPreviousPageID(): Returns previous page number.
Pager::getPerPageSelectBox(): Returns a string with a XHTML SELECT menu, to choose how many items per page should be displayed.
Pager::isFirstPage(): Returns whether current page is first page
Pager::isLastPage(): Returns whether current page is last page
Pager::isLastPageComplete(): Returns whether last page is complete
Pager::numItems(): Returns number of items
Pager::numPages(): Returns number of pages
Pager::Pager(): Creates a pager instance

設定可能オプション

Pager::factory($option:Array)、Pager::setOptions($option:Array)の引数

PHP

<?php
$option = array(
'itemData' => 'ページ付けするアイテムの配列を指定します。:Array',
'totalItems' => 'ページ付けするアイテムの数を指定します（itemDataが指定されなかった場合のみ使用されます）。:Integer',
'perPage' => 'ページごとに表示するアイテムの数を指定します。:Integer',
'delta' => '現在のページの前後に表示するページ番号の数を指定します。:Integer',
'mode' => '"Jumping" or "Sliding"を指定します。ページャーの動作を決定します。:String',
'httpMethod' => '使用する HTTP メソッドを指定します。有効な値は 'GET' または 'POST' です。:String',
'formID' => 'POST モードで、どの HTML フォームを使用するかを指定します。:String',
'importQuery' => 'もし true (デフォルトの振る舞い) ならば、変数と値はサブミットされたデータ (クエリ文字列) からインポートされ、リンクの生成に使用されます。または、全く無視されます。:Boolean',
'currentPage' => '初期ページ番号を指定します (もし、デフォルトで2ページ目を表示したい場合、currentPage に2を指定します):Integer',
'expanded' => 'もしTRUEなら、ウィンドウサイズは常に 2*delta+1 となります。:boolean',
'linkClass' => 'リンクスタイルのためのCSSクラス名を指定します。:string',
'urlVar' => 'ページ番号を示すためのURL変数名を指定します。デフォルトは "pageID"。:string',
'path' => 'ページへの絶対パス（ページ名は除く）を指定します。:string',
'fileName' => 'ページの名前。もし、appendがTRUEなら、 "%d" が使用されます。:string',
'fixFileName' => 'もし FALSE なら、オプション fileName は上書きされません。自己責任で使用してください。:boolean',
'append' => 'もしTRUEなら、pageIDはGET値としてURLに追加されます。もしFALSEなら、fileNameに従って、 URLに埋め込まれます。:boolean',
'altFirst' => '最初のページへのリンクに表示される alt 文を指定します。デフォルト値は、"first page"。もしページ番号の文字列としたい場合は、プレースホルダとして "%d" を使用してください ("page %d" のインスタンス)。:string',
'altPrev' => '前ページへのリンクに表示されるalt文を指定します。デフォルト値は、"previous page"。:string',
'altNext' => '次ページへのリンクに表示されるalt文を指定します。デフォルト値は、"next page"。:string',
'altLast' => '最後のページへのリンクに表示される alt 文を指定します。デフォルト値は、"last page"。もしページ番号の文字列としたい場合は、プレースホルダとして "%d" を使用してください ("page %d" のインスタンス)。:string',
'altPage' => 'ページ番号の前に表示されるalt文を指定します。デフォルトは、"page " (この後にページ番号が続く) です。オプションで、プレースホルダとして "%d" を使用する (たとえば "page n. %d") ことができます。これにより、ページ番号の位置を指定します。:string',
'prevImg' => '"<<"の代わりに表示する文字を指定します。 "<< PREV"や <img/>などが使えます。:string',
'nextImg' => '">>"の代わりに表示する文字を指定します。 "NEXT >>"や <img/>などが使えます。:string',
'separator' => 'ページ番号を分けるために使われる文字を指定します。 <img/>やコンマ、ハイフンなどが使えます。:string',
'spacesBeforeSeparator' => 'セパレータの前のスペースの数を指定します。:integer',
'spacesAfterSeparator' => 'セパレータの後のスペースの数を指定します。:integer',
'curPageLinkClassName' => '現在のページのリンクに使う CSS クラス名を指定します。:string',
'curPageSpanPre' => '現在のページのリンクの前のテキストを指定します。:string',
'curPageSpanPost' => '現在のページのリンクの後のテキストを指定します。:string',
'firstPagePre' => '最初のページ番号の前の文字を指定します。 <img/>や"{"、空文字などが使えます。:string',
'firstPageText' => '最初のページ番号の文字を指定します。:string',
'firstPagePost' => '最初のページ番号の後の文字を指定します。 <img/>や"{"、空文字などが使えます。:string',
'lastPagePre' => 'firstPagePreと同様です。ただし、最後のページ番号に対して使用されます。:string',
'lastPageText' => 'firstPageTextと同様です。ただし、最後のページ番号に対して使用されます。 :string',
'lastPagePost' => 'firstPagePostと同様です。ただし、最後のページ番号に対して使用されます。:string',
'clearIfVoid' => '1ページしかない場合、ページャリンクを表示しない（空文字が返ります）かどうかを指定します。:boolean',
'extraVars' => 'additional URL vars to be added to the querystring.:array',
'excludeVars' => 'URL vars to be excluded from the querystring. :array',
'useSessions' => 'もしTRUEなら、ページごとに表示するアイテム数は、 $_SESSION[$_sessionVar] 変数にストアされます。:boolean',
'closeSession' => 'もしTRUEなら、セッションはR/Wされた後にクローズされます。:boolean',
'sessionVar' => 'perPageの値を格納するセッション変数名を指定します。一つのページで複数のPagerインスタンスを使用する場合、デフォルトと異なる値を指定します。:string',
'showAllText' => 'generated by getPerPageSelectBox() getPerPageSelectBox() で生成されたセレクトボックスでの 'show all'オプションのために使用されるテキスト :string',
'pearErrorMode' => 'raiseError()でPEAR_ERRORモードを使用するかどうかを指定します。デフォルトは、PEAR_ERROR_RETURN。:constant',
)
;?>