ResponseHeaderBag
class ResponseHeaderBag extends HeaderBag
ResponseHeaderBag — это контейнер для HTTP-заголовков ответа.
Константы
| COOKIES_FLAT | |
| COOKIES_ARRAY | |
| DISPOSITION_ATTACHMENT | |
| DISPOSITION_INLINE |
Методы
| __construct(array $headers = array()) Конструктор. | ||
| string | __toString() Возвращает заголовки в виде строки. | |
| array | all() Возвращает заголовки. | из HeaderBag |
| array | keys() Возвращает ключи параметров. | из HeaderBag |
| replace(array $headers = array()) Заменяет текущие HTTP-заголовки новым набором. | ||
| add(array $headers) Добавляет новые заголовки к текущему набору HTTP-заголовков. | из HeaderBag | |
| string|array | get(string $key, mixed $default = null, bool $first = true) Возвращает значение заголовка по имени. | из HeaderBag |
| set(string $key, string|array $values, bool $replace = true) Устанавливает заголовок по имени. | ||
| bool | has(string $key) Возвращает true, если HTTP-заголовок определен. | из HeaderBag |
| bool | contains(string $key, string $value) Возвращает true, если данный HTTP-заголовок содержит данное значение. | из HeaderBag |
| remove(string $key) Удаляет заголовок. | ||
| null|DateTime | getDate(string $key, DateTime $default = null) Возвращает значение HTTP-заголовка, преобразованное в дату. | из HeaderBag |
| addCacheControlDirective(string $key, mixed $value = true) Добавляет пользовательскую директиву Cache-Control. | из HeaderBag | |
| bool | hasCacheControlDirective(string $key) Возвращает true, если директива Cache-Control определена. | |
| mixed|null | getCacheControlDirective(string $key) Возвращает значение директивы Cache-Control по имени. | |
| removeCacheControlDirective(string $key) Удаляет директиву Cache-Control. | из HeaderBag | |
| ArrayIterator | getIterator() Возвращает итератор для заголовков. | из HeaderBag |
| int | count() Возвращает количество заголовков. | из HeaderBag |
| array | allPreserveCase() Возвращает заголовки с оригинальным регистром. | |
| setCookie(Cookie $cookie) Устанавливает cookie. | ||
| removeCookie(string $name, string $path = '/', string $domain = null) Удаляет cookie из массива, но не удаляет его из браузера. | ||
| array | getCookies(string $format = self::COOKIES_FLAT) Возвращает массив со всеми cookie. | |
| clearCookie(string $name, string $path = '/', string $domain = null, bool $secure = false, bool $httpOnly = true) Очищает cookie в браузере. | ||
| string | makeDisposition(string $disposition, string $filename, string $filenameFallback = '') Генерирует значение поля HTTP Content-Disposition. |
Подробное описание
__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 |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/HttpFoundation/ResponseHeaderBag.html
