FuelPHP Paginationクラス

Paginationの設定

Paginationインスタンスは次の方法でパラメータを設定することができる。

Paginationの設定項目を次表に示す。

Paginationの設定項目
パラメータ説明
current_page ページ番号
num_links 表示するリンクの総数
pagination_url Paginationを持つページのURL
per_page 1ページ当たりの項目数
show_first 最初のページではない場合に「最初のページへ」のリンクを生成するかどうかを指定する。
show_last 最後のページではない場合に「最後のページへ」のリンクを生成するかどうかを指定する。
total_items 全項目数
uri_segment ページ番号をURIに埋め込む方法を指定する。

ページ番号をURIセグメントに埋め込む場合、セグメント番号を整数(integer)で指定する。たとえば、http://localhost/foo/public/bar/indexというURIの場合、uri_segmentに3を指定すると、2ページ目のURIはhttp://localhost/foo/public/bar/index/2となる。uri_segmentに2を指定すると、2ページ目のURIはhttp://localhost/foo/public/bar/2となる。uri_segmentに1を指定すると、2ページ目のURIはhttp://localhost/foo/public/2/indexとなる。

ページ番号をGETパラメータに埋め込む場合、パラメータ名を文字列(string)で指定する。たとえば、http://localhost/foo/public/bar/indexというURIの場合、uri_segmentに'p'を指定すると、2ページ目のURIはhttp://localhost/foo/public/bar/index?p=2となる。

Paginationのテンプレート

Paginationクラスは、HTMLを作成するためにテンプレートを用いる。テンプレートはAPPPATH/config/pagination.phpに作成する。

項目説明
active 「現在のページ」のマークアップ
active-link 「現在のページ」のリンクのマークアップ
first 「最初のページ」のマークアップ
first-inactive 総ページ数が1ページの場合又は現在のページが1ページ目の場合における「最初のページ」のマークアップ
first-inactive-link 総ページ数が1ページの場合又は現在のページが1ページ目の場合における「最初のページ」のリンクのマークアップ
last 「最後のページ」のマークアップ
last-inactive 総ページ数が1ページの場合又は現在のページが最後のページの場合における「最後のページ」のマークアップ
last-inactive-link 総ページ数が1ページの場合又は現在のページが最後のページの場合における「最後のページ」のリンクのマークアップ
last-link 「最後のページ」のリンクのマークアップ
last-marker 「最後のページ」のマーカのマークアップ
next 「次のページ」のマークアップ
next-inactive 総ページ数が1ページの場合又は現在のページが最後のページの場合における「次のページ」のマークアップ
next-inactive-link 総ページ数が1ページの場合又は現在のページが最後のページの場合における「次のページ」のリンクのマークアップ
next-link 「次のページ」のリンクのマークアップ
next-marker 「次のページ」のマーカのマークアップ
previous 「前のページ」のマークアップ
previous-inactive 総ページ数が1ページの場合又は現在のページが1ページ目の場合における「前のページ」のマークアップ
previous-inactive-link 総ページ数が1ページの場合又は現在のページが1ページ目の場合における「前のページ」のリンクのマークアップ
previous-link 「前のページ」のリンクのマークアップ
previous-marker 「前のページ」のマーカのマークアップ
regular 「その他ページ」のマークアップ
regular-link 「その他ページ」のリンクのマークアップ
wrapper 生成されたページネーションを囲むマークアップ

Paginationクラスの静的メソッド

Paginationクラスの静的メソッド
メソッド説明
forge Paginationインスタンスを生成する。
get 設定項目を返す。
instance あらかじめforgeされたPagenationインスタンスを返す。
set defaultインスタンスの設定項目を変更する。

Paginationクラスのメソッド

Paginationクラスのメソッド
メソッド説明
first ページネーションで「最初のページ」のリンクを表示するマークアップを返す。
last ページネーションで「最後のページ」のリンクを表示するマークアップを返す。
next ページネーションで「次のページ」のリンクを表示するマークアップを返す。
pages-render ページネーションで「前のページ」と「次のページ」のリンクの間にある「ページ」のリンクを表示するマークアップを返す。
previous ページネーションで「前のページ」のリンクを表示するマークアップを返す。
render ページネーションのリンクのマークアップを返す。

forge

Paginationインスタンスを生成して返す。

forge($name = 'default', $config = array())
$name
作成するインスタンスの名前を指定する。
$config
設定項目を配列で指定する。

getメソッド

デフォルトインスタンスの設定項目を取得して返す。

get($name)
$name
取得するプロパティの名前