PageNavigation — постраничная навигация

Пространство имен: Bitrix\Main\UI

Модуль: main — подключать отдельно не нужно

Доступно с версии: 16.0.0

Когда использовать

Класс PageNavigation разбивает список записей на страницы. Объект читает номер и размер страницы из адреса, рассчитывает смещение и лимит для запроса и строит ссылки на другие страницы. Компоненты main.pagenavigation и main.ui.grid принимают этот объект и выводят переключатель страниц.

Навигацию настраивают в четыре шага.

  1. Конструктор __construct создает объект с идентификатором, например nav-units. Идентификатор — имя параметра в адресе.
  2. Методы setPageSize, setPageSizes и allowAllRecords задают настройки, метод initFromUri читает параметры из адреса.
  3. Методы getOffset и getLimit возвращают параметры offset и limit для getList.
  4. Метод setRecordCount сохраняет общее число записей. Метод getPageCount считает по нему число страниц.

Класс поддерживает два формата параметров в адресе.

  • Параметр запроса, например /units/?nav-units=page-3-size-20.
  • Сегменты пути ЧПУ, например /units/nav-units/page-3/size-20/.

Значение page-all показывает все записи на одной странице, если это разрешил allowAllRecords.

Подробнее — в статьях Постраничная навигация и Класс PageNavigation.

Методы класса

Метод Описание С версии
__construct Создает объект навигации с идентификатором
initFromUri Читает номер и размер страницы из адреса
setPageSize Задает размер страницы
getPageSize Возвращает размер страницы
setPageSizes Задает размеры страницы, которые можно выбрать в адресе
getPageSizes Возвращает допустимые размеры страницы
setCurrentPage Задает номер текущей страницы
getCurrentPage Возвращает номер текущей страницы
setRecordCount Задает общее число записей
getRecordCount Возвращает общее число записей
getPageCount Возвращает число страниц
getOffset Возвращает смещение первой записи текущей страницы
getLimit Возвращает лимит выборки — число записей на текущей странице
allowAllRecords Разрешает показ всех записей на одной странице
allRecordsAllowed Проверяет, разрешен ли показ всех записей
allRecordsShown Проверяет, показаны ли все записи на одной странице
getId Возвращает идентификатор навигации
addParams Добавляет параметры навигации в адрес
clearParams Удаляет параметры навигации из адреса

Наследники

Класс Назначение
Bitrix\Main\UI\AdminPageNavigation Навигация на страницах административного раздела. Конструктор сам вызывает initFromUri. По умолчанию размеры страницы 10, 20, 50, 100, 200 и 500, показ всех записей разрешен
Bitrix\Main\UI\ReversePageNavigation Навигация с обратной нумерацией страниц. Конструктор принимает идентификатор и число записей. По умолчанию открыта последняя страница

Смотрите также