【CakePHP】Pagination(ページネーション)を使用する：numbers

2014年5月20日2019年7月29日

バージョン：CakePHP 2.x

Pagination(ページネーション)を使用して「 1 | 2 | 3 | 4 」といったリンクを作成する場合は、
numbersを使えば簡単に実現することができます。

基本的な使い方

基本的な使い方は下記の通りです。下記をViewに書けばリンクが表示されます。

echo $this->Paginator->numbers();

パラメーターとオプションについて

numbersの構文は下記となります。

PaginatorHelper::numbers($options = array())

オプション名	説明
before	ページ番号の前に挿入する文字
after	ページ番号の後に挿入する文字
model	ページ番号を作成するためのモデル（デフォルト：PaginatorHelper::defaultModel()）
modulus	ページ番号のリンクをいくつ作成するか（デフォルト：8）
separator	ページ番号の間に表示する文字（デフォルト： ｜　）
first	ページ数が多い場合（省略された場合）に最初のページだけ出すかどうか。数字をしてすると、その数字分のリンクが作られる。文字列を指定した場合は、その文字列のリンクとなる（デフォルト：false）
last	ページ数が多い場合（省略された場合）に最後のページだけ出すかどうか。（firstと同じ）
ellipsis	省略される場合に出力する文字列（デフォルト：‘…’）
tag	リンクを囲むのに使用したいタグ（デフォルト：）
class	tag（タグ）のクラスを指定
currentTag	表示中のページ番号のタグを指定 （デフォルト：null）
currentClass	表示中のページ番号のクラスを指定（デフォルト：current）

オプションを指定した例

echo $this->Paginator->numbers(array(
		'before'=>'~',
		'after'=>'~',
		'modulus'=>2,
		'separator'=>'|',
		'first'=>3,
		'last'=>3,
		'ellipsis' => '...'
));

下記のような表示となります。

参考：公式サイト（Paginator）