Форум программистов, компьютерный форум, киберфорум
long399
Войти
Регистрация
Восстановить пароль
По возможности буду размещать интересные записи в своем блоге
Рейтинг: 3.00. Голосов: 2.

Расширенный виджет LinkPager в Yii2

Запись от long399 размещена 09.08.2021 в 11:06. Обновил(-а) long399 16.08.2021 в 08:19 (update categories)
Показов 3165 Комментарии 0

Возникла следующая проблема. Имеется один проект на Yii2, в котором на индексной странице выводится очень много записей. Стандартный пейджер, в котором можно задать дополнительно ссылки на первую и последнюю страницы уже не спасает положение.

Написал небольшой виджет, который расширяет стандартный \yii\widgets\LinkPager и предоставляет возможность добавить к пейджеру дополнительные блоки:
  • dropdown list со списком всех возможных переходов;
  • dropdown list со списком количества записей на одной странице;
  • textinput поле для задания страницы, к которой нужно перейти.

Нажмите на изображение для увеличения
Название: widget.png
Просмотров: 888
Размер:	20.4 Кб
ID:	7079

Исходный код:
PHP
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
<?php
namespace app\widgets;
 
use yii\helpers\Html;
use yii\widgets\LinkPager;
use yii\bootstrap\Dropdown;
 
/**
 * Advanced LinkPager widget.
 * Widget includes blocks: [pageButtons], [pageList], [pageSize], [pageJump].
 * You can set the required blocks in [template] property.
 * @author long399 <long399@mail.ru>
 */
class AdvancedLinkPager extends LinkPager
{
    /**
     *  @var string template of widget. 
     *  @example {pageButtons}{pageList}{pageSize}{pageJump}
     */
    public $template = '{pageButtons}{pageJump}';
 
    /** @var array pageSize items list. */
    public $pageSizeItems = [1, 10, 25];
 
    /** @var string pageSize label string. */
    public $pageSizeLabel = 'Size';
 
    /** @var string pageList label string. */
    public $pageListLabel = 'Page';
 
    /** @var string the CSS class for the pageList. */
    public $pageListCssClass = 'form-control';
 
    /** @var string the CSS class for the pageSize. */
    public $pageSizeCssClass = 'form-control';
 
    /**
     * {@inheritDoc}
     * @see \yii\widgets\LinkPager::run()
     */
    public function run()
    {
        if ($this->registerLinkTags) {
            $this->registerLinkTags();
        }
 
        echo Html::beginTag('div', ['class' => 'row']);
            echo Html::beginTag('div', ['class' => 'col-sm-12']);
                echo $this->renderPageContent();
            echo Html::endTag('div');
        echo Html::endTag('div');
    }
 
    /**
     * Render content according to the template.
     * @return mixed
     */
    protected function renderPageContent()
    {
        return preg_replace_callback('/\\{([\w\-\/]+)\\}/', function ($matches) {
            $name = $matches[1];
            switch ($name) {
                case 'pageJump':    return $this->renderPageJump();
                case 'pageButtons': return $this->renderPageButtons();
                case 'pageSize':    return $this->renderPageSize();
                case 'pageList':    return $this->renderPageList();
                default:            return '';
            }
        }, $this->template);
    }
 
    /**
     * Render pageList block.
     * @return string
     */
    protected function renderPageList()
    {
        $pageCount = $this->pagination->getPageCount();
        if ($pageCount < 2 && $this->hideOnSinglePage) {
            return '';
        }
 
        $html = Html::beginTag('div', ['class' => 'btn-group dropup', 'style' => 'margin-left: 20px; margin-top: -5px;']);
        $html .= Html::button(
            $this->pageListLabel.' '.Html::tag('span', '', ['class' => 'fa fa-caret-down']),
            ['class' => $this->pageListCssClass, 'data-toggle' => 'dropdown', 'aria-expanded' => false]
        );
        $html .= Dropdown::widget([
            'items' => $this->configurePageListItems(),
            'encodeLabels' => false,
            'options' => [
                'style' => 'height: auto; max-height: 200px; overflow-x: hidden;'
            ]
        ]);
        $html .= Html::endTag('div');
        return $html;
    }
 
    /**
     * Render pageSize block.
     * @return string
     */
    protected function renderPageSize()
    {
        $html = Html::beginTag('div', ['class' => 'btn-group dropup', 'style' => 'margin-left: 20px; margin-top: -5px;']);
        $html .= Html::button(
            $this->pageSizeLabel.' '.Html::tag('span', '', ['class' => 'fa fa-caret-down']),
            ['class' => $this->pageSizeCssClass, 'data-toggle' => 'dropdown', 'aria-expanded' => false]
        );
        $html .= Dropdown::widget([
            'items' => $this->configurePageSizeItems(),
            'encodeLabels' => false,
            'options' => [
                'style' => 'height: auto; max-height: 200px; overflow-x: hidden;'
            ]
        ]);
        $html .= Html::endTag('div');
        return $html;
    }
 
    /**
     * Render pageJump block.
     * @return string
     */
    protected function renderPageJump()
    {
        $pageCount = $this->pagination->getPageCount();
        if ($pageCount < 2 && $this->hideOnSinglePage) {
            return '';
        }
 
        $html = Html::beginTag('div', ['class' => 'btn-group', 'style' => 'margin-left: 20px; margin-top: -5px;']);
        $html .= Html::textInput(
            'page',
            '',
            [
                'class' => 'form-control',
                'data-toggle' => 'tooltip',
                'title' => 'Введите номер страницы и нажмите Enter',
                'placeholder' => 'Страница',
                'style' => 'height: 30px; width: 85px;'
            ]
        );
        $html .= Html::endTag('div');
 
        $this->registerJs();
 
        return $html;
    }
 
    /**
     * {@inheritDoc}
     * @see \yii\widgets\LinkPager::renderPageButtons()
     */
    protected function renderPageButtons()
    {
        $html = Html::beginTag('div', ['class' => 'btn-group']);
            $html .= parent::renderPageButtons();
        $html .= Html::endTag('div');
        return $html;
    }
 
    /**
     * Creates a configuration array for pageList Dropdown items.
     * Refer to description for \yii\bootstrap\Dropdown::$items property.
     * @return array
     */
    protected function configurePageListItems()
    {
        $items = [];
        $pageCount = $this->pagination->getPageCount();
        if ($pageCount < 2 && $this->hideOnSinglePage) {
            return $items;
        }
        $currentPage = $this->pagination->getPage();
        // first page
        if ($this->firstPageLabel !== false) {
            $items[] = $this->createPageListItem($this->firstPageLabel, 0, $this->firstPageCssClass, $currentPage <= 0, false);
        }
        // prev page
        if ($this->prevPageLabel !== false) {
            if (($page = $currentPage - 1) < 0) {
                $page = 0;
            }
            $items[] = $this->createPageListItem($this->prevPageLabel, $page, $this->prevPageCssClass, $currentPage <= 0, false);
        }
        // internal pages
        list($beginPage, $endPage) = [0, $this->pagination->getPageCount()-1];
        for ($i = $beginPage; $i <= $endPage; ++$i) {
            $items[] = $this->createPageListItem($i + 1, $i, null, false, $i == $currentPage);
        }
        // next page
        if ($this->nextPageLabel !== false) {
            if (($page = $currentPage + 1) >= $pageCount - 1) {
                $page = $pageCount - 1;
            }
            $items[] = $this->createPageListItem($this->nextPageLabel, $page, $this->nextPageCssClass, $currentPage >= $pageCount - 1, false);
        }
        // last page
        if ($this->lastPageLabel !== false) {
            $items[] = $this->createPageListItem($this->lastPageLabel, $pageCount - 1, $this->lastPageCssClass, $currentPage >= $pageCount - 1, false);
        }
        return $items;
    }
 
    /**
     * Configure pageList item.
     * @param string $label the text label for the button
     * @param integer $page the page number
     * @param string $class the CSS class for the page button.
     * @param boolean $disabled whether this page button is disabled
     * @param boolean $active whether this page button is active
     * @return array
     */
    protected function createPageListItem($label, $page, $class, $disabled, $active)
    {
        $item = ['label' => $label];
        $options = ['class' => $class === '' ? null : $class];
        if ($active) {
            Html::addCssClass($options, $this->activePageCssClass);
        }
        if ($disabled) {
            Html::addCssClass($options, $this->disabledPageCssClass);
            $item['options'] = $options;
            return $item;
        }
        $linkOptions = $this->linkOptions;
        $linkOptions['data-page'] = $page;
        $item['options']     = $options;
        $item['linkOptions'] = $linkOptions;
        $item['url']         = $this->pagination->createUrl($page);
        return $item;
    }
 
    /**
     * Creates a configuration array for pageSize Dropdown items.
     * Refer to description for \yii\bootstrap\Dropdown::$items property.
     * @return array
     */
    protected function configurePageSizeItems(){
        $items = [];
        $currentPageSize = $this->pagination->getPageSize();
        foreach ($this->pageSizeItems as $item) {
            $items[] = $this->createPageSizeItem($item, $item, null, false, $currentPageSize == $item);
        }
        return $items;
    }
 
    /**
     * Configure pageSize item.
     * @param string $label the text label for the button
     * @param integer $page the page number
     * @param string $class the CSS class for the page button.
     * @param boolean $disabled whether this page button is disabled
     * @param boolean $active whether this page button is active
     * @return array
     */
    protected function createPageSizeItem($label, $pageSize, $class, $disabled, $active)
    {
        $item = ['label' => $label];
        $options = ['class' => $class === '' ? null : $class];
        if ($active) {
            Html::addCssClass($options, $this->activePageCssClass);
        }
        if ($disabled) {
            Html::addCssClass($options, $this->disabledPageCssClass);
            $item['options'] = $options;
            return $item;
        }
        $linkOptions = $this->linkOptions;
        $item['options']     = $options;
        $item['linkOptions'] = $linkOptions;
        $item['url']         = $this->pagination->createUrl($this->pagination->getPage(),$pageSize);
        return $item;
    }
 
    /**
     * Register JS-code for pageJump block.
     */
    private function registerJs()
    {
        $url = $this->pagination->createUrl($this->pagination->getPage());
        $jumpToJs = <<<JS
        $('input[name="page"]').on('keydown', function (evt) {
            if (evt.which == 13) {
                var url = "$url";
                var targetPage =  $(this).val();
                var newUrl = url.replace(/([?&]page=)\d{1,}/, "$1"+targetPage);
                window.location.href = newUrl;
            }
        });
JS;
        $this->getView()->registerJs($jumpToJs);
    }
}
Применение:
view:
PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
echo GridView::widget([
    'pager' => [
        'class' => \app\widgets\AdvancedLinkPager::class,
        'options' => ['class' => 'pagination'],
        'firstPageLabel' => 'начало',
        'lastPageLabel' => 'конец',
        'hideOnSinglePage' => false,
 
        'template' => '{pageButtons}{pageList}{pageSize}{pageJump}',
        'pageListLabel' => 'Страница',
        'pageListCssClass' => 'btn btn-warning dropdown-toggle',
        'pageSizeLabel' => 'Размер',
        'pageSizeCssClass' => 'btn btn-primary dropdown-toggle',
        'pageSizeItems' => [1, 10, 25, 50, 100],
    ],
    ...
]);
searchModel:
PHP
1
2
3
4
5
6
7
8
9
10
11
12
public function search($params)
{
    ...
    $pageSize = isset($params['per-page']) ? intval($params['per-page']) : 10;
    $dataProvider = new ActiveDataProvider([
        'query' => $query,
        'pagination' =>  [
            'pageSize' => $pageSize
        ],
    ]);
    ...
}
Ссылка на репозиторий.
Размещено в PHP, Программирование, Yii2
Надоела реклама? Зарегистрируйтесь и она исчезнет полностью.
Всего комментариев 0
Комментарии
 
Новые блоги и статьи
Как подключить JavaScript файл в другом JavaScript файле
InfoMaster 20.01.2025
В современной веб-разработке организация кодовой базы играет ключевую роль в создании масштабируемых и поддерживаемых приложений. Модульность и правильное структурирование кода стали неотъемлемыми. . .
Как откатить изменения в исходниках, не внесенные в Git
InfoMaster 20.01.2025
При работе с системой контроля версий Git разработчики часто сталкиваются с необходимостью отменить внесенные изменения в исходном коде. Особенно актуальной становится ситуация, когда изменения еще. . .
В чем разница между px, in, mm, pt, dip, dp, sp
InfoMaster 20.01.2025
В мире цифрового дизайна и разработки интерфейсов правильный выбор единиц измерения играет ключевую роль в создании качественного пользовательского опыта. История развития систем измерений для. . .
Как изменить адрес удалённого репозитория (origin) в Git
InfoMaster 20.01.2025
В терминологии Git термин origin является стандартным именем для основного удаленного репозитория, с которым взаимодействует локальная копия проекта. Когда разработчик клонирует репозиторий с. . .
Как переместить последние коммиты в новую ветку (branch) в Git
InfoMaster 20.01.2025
При работе над проектом часто возникают ситуации, когда необходимо изолировать определенные изменения от основной линии разработки. Это может быть связано с экспериментальными функциями, исправлением. . .
Как вернуть результат из асинхронной функции в JavaScript
InfoMaster 20.01.2025
Асинхронное программирование представляет собой фундаментальную концепцию в JavaScript, которая позволяет выполнять длительные операции без блокировки основного потока выполнения программы. В. . .
Какой локальный веб-сервер выбрать
InfoMaster 19.01.2025
В современной веб-разработке локальные веб-серверы играют ключевую роль, предоставляя разработчикам надежную среду для создания, тестирования и отладки веб-приложений без необходимости использования. . .
Почему планшеты и iPad уже не так популярны, как раньше
InfoMaster 19.01.2025
Эра революционных инноваций История планшетов началась задолго до того, как эти устройства стали привычными спутниками нашей повседневной жизни. В начале 1990-х годов появились первые прототипы,. . .
Как самому прошить BIOS ноутбука
InfoMaster 19.01.2025
BIOS (Basic Input/ Output System) представляет собой важнейший компонент любого компьютера или ноутбука, который обеспечивает базовое взаимодействие между аппаратным и программным обеспечением. . .
Какой Linux выбрать для домашнего компьютера
InfoMaster 19.01.2025
Современные реалии выбора операционной системы В современном мире выбор операционной системы для домашнего компьютера становится все более важным решением, которое может существенно повлиять на. . .
Как объединить два словаря одним выражением в Python
InfoMaster 19.01.2025
В мире программирования на Python работа со словарями является неотъемлемой частью разработки. Словари представляют собой мощный инструмент для хранения и обработки данных в формате "ключ-значение". . . .
Как без исключения проверить существование файла в Python
InfoMaster 19.01.2025
При разработке программного обеспечения на Python часто возникает необходимость проверить существование файла перед выполнением операций с ним. Это критически важная задача, которая помогает избежать. . .
КиберФорум - форум программистов, компьютерный форум, программирование
Powered by vBulletin
Copyright ©2000 - 2025, CyberForum.ru