Uri — разбор и сборка адреса

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

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

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

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

Класс Uri разбирает адрес на части — схему, хост, порт, путь, строку запроса и фрагмент — и собирает его обратно. Класс нужен, чтобы добавить или удалить параметры запроса, сменить хост или путь, сделать адрес абсолютным.

Класс реализует интерфейсы PSR-7 Psr\Http\Message\UriInterface и JsonSerializable. Объект можно привести к строке, например (string)$uri.

Методы работают с объектом двумя способами.

  • Методы set*, addParams, deleteParams, toAbsolute и resolveRelativeUri меняют сам объект и возвращают его.
  • Методы with* из PSR-7 не меняют объект и возвращают измененную копию.

Методы addParams и clearParams класса PageNavigation принимают и возвращают объект Uri. PSR-7-запрос Bitrix\Main\Web\Http\Request хранит адрес как UriInterface. Методы HttpClient, например get и post, принимают адрес строкой, объект Uri PHP приведет к строке.

Метод getUrl устарел. Он возвращает то же, что getLocator. Для нового кода используйте getLocator или getUri.

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

Метод Описание С версии
__construct Создает объект из строки адреса
getUri Возвращает адрес целиком 15.5.10
getLocator Возвращает адрес без фрагмента 15.5.10
getPathQuery Возвращает путь со строкой запроса 14.0.15
getScheme Возвращает схему 14.0.15
getHost Возвращает хост 14.0.15
setHost Задает хост 14.0.15
getPort Возвращает порт 14.0.15
getUser Возвращает имя пользователя 14.0.15
setUser Задает имя пользователя 16.5.7
getPass Возвращает пароль 14.0.15
setPass Задает пароль 16.5.7
getUserInfo Возвращает имя пользователя и пароль
getAuthority Возвращает учетные данные, хост и порт
getPath Возвращает путь 14.0.15
setPath Задает путь 15.5.10
getQuery Возвращает строку запроса 14.0.15
addParams Добавляет или заменяет параметры запроса 15.5.10
deleteParams Удаляет параметры запроса 15.5.10
getFragment Возвращает фрагмент 14.0.15
toAbsolute Делает адрес абсолютным по хосту
resolveRelativeUri Дополняет относительный адрес частями базового адреса
isPathTraversal Проверяет, есть ли в пути переход ..
convertToPunycode Переводит хост в Punycode
convertToUnicode Переводит хост из Punycode в Unicode
urnEncode Кодирует части строки адреса без разбора
urnDecode Раскодирует части строки адреса без разбора
jsonSerialize Возвращает адрес для json_encode
withScheme Возвращает копию с другой схемой
withUserInfo Возвращает копию с другими учетными данными
withHost Возвращает копию с другим хостом
withPort Возвращает копию с другим портом
withPath Возвращает копию с другим путем
withQuery Возвращает копию с другой строкой запроса
withFragment Возвращает копию с другим фрагментом

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