Добавить значение заголовка HttpHeaders::add
Модуль: main — подключать отдельно не нужно
Метод HttpHeaders::add добавляет значение заголовка. Если заголовок уже есть, метод добавляет значение к прежним. Чтобы заменить значение, используйте set.
Сигнатура метода в классе Bitrix\Main\Web\HttpHeaders:
public function add($name, $value)
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| name* | string |
Задает имя заголовка. Допустимы латинские буквы, цифры и символы ``!#$%&'*+-.^_` |
| value* | string или string[] |
Задает значение или массив значений. Метод приводит каждое значение к строке. Управляющие символы, кроме табуляции, недопустимы |
Типы в таблице описывают назначение аргументов. Сигнатура PHP не объявляет их.
Возвращаемое значение
Метод ничего не возвращает.
Исключения
| Исключение | Когда возникает |
|---|---|
\InvalidArgumentException |
Имя пустое или содержит недопустимый символ, например пробел, либо значение содержит управляющий символ, кроме табуляции, например перевод строки или нулевой байт |
Особенности
- Имя заголовка не зависит от регистра. Коллекция запоминает имя в том виде, в котором его добавили впервые.
- Запрет переводов строк защищает от подстановки лишних заголовков через данные пользователя.
Примеры
Пример. Код добавляет значения и пробует добавить заголовок с недопустимым значением:
<?php
use Bitrix\Main\Web\HttpHeaders;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
$headers = new HttpHeaders();
$headers->add('X-Units', 'kg');
$headers->add('x-units', ['g', 't']);
echo implode(',', $headers->get('X-Units', true)) . "\n";
try
{
$headers->add('X-Note', "kg\r\nX-Injected: 1");
}
catch (\InvalidArgumentException $e)
{
echo 'invalid value';
}
Код выведет:
kg,g,t
invalid value
Смотрите также
Была ли статья полезна?
Предыдущая
Следующая