Pager::Pager

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

Synopsis

require_once 'Pager.php';

object &Pager ( array $options )

非推奨

コンストラクタは非推奨となっており、 PHP5との互換性のためにも、 新しいfactory()メソッドを使用してください。

Parameter

Pager コンストラクタは、 引数としてパラメータの連想配列を1つ受け取ります。 以下は、これらオプションの完全なリストです:

  • itemData [array]

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

  • totalItems [integer]

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

  • perPage [integer]

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

  • delta [integer]

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

  • mode [string]

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

  • expanded [boolean]

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

  • linkClass [string]

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

  • urlVar [string]

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

  • path [string]

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

  • fileName [string]

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

  • append [boolean]

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

  • altPrev [string]

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

  • altNext [string]

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

  • altPage [string]

    ページ番号の前に表示されるalt文を指定します。 デフォルトは、"page "。

  • prevImg [string]

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

  • nextImg [string]

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

  • separator [string]

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

  • spacesBeforeSeparator [integer]

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

  • spacesAfterSeparator [integer]

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

  • firstPagePre [string]

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

  • firstPageText [string]

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

  • firstPagePost [string]

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

  • lastPagePre [string]

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

  • lastPageText [string]

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

  • lastPagePost [string]

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

  • curPageLinkClassName [string]

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

  • clearIfVoid [boolean]

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

  • useSessions [boolean]

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

  • closeSession [boolean]

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

  • sessionVar [string]

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

  • pearErrorMode [constant]

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

必要なオプション:

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

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

Return value

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

ページ数を返す (Previous) Pager_Sliding (Next)
Last updated: Tue, 02 Sep 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:

There are no user contributed notes for this page.