Pager::getPerPageSelectBox

Pager::getPerPageSelectBox() – ページごとにいくつずつ表示するかを選択するための XHTML の SELECT メニューの文字列を返す

Synopsis

require_once 'Pager.php';

array Pager::getPerPageSelectBox ( integer $start = 5 , integer $end = 30 , integer $step = 5 , boolean $showAllData = false , string $optionText = '%d' )

Parameter

  • 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 オプションを表示しない。

Description

XHTMLのSELECTメニューの文字列を返します。これは、 ユーザーにページごとにいくつずつ表示するかを選択させのに役に立ちます。 もし、useSessionsTRUEの場合、 この値はセッション変数にストアされます。文字列は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 value

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

前のページ番号を返す (Previous) 現在のページが最初のページかどうかを返す (Next)
Last updated: Wed, 20 Aug 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.