method
public
PageNavigation::addParams()
Сигнатура
public addParams(Uri $uri, bool $sef, string $page[, string $size = null ]) : UriОписание
Возвращает URI с параметрами навигации, совместимыми с initFromUri().
Параметры
$uri
Uri
$sef
bool
Режим SEF.
$page
string
Номер страницы.
$size
string
= null
Размер страницы.
Возвращаемое значение
Uri
Как применяется в PageNavigation
PageNavigation::addParams() — метод класса \Bitrix\Main\UI\PageNavigation модуля «Главный модуль».
Метод объекта: сначала нужен экземпляр PageNavigation.
use Bitrix\Main\UI\PageNavigation;
/** @var PageNavigation $object */
$uri = null; // Uri
$sef = true;
$page = '';
$result = $object->addParams($uri, $sef, $page);
// $result: UriДругие методы PageNavigation
allowAllRecords()allRecordsAllowed()Возвращает true, если показ всех записей разрешён.allRecordsShown()Возвращает true, если все записи показываются на одной странице.clearParams()Очищает URI от параметров навигации и возвращает его.getCurrentPage()Возвращает номер текущей страницы.getId()Возвращает идентификатор навигации.getLimit()Возвращает количество записей на текущей странице.getOffset()Возвращает смещение первой записи текущей страницы.getPageCount()Возвращает количество страниц или 0, если recordCount не задан.getPageSize()Возвращает "формальный" размер страницы.getPageSizes()Возвращает допустимые размеры страниц.getRecordCount()Возвращает количество записей.
addParams() есть и у других классов модуля «Главный модуль»: AdminPageNavigation, ContentUri, ReversePageNavigation, Uri.
Исходный файл: source/main/lib/ui/pagenavigation.php:287
