method public

PageNavigation::clearParams()

Сигнатура

public clearParams(Uri $uri, bool $sef) : Uri

Описание

Очищает URI от параметров навигации и возвращает его.

Параметры

$uri Uri

$sef bool

Режим SEF.

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

Uri

Как применяется в PageNavigation

PageNavigation::clearParams() — метод класса \Bitrix\Main\UI\PageNavigation модуля «Главный модуль».

Метод объекта: сначала нужен экземпляр PageNavigation.

use Bitrix\Main\UI\PageNavigation;

/** @var PageNavigation $object */
$uri = null; // Uri
$sef = true;
$result = $object->clearParams($uri, $sef);
// $result: Uri

Другие методы PageNavigation

addParams() Возвращает URI с параметрами навигации, совместимыми с initFromUri().
allowAllRecords()
allRecordsAllowed() Возвращает true, если показ всех записей разрешён.
allRecordsShown() Возвращает true, если все записи показываются на одной странице.
getCurrentPage() Возвращает номер текущей страницы.
getId() Возвращает идентификатор навигации.
getLimit() Возвращает количество записей на текущей странице.
getOffset() Возвращает смещение первой записи текущей страницы.
getPageCount() Возвращает количество страниц или 0, если recordCount не задан.
getPageSize() Возвращает "формальный" размер страницы.
getPageSizes() Возвращает допустимые размеры страниц.
getRecordCount() Возвращает количество записей.

clearParams() есть и у других классов модуля «Главный модуль»: AdminPageNavigation, ReversePageNavigation.

Исходный файл: source/main/lib/ui/pagenavigation.php:311