Проверить, показаны ли все записи PageNavigation::allRecordsShown

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

Метод PageNavigation::allRecordsShown проверяет, показаны ли все записи на одной странице. Метод initFromUri включает этот режим, если адрес содержит page-all и показ всех записей разрешен.

Сигнатура метода в классе Bitrix\Main\UI\PageNavigation:

public function allRecordsShown()

Возвращаемое значение

Метод возвращает true, если показаны все записи, иначе false.

В этом режиме getOffset возвращает 0, getLimit — общее число записей, а getPageCount — 1.

Примеры

Пример. Код проверяет режим, когда показ всех записей не разрешен:

<?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-all');

$nav = new PageNavigation('nav-units');
$nav->initFromUri();

var_dump($nav->allRecordsShown());

Код выведет bool(false). Без allowAllRecords(true) метод initFromUri игнорирует page-all.

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