Закодировать строку адреса Uri::urnEncode

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

Статический метод Uri::urnEncode кодирует строку адреса без разбора на части. Метод кодирует функцией rawurlencode текст между разделителями ://, :порт/, /, ?, = и &, а сами разделители оставляет. Метод нужен для адреса с пробелами и национальными символами в пути, например для ссылки на файл.

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

public static function urnEncode($str, $charset = false)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
str* string Задает адрес
charset string или false Задает кодировку результата. Если она отличается от кодировки сайта, метод сначала переводит текст в нее. По умолчанию — false, без перевода

Типы в таблице описывают назначение аргументов. Сигнатура PHP не объявляет их.

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

Метод возвращает закодированную строку.

Особенности

  • Метод не кодирует разделители, поэтому & или = внутри значения параметра останутся как есть. Значения параметров кодируйте отдельно, например методом addParams.
  • Метод кодирует и #, поэтому фрагмент перестает работать. Передавайте адрес без фрагмента.
  • В более ранних версиях, например 26.150.0, значение charset по умолчанию — 'UTF-8'. На сайте в UTF-8 результат тот же.

Примеры

Пример. Код кодирует ссылку на файл с кириллицей и пробелом:

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

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

echo Uri::urnEncode('https://example.com/docs/файл 1.pdf?lang=ru');

Код выведет https://example.com/docs/%D1%84%D0%B0%D0%B9%D0%BB%201.pdf?lang=ru.

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