HeaderBag
class HeaderBag implements IteratorAggregate, Countable
HeaderBag — контейнер для HTTP-заголовков.
Свойства
| protected | $headers | ||
| protected | $cacheControl |
Методы
| __construct(array $headers = array()) | ||
| строка | __toString() Возвращает заголовки в виде строки. | |
| массив | all() Возвращает заголовки. | |
| массив | keys() Возвращает ключи параметров. | |
| replace(array $headers = array()) Заменяет текущие HTTP-заголовки новым набором. | ||
| add(array $headers) Добавляет новые заголовки к текущему набору HTTP-заголовков. | ||
| строка|массив строк|null | get(string $key, string|string[]|null $default = null, bool $first = true) Возвращает значение заголовка по имени. | |
| set(string $key, string|string[] $values, bool $replace = true) Устанавливает заголовок по имени. | ||
| булево | has(string $key) Возвращает true, если HTTP-заголовок определен. | |
| булево | contains(string $key, string $value) Возвращает true, если данный HTTP-заголовок содержит данное значение. | |
| remove(string $key) Удаляет заголовок. | ||
| DateTime|null | getDate(string $key, DateTime $default = null) Возвращает значение HTTP-заголовка, преобразованное в дату. | |
| addCacheControlDirective(string $key, mixed $value = true) Добавляет пользовательскую директиву Cache-Control. | ||
| булево | hasCacheControlDirective(string $key) Возвращает true, если директива Cache-Control определена. | |
| mixed|null | getCacheControlDirective(string $key) Возвращает значение директивы Cache-Control по имени. | |
| removeCacheControlDirective(string $key) Удаляет директиву Cache-Control. | ||
| ArrayIterator | getIterator() Возвращает итератор для заголовков. | |
| целое | count() Возвращает количество заголовков. | |
| getCacheControlHeader() | ||
| массив | parseCacheControl(string $header) Парсит HTTP-заголовок Cache-Control. |
Подробности
__construct(array $headers = array())
Параметры
| массив | $headers | Массив HTTP-заголовков |
строка __toString()
Возвращает заголовки в виде строки.
Значение возврата
| строка | Заголовки |
массив all()
Возвращает заголовки.
Значение возврата
| массив | Массив заголовков |
массив keys()
Возвращает ключи параметров.
Значение возврата
| массив | Массив ключей параметров |
replace(array $headers = array())
Заменяет текущие HTTP-заголовки новым набором.
Параметры
| массив | $headers | Массив HTTP-заголовков |
add(array $headers)
Добавляет новые заголовки к текущему набору HTTP-заголовков.
Параметры
| массив | $headers | Массив HTTP-заголовков |
строка|массив строк|null get(string $key, string|string[]|null $default = null, bool $first = true)
Возвращает значение заголовка по имени.
Параметры
| строка | $key | Имя заголовка |
| строка|массив строк|null | $default | Значение по умолчанию |
| булево | $first | Возвращать первое значение или все значения заголовков |
Значение возврата
| строка|массив строк|null | Первое значение заголовка или значение по умолчанию, если $first равно true, в противном случае массив значений |
set(string $key, string|string[] $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-заголовка |
DateTime|null getDate(string $key, DateTime $default = null)
Возвращает значение HTTP-заголовка, преобразованное в дату.
Параметры
| строка | $key | Ключ параметра |
| DateTime | $default | Значение по умолчанию |
Значение возврата
| DateTime|null | Парсированный DateTime или значение по умолчанию, если заголовок не существует |
Исключения
| RuntimeException | При невозможности парсинга HTTP-заголовка |
addCacheControlDirective(string $key, mixed $value = true)
Добавляет пользовательскую директиву Cache-Control.
Параметры
| строка | $key | Имя директивы Cache-Control |
| mixed | $value | Значение директивы Cache-Control |
булево hasCacheControlDirective(string $key)
Возвращает true, если директива Cache-Control определена.
Параметры
| строка | $key | Директива Cache-Control |
Значение возврата
| булево | true, если директива существует, иначе false |
mixed|null getCacheControlDirective(string $key)
Возвращает значение директивы Cache-Control по имени.
Параметры
| строка | $key | Имя директивы |
Значение возврата
| mixed|null | Значение директивы, если определено, иначе null |
removeCacheControlDirective(string $key)
Удаляет директиву Cache-Control.
Параметры
| строка | $key | Директива Cache-Control |
ArrayIterator getIterator()
Возвращает итератор для заголовков.
Значение возврата
| ArrayIterator | Экземпляр \ArrayIterator |
целое count()
Возвращает количество заголовков.
Значение возврата
| целое | Количество заголовков |
protected getCacheControlHeader()
protected массив parseCacheControl(string $header)
Парсит HTTP-заголовок Cache-Control.
Параметры
| строка | $header | Значение HTTP-заголовка Cache-Control |
Значение возврата
| массив | Массив, представляющий значения атрибутов |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/HttpFoundation/HeaderBag.html
