PEAR Manual
Prev |  | Next

# Pager::getperpageselectbox()

Pager::getperpageselectbox() -- Returns a string with a XHTML SELECT menu, to choose how many items per page should be displayed.

## Synopsis

    require_once 'Pager/Pager.php';

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

## Parameter

- `integer $start` - Min. number of items per page (optional)

- `integer $end` - Max. number of items per page (optional)

- `integer $step` - Increment between two options (optional)

- `boolean $showAllData` - If true, perPage is set equal to totalItems (optional)

- `string $optionText` - text to show in each option. (optional) Use '%d' where you want to see the number of pages selected.

## Description

Returns a string with a XHTML SELECT menu, useful for letting the user choose how many items per page should be displayed. If parameter `useSessions` is `TRUE`, this value is stored in a session var. The string isn't echoed right away so you can use it with template engines.

## Example

This example shows how you can create a select box to let your users choose the number of items to display on each page.

    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 string with the XHTML SELECT menu.

Prev | Home | Next
Pager::getPreviousPageID() | Up | Pager::isFirstPage()