Pager::getPerPageSelectBox()

パラメータ

• integer $start - ページごとのアイテム数の最小値 (オプション)

• integer $end - ページごとのアイテム数の最大値 (オプション)

• integer $step - 2つのオプションの増値 (オプション)

• boolean $showAllData - もしtrueなら、 perPageはtotalItemsと同値になる (オプション)

• array $extraParams (オプション)

  • 'optionText': それぞれのオプションに表示するテキスト。 選択されたページ数を表示したい場所に、'%d'を指定する。

  • 'attributes': (html attributes) タグの属性、あるいは HTML の属性 (id="foo" といった組み合わせ) で、<select> タグに挿入される。

  • 'checkMaxLimit': もしtrueなら、Pager は $end が $totalItems より大きいかどうかを調べ、余計な select オプションを表示しない。

説明

XHTMLのSELECTメニューの文字列を返します。これは、 ユーザーにページごとにいくつずつ表示するかを選択させのに役に立ちます。 もし、useSessionsがTRUEの場合、 この値はセッション変数にストアされます。文字列はechoされませんので、 テンプレートエンジンで利用することができます。

例

この例は、ユーザーにそれぞれのページで表示するアイテムの数を選択させる セレクトボックスをどの様に生成するかを示しています。

<?php
include 'Pager/Pager.php';

$params = array(
    'mode'       => 'Jumping',
    'perPage'    => 3,
    'delta'      => 2,
    'itemData'   => array('a','b','c','d','e',[...omissis...],'z')
);
$pager = & Pager::factory($params);

$selectBox = $pager->getPerPageSelectBox();

echo '<form action="' . htmlspecialchars($_SERVER['PHP_SELF']) . '" method="GET">';
echo $selectBox;
echo '<input type="submit" value="submit" />';
echo '</form>';
?>

返り値

return XHTMLのセレクトメニューの文字列を返します。