Добавить параметры запроса Uri::addParams
Модуль: main — подключать отдельно не нужно
Доступно с версии: 15.5.10
Метод Uri::addParams добавляет параметры в строку запроса. Если параметр уже есть, метод заменяет его значение. Метод меняет сам объект.
Сигнатура метода в классе Bitrix\Main\Web\Uri:
public function addParams(array $params, $preserveDots = false)
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| params* | array |
Задает параметры, например ['page' => 2]. Метод записывает значение-массив как name[0]=...&name[1]=... |
| preserveDots | bool |
Значение true сохраняет точки и пробелы в именах существующих параметров. По умолчанию — false |
Сигнатура PHP объявляет только тип params.
Возвращаемое значение
Метод возвращает тот же объект Uri.
Особенности
- Метод разбирает строку запроса функцией
parse_strи собирает заново функциейhttp_build_queryв кодировке RFC 3986. Поэтому метод меняет запись всех параметров. Например,+в значениях становится%20, а скобки в именах —%5Bи%5D. - Без
preserveDotsфункцияparse_strзаменяет точки и пробелы в именах существующих параметров на_. Например,filter.nameстанетfilter_name. Если в адресе есть такие параметры, передайтеtrue.
Примеры
Пример. Код меняет номер страницы и добавляет сортировку:
<?php
use Bitrix\Main\Web\Uri;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
$uri = new Uri('/units/list.php?filter.name=kg&page=2');
echo (clone $uri)->addParams(['page' => 3, 'sort' => 'name desc'])->getUri() . "\n";
echo (clone $uri)->addParams(['page' => 3], true)->getUri();
Код выведет:
/units/list.php?filter_name=kg&page=3&sort=name%20desc
/units/list.php?filter.name=kg&page=3
Смотрите также
Была ли статья полезна?
Предыдущая
Следующая