ResponseHeaderBag

__construct(array $headers = array())

Конструктор.

Параметры

Массив

$headers

Массив HTTP-заголовков

строка __toString()

Возвращает заголовки в виде строки.

Значение возврата

Строка

Заголовки

Массив all()

Возвращает заголовки.

Значение возврата

Массив

Массив заголовков

Массив keys()

Возвращает ключи параметров.

Значение возврата

Массив

Массив ключей параметров

replace(array $headers = array())

Заменяет текущие HTTP-заголовки новым набором.

Параметры

Массив

$headers

Массив HTTP-заголовков

add(array $headers)

Добавляет новые заголовки к текущему набору HTTP-заголовков.

Параметры

Массив

$headers

Массив HTTP-заголовков

Строка|Массив get(string $key, mixed $default = null, bool $first = true)

Возвращает значение заголовка по имени.

Параметры

Строка	$key	Имя заголовка
Смешанное	$default	Значение по умолчанию
Булево	$first	Возвращать первое значение или все значения заголовка

Значение возврата

Строка|Массив

Первое значение заголовка, если $first равно true, иначе массив значений

set(string $key, string|array $values, bool $replace = true)

Устанавливает заголовок по имени.

Параметры

Строка	$key	Ключ
Строка|Массив	$values	Значение или массив значений
Булево	$replace	Заменять фактическое значение или нет (по умолчанию true)

Булево has(string $key)

Возвращает true, если HTTP-заголовок определен.

Параметры

Строка

$key

HTTP-заголовок

Значение возврата

Булево

true, если параметр существует, иначе false

Булево contains(string $key, string $value)

Возвращает true, если данный HTTP-заголовок содержит данное значение.

Параметры

Строка	$key	Имя HTTP-заголовка
Строка	$value	HTTP-значение

Значение возврата

Булево

true, если значение содержится в заголовке, иначе false

remove(string $key)

Удаляет заголовок.

Параметры

Строка

$key

Имя HTTP-заголовка

null|DateTime getDate(string $key, DateTime $default = null)

Возвращает значение HTTP-заголовка, преобразованное в дату.

Параметры

Строка	$key	Ключ параметра
DateTime	$default	Значение по умолчанию

Значение возврата

null|DateTime

Парсируемая DateTime или значение по умолчанию, если заголовок не существует

Исключения

RuntimeException

При невозможности парсинга HTTP-заголовка

addCacheControlDirective(string $key, mixed $value = true)

Добавляет пользовательскую директиву Cache-Control.

Параметры

Строка	$key	Имя директивы Cache-Control
Смешанное	$value	Значение директивы Cache-Control

Булево hasCacheControlDirective(string $key)

Возвращает true, если директива Cache-Control определена.

Параметры

Строка

$key

Директива Cache-Control

Значение возврата

Булево

true, если директива существует, иначе false

Смешанное|null getCacheControlDirective(string $key)

Возвращает значение директивы Cache-Control по имени.

Параметры

Строка

$key

Имя директивы

Значение возврата

Смешанное|null

Значение директивы, если определено, иначе null

removeCacheControlDirective(string $key)

Удаляет директиву Cache-Control.

Параметры

Строка

$key

Директива Cache-Control

ArrayIterator getIterator()

Возвращает итератор для заголовков.

Значение возврата

ArrayIterator

Экземпляр \ArrayIterator

Целое число count()

Возвращает количество заголовков.

Значение возврата

Целое число

Количество заголовков

Массив allPreserveCase()

Возвращает заголовки с исходным регистром.

Значение возврата

Массив

Массив заголовков

setCookie(Cookie $cookie)

Устанавливает cookie.

Параметры

Cookie

$cookie

removeCookie(string $name, string $path = '/', string $domain = null)

Удаляет cookie из массива, но не удаляет его в браузере.

Параметры

Строка	$name
Строка	$path
Строка	$domain

Массив getCookies(string $format = self::COOKIES_FLAT)

Возвращает массив со всеми cookie.

Параметры

Строка

$format

Значение возврата

Массив

Исключения

InvalidArgumentException

При некорректном $format

clearCookie(string $name, string $path = '/', string $domain = null, bool $secure = false, bool $httpOnly = true)

Очищает cookie в браузере.

Параметры

Строка	$name
Строка	$path
Строка	$domain
Булево	$secure
Булево	$httpOnly

Строка makeDisposition(string $disposition, string $filename, string $filenameFallback = '')

Генерирует значение поля HTTP Content-Disposition.

Параметры

Строка	$disposition	Одно из "inline" или "attachment"
Строка	$filename	Строка Unicode
Строка	$filenameFallback	Строка, содержащая только символы ASCII, семантически эквивалентная $filename. Если имя файла уже ASCII, можно опустить или просто скопировать из $filename

Значение возврата

Строка

Строка, подходящая для использования в качестве значения поля Content-Disposition

Исключения

InvalidArgumentException

См. также

RFC

6266