HttpHeaders — коллекция HTTP-заголовков

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

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

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

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

Класс HttpHeaders хранит заголовки HTTP-запроса или ответа. Объект HttpResponse хранит в нем заголовки и статус ответа сайта, а HttpClient — заголовки запроса и ответа внешнего сервера.

Класс решает три задачи.

  • Методы add, set, get, has и delete работают с заголовками. Имена заголовков не зависят от регистра. У одного заголовка может быть несколько значений.
  • Методы getContentType, getCharset, getFilename и getCookies разбирают значения стандартных заголовков.
  • Методы createFromString, getStatus и getVersion работают с текстом ответа и строкой статуса.

Объект можно перебрать в foreach. Ключ — имя заголовка, значение — массив значений.

Подробнее — в статье Request и Response.

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

Метод Описание С версии
__construct Создает коллекцию заголовков
add Добавляет значение заголовка
set Заменяет значение заголовка
get Возвращает значение заголовка
has Проверяет, есть ли заголовок
delete Удаляет заголовок
clear Удаляет все заголовки
toString Возвращает заголовки строкой в формате HTTP
toArray Возвращает внутренний массив заголовков
getHeaders Возвращает заголовки массивом «имя — значения»
getIterator Возвращает итератор для foreach
getContentType Возвращает тип содержимого из Content-Type
getContentTypeAttribute Возвращает атрибут из Content-Type
getCharset Возвращает кодировку из Content-Type
getBoundary Возвращает разделитель частей из Content-Type
getContentDisposition Возвращает тип из Content-Disposition
getFilename Возвращает имя файла из Content-Disposition
getCookies Возвращает cookie из заголовков Set-Cookie
createFromString Создает коллекцию из текста заголовков ответа со строкой статуса
parseStatus Читает версию и статус из строки статуса
setStatus Задает код и текст статуса
getStatus Возвращает код статуса
getReasonPhrase Возвращает текст статуса
setVersion Задает версию HTTP
getVersion Возвращает версию HTTP

Константы

Константа Значение Описание
DEFAULT_HTTP_STATUS 0 Статус, который возвращает getStatus, если статус не задан

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