Прочитать параметры навигации из адреса PageNavigation::initFromUri
Модуль: main — подключать отдельно не нужно
Метод PageNavigation::initFromUri читает номер и размер страницы из адреса текущего запроса. Вызывайте метод после настройки объекта. Методы setPageSizes и allowAllRecords влияют на разбор адреса.
Сигнатура метода в классе Bitrix\Main\UI\PageNavigation:
public function initFromUri()
Возвращаемое значение
Метод ничего не возвращает.
Особенности
Метод ищет параметр запроса с именем идентификатора, например ?nav-units=page-3-size-20. Если параметра нет, поиск идет по сегментам пути, например /nav-units/page-3/size-20/.
Значения из адреса применяются с ограничениями:
- размер страницы — только если он есть в списке setPageSizes, иначе остается прежний размер,
- значение
page-all— только если allowAllRecords разрешил показ всех записей, - номер страницы меньше 1 игнорируется.
Если число записей уже задано через setRecordCount, номер страницы не превышает число страниц. При числе записей 0 номер становится 0, а getOffset возвращает отрицательное смещение. Чтобы этого избежать, задавайте число записей после initFromUri или проверяйте, что оно больше нуля.
Примеры
Пример. Код имитирует адрес ?nav-units=page-3-size-50 и читает из него параметры:
<?php
use Bitrix\Main\Context;
use Bitrix\Main\UI\PageNavigation;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
// На реальной странице параметр приходит из адреса
Context::getCurrent()->getRequest()->modifyByQueryString('nav-units=page-3-size-50');
$nav = new PageNavigation('nav-units');
$nav->setPageSizes([20, 50, 100]);
$nav->initFromUri();
echo $nav->getCurrentPage() . ' ' . $nav->getPageSize() . ' ' . $nav->getOffset();
Код выведет 3 50 100.