summaryrefslogtreecommitdiffstats
path: root/vendor/ipl/web/src/Control/LimitControl.php
blob: 376d6beff965e4e169fb92e35db3521ebaa60e3a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<?php

namespace ipl\Web\Control;

use ipl\Web\Compat\CompatForm;
use ipl\Web\Url;

/**
 * Allows to adjust the limit of the number of items to display
 */
class LimitControl extends CompatForm
{
    /** @var int Default limit */
    const DEFAULT_LIMIT = 25;

    /** @var string Default limit param */
    const DEFAULT_LIMIT_PARAM = 'limit';

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

    /** @var string Name of the URL parameter which stores the limit */
    protected $limitParam = self::DEFAULT_LIMIT_PARAM;

    /** @var int */
    protected $defaultLimit;

    /** @var Url */
    protected $url;

    protected $method = 'GET';

    public function __construct(Url $url)
    {
        $this->url = $url;
    }

    /**
     * Get the name of the URL parameter which stores the limit
     *
     * @return string
     */
    public function getLimitParam()
    {
        return $this->limitParam;
    }

    /**
     * Set the name of the URL parameter which stores the limit
     *
     * @param string $limitParam
     *
     * @return $this
     */
    public function setLimitParam($limitParam)
    {
        $this->limitParam = $limitParam;

        return $this;
    }

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

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

        return $this;
    }

    /**
     * Get the limit
     *
     * @return int
     */
    public function getLimit()
    {
        return $this->url->getParam($this->getLimitParam(), $this->getDefaultLimit());
    }

    protected function assemble()
    {
        $this->addAttributes(['class' => 'limit-control inline']);

        $limits = static::$limits;
        if ($this->defaultLimit && ! isset($limits[$this->defaultLimit])) {
            $limits[$this->defaultLimit] = $this->defaultLimit;
        }

        $limit = $this->getLimit();
        if (! isset($limits[$limit])) {
            $limits[$limit] = $limit;
        }

        $this->addElement('select', $this->getLimitParam(), [
            'class'   => 'autosubmit',
            'label'   => '#',
            'options' => $limits,
            'title'   => t('Change item count per page'),
            'value'   => $limit
        ]);

        if ($this->url->hasParam(PaginationControl::DEFAULT_PAGE_PARAM)) {
            $this->addElement('hidden', PaginationControl::DEFAULT_PAGE_PARAM, [
                'value' => 1
            ]);
        }
    }
}