Сделать адрес абсолютным Uri::toAbsolute

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

Метод Uri::toAbsolute делает адрес абсолютным. Метод добавляет схему и хост к адресу без хоста. Метод нужен, например, для ссылок в письмах и в RSS.

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

public function toAbsolute(?string $host = null): Uri

Параметры

Параметр Тип Описание
host string или null Задает хост, можно с портом. Метод отбрасывает порт 80 и 443. По умолчанию — null, тогда метод берет хост из текущего запроса

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

Метод возвращает тот же объект Uri.

Особенности

  • Если у адреса уже есть хост, метод ничего не меняет.
  • Метод всегда берет схему из текущего запроса и заменяет ею схему адреса. Схема https, если запрос пришел по HTTPS, на порт 443 или в секции https_request файла .settings.php задано true. Иначе схема http.
  • Хост из текущего запроса метод берет без порта. Если сайт работает на нестандартном порту, передайте host с портом.
  • Метод сохраняет хост из аргумента как есть, без приведения к нижнему регистру. Нестандартный порт остается частью хоста, поэтому getHost вернет хост вместе с портом.
  • В агентах и консольных скриптах нет HTTP-запроса. Без аргумента host метод подставит пустой хост и соберет неверный адрес. В таком коде передавайте хост, например из настроек сайта.

Примеры

Пример. Код делает адрес абсолютным с хостом из аргумента:

<?php
use Bitrix\Main\Web\Uri;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

echo (new Uri('/units/?page=2'))->toAbsolute('example.com:443')->getUri() . "\n";
echo (new Uri('https://shop.example.com/units/'))->toAbsolute('example.com')->getUri();

Код выведет:

http://example.com/units/?page=2
https://shop.example.com/units/

Код запускали не по HTTPS, поэтому первый адрес получил схему http.

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