HeaderBag

__construct(array $headers = array())

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

Параметры

array

$headers

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

string __toString()

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

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

string

Заголовки

array all()

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

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

array

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

array keys()

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

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

array

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

replace(array $headers = array())

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

Параметры

array

$headers

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

add(array $headers)

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

Параметры

array

$headers

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

string|array get(string $key, mixed $default = null, bool $first = true)

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

Параметры

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

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

string|array

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

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

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

Параметры

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

bool has(string $key)

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

Параметры

string

$key

HTTP-заголовок

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

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

bool contains(string $key, string $value)

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

Параметры

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

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

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

remove(string $key)

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

Параметры

string

$key

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

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

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

Параметры

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

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

null|DateTime

Разложенный DateTime или значение по умолчанию, если заголовок не существует

Исключения

RuntimeException

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

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

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

Параметры

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

bool hasCacheControlDirective(string $key)

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

Параметры

string

$key

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

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

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

mixed|null getCacheControlDirective(string $key)

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

Параметры

string

$key

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

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

mixed|null

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

removeCacheControlDirective(string $key)

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

Параметры

string

$key

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

ArrayIterator getIterator()

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

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

ArrayIterator

Экземпляр \ArrayIterator

int count()

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

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

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