Pager::factory

Pager::factory() – ページャのインスタンスを生成する

Synopsis

require_once 'Pager.php';

object &factory ( array $options )

Parameter

Pager::factory()メソッドは、 入力値としてパラメータの連想配列を受け取ります。 これは、これらオプションの完全なリストです。

  • itemData [array]

    ページ付けするアイテムの配列を指定します。

  • totalItems [integer]

    ページ付けするアイテムの数を指定します (itemDataが指定されなかった場合のみ使用されます)。

  • perPage [integer]

    ページごとに表示するアイテムの数を指定します。

  • delta [integer]

    現在のページの前後に表示するページ番号の数を指定します。

  • mode [string]

    "ジャンプ型" あるいは "スライド型" ウィンドウを指定します。 ページャーの動作を決定します。

  • httpMethod [string]

    使用する HTTP メソッドを指定します。 有効な値は 'GET' または 'POST' です。

  • formID [string]

    POST モードで、どの HTML フォームを使用するかを指定します。

  • importQuery [boolean]

    もし true (デフォルトの振る舞い) ならば、 変数と値はサブミットされたデータ (クエリ文字列) からインポートされ、リンクの生成に使用されます。 または、全く無視されます。

  • currentPage [integer]

    初期ページ番号を指定します (もし、デフォルトで2ページ目を表示したい場合、 currentPage に2を指定します)

  • expanded [boolean]

    もしTRUEなら、ウィンドウサイズは常に 2*delta+1 となります。

  • linkClass [string]

    リンクスタイルのためのCSSクラス名を指定します。

  • urlVar [string]

    ページ番号を示すためのURL変数名を指定します。デフォルトは "pageID"。

  • path [string]

    ページへの絶対パス(ページ名は除く)を指定します。

  • fileName [string]

    ページの名前。もし、appendTRUEなら、 "%d" が使用されます。

  • fixFileName [boolean]

    もし FALSE なら、オプション fileName は上書きされません。自己責任で使用してください。

  • append [boolean]

    もしTRUEなら、pageIDはGET値としてURLに追加されます。 もしFALSEなら、fileNameに従って、 URLに埋め込まれます。

  • altFirst [string]

    最初のページへのリンクに表示される alt 文を指定します。 デフォルト値は、"first page"。 もしページ番号の文字列としたい場合は、プレースホルダとして "%d" を使用してください ("page %d" のインスタンス)。

  • altPrev [string]

    前ページへのリンクに表示されるalt文を指定します。 デフォルト値は、"previous page"。

  • altNext [string]

    次ページへのリンクに表示されるalt文を指定します。 デフォルト値は、"next page"。

  • altLast [string]

    最後のページへのリンクに表示される alt 文を指定します。 デフォルト値は、"last page"。 もしページ番号の文字列としたい場合は、プレースホルダとして "%d" を使用してください ("page %d" のインスタンス)。

  • altPage [string]

    ページ番号の前に表示されるalt文を指定します。 デフォルトは、"page " (この後にページ番号が続く) です。 オプションで、プレースホルダとして "%d" を使用する (たとえば "page n. %d") ことができます。これにより、ページ番号の位置を指定します。

  • prevImg [string]

    "<<"の代わりに表示する文字を指定します。 "<< PREV"や <img/>などが使えます。

  • nextImg [string]

    ">>"の代わりに表示する文字を指定します。 "NEXT >>"や <img/>などが使えます。

  • separator [string]

    ページ番号を分けるために使われる文字を指定します。 <img/>やコンマ、ハイフンなどが使えます。

  • spacesBeforeSeparator [integer]

    セパレータの前のスペースの数を指定します。

  • spacesAfterSeparator [integer]

    セパレータの後のスペースの数を指定します。

  • firstLinkTitle [string]

    <link rel="first"> タグのタイトルとして使用する文字列を指定します。

  • nextLinkTitle [string]

    <link rel="next"> タグのタイトルとして使用する文字列を指定します。

  • prevLinkTitle [string]

    <link rel="previous"> タグのタイトルとして使用する文字列を指定します。

  • lastLinkTitle [string]

    <link rel="last"> タグのタイトルとして使用する文字列を指定します。

  • curPageLinkClassName [string]

    現在のページのリンクに使う CSS クラス名を指定します。

  • curPageSpanPre [string]

    現在のページのリンクの前のテキストを指定します。

  • curPageSpanPost [string]

    現在のページのリンクの後のテキストを指定します。

  • firstPagePre [string]

    最初のページ番号の前の文字を指定します。 <img/>や"{"、空文字などが使えます。

  • firstPageText [string]

    最初のページ番号の文字を指定します。

  • firstPagePost [string]

    最初のページ番号の後の文字を指定します。 <img/>や"{"、空文字などが使えます。

  • lastPagePre [string]

    firstPagePreと同様です。 ただし、最後のページ番号に対して使用されます。

  • lastPageText [string]

    firstPageTextと同様です。 ただし、最後のページ番号に対して使用されます。

  • lastPagePost [string]

    firstPagePostと同様です。 ただし、最後のページ番号に対して使用されます。

  • clearIfVoid [boolean]

    1ページしかない場合、ページャリンクを表示しない (空文字が返ります)かどうかを指定します。

  • useSessions [boolean]

    もしTRUEなら、ページごとに表示するアイテム数は、 $_SESSION[$_sessionVar] 変数にストアされます。

  • closeSession [boolean]

    もしTRUEなら、セッションはR/Wされた後にクローズされます。

  • sessionVar [string]

    perPageの値を格納するセッション変数名を指定します。 一つのページで複数のPagerインスタンスを使用する場合、 デフォルトと異なる値を指定します。

  • showAllText [string]

    generated by getPerPageSelectBox() getPerPageSelectBox() で生成されたセレクトボックスでの 'show all'オプションのために使用されるテキスト

  • pearErrorMode [constant]

    raiseError()でPEAR_ERRORモードを使用するかどうかを指定します。 デフォルトは、PEAR_ERROR_RETURN。

必要なオプション:

  • fileNameappend==FALSE (デフォルトは、TRUE)の場合

  • itemDataあるいは totalItems (もし、itemDataがセットされている場合、totalItemsは上書きされます)

Return value

object - 固有のPager インスタンス あるいは、失敗した場合はPEAR_Error オブジェクトを返します。

2つのページャスタイルの特長を比較する (Previous) Pager オブジェクトを作成した後でオプションを設定あるいは変更する (Next)
Last updated: Fri, 24 Oct 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

Note by: cweiske
There are several undocumented attributes, including "attributes" and "onclick". See Pager/Common.php for an exhaustive list.
Note by: kouber
If you need to change the default URL of page links, i.e. $_SERVER['PHP_SELF'], you have to pass the following two parameters in addition to the pager options:

array(
'fixFileName' => false,
'fileName' => '/my/cool/url'
)