ResponseHeaderBag

__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	Количество заголовков

array allPreserveCase()

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

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

array

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

allPreserveCaseWithoutCookies()

setCookie(Cookie $cookie)

Параметры

Cookie

$cookie

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

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

Параметры

string	$name
string	$path
string	$domain

array getCookies(string $format = self::COOKIES_FLAT)

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

Параметры

string

$format

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

array

Исключения

InvalidArgumentException

При неверном $format

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

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

Параметры

string	$name
string	$path
string	$domain
bool	$secure
bool	$httpOnly

string makeDisposition(string $disposition, string $filename, string $filenameFallback = '')

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

Параметры

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

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

string

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

Исключения

InvalidArgumentException

См. также

RFC

6266