icingaweb2/library/Icinga/Web/Widget/Limiter.php

<?php
/* Icinga Web 2 | (c) 2013-2015 Icinga Development Team | GPLv2+ */

namespace Icinga\Web\Widget;

use Icinga\Web\Navigation\Navigation;
use Icinga\Web\Navigation\NavigationItem;
use Icinga\Web\Navigation\NavigationRenderer;
use Icinga\Web\Url;

/**
 * Limiter control
 */
class Limiter extends AbstractWidget
{
    /**
     * CSS class for the limiter widget
     *
     * @var string
     */
    const CSS_CLASS_LIMITER = 'limiter-control';

    /**
     * Default limit
     *
     * @var int
     */
    const DEFAULT_LIMIT = 50;

    /**
     * Selectable limits
     *
     * @var int[]
     */
    public static $limits = array(
        10  => '10',
        25  => '25',
        50  => '50',
        100 => '100',
        500 => '500'
    );

    /**
     * Default limit for this instance
     *
     * @var int|null
     */
    protected $defaultLimit;

    /**
     * Get the default limit
     *
     * @return int
     */
    public function getDefaultLimit()
    {
        return $this->defaultLimit !== null ? $this->defaultLimit : static::DEFAULT_LIMIT;
    }

    /**
     * Set the default limit
     *
     * @param   int $defaultLimit
     *
     * @return  $this
     */
    public function setDefaultLimit($defaultLimit)
    {
        $this->defaultLimit = (int) $defaultLimit;
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function render()
    {
        $url = Url::fromRequest();
        $activeLimit = (int) $url->getParam('limit', $this->getDefaultLimit());
        $navigation = new Navigation();
        $navigation->setLayout(Navigation::LAYOUT_TABS);
        foreach (static::$limits as $limit => $label) {
            $navigationItem = new NavigationItem($limit);
            $navigationItem
                ->setActive($activeLimit === $limit)
                ->setAttribute(
                    'title',
                    sprintf(
                        t('Show %u rows on this page'),
                        $limit
                    )
                )
                ->setLabel($label)
                ->setUrl($url->with(array('limit' => $limit)));
            $navigation->addItem($navigationItem);
        }
        if ($activeLimit === 0) {
            $navigationItem = new NavigationItem(0);
            $navigationItem
                ->setActive(true)
                ->setAttribute('title', t('Show all items on this page'))
                ->setLabel(t('all'));
            $navigation->addItem($navigationItem);
        }
        $navigationRenderer = new NavigationRenderer($navigation);
        $navigationRenderer
            ->setCssClass(static::CSS_CLASS_LIMITER)
            ->setHeading(t('Limiter'));
        return $navigationRenderer->render();
    }
}