class HeaderBag implements IteratorAggregate, Countable
HeaderBag is a container for HTTP headers.
__construct(array $headers = array()) | ||
string | __toString() Returns the headers as a string. | |
array | all() Returns the headers. | |
array | keys() Returns the parameter keys. | |
replace(array $headers = array()) Replaces the current HTTP headers by a new set. | ||
add(array $headers) Adds new headers the current HTTP headers set. | ||
string|array | get(string $key, mixed $default = null, bool $first = true) Returns a header value by name. | |
set(string $key, string|array $values, bool $replace = true) Sets a header by name. | ||
bool | has(string $key) Returns true if the HTTP header is defined. | |
bool | contains(string $key, string $value) Returns true if the given HTTP header contains the given value. | |
remove(string $key) Removes a header. | ||
null|DateTime | getDate(string $key, DateTime $default = null) Returns the HTTP header value converted to a date. | |
addCacheControlDirective(string $key, mixed $value = true) Adds a custom Cache-Control directive. | ||
bool | hasCacheControlDirective(string $key) Returns true if the Cache-Control directive is defined. | |
mixed|null | getCacheControlDirective(string $key) Returns a Cache-Control directive value by name. | |
removeCacheControlDirective(string $key) Removes a Cache-Control directive. | ||
ArrayIterator | getIterator() Returns an iterator for headers. | |
int | count() Returns the number of headers. |
array | $headers | An array of HTTP headers |
Returns the headers as a string.
string | The headers |
Returns the headers.
array | An array of headers |
Returns the parameter keys.
array | An array of parameter keys |
Replaces the current HTTP headers by a new set.
array | $headers | An array of HTTP headers |
Adds new headers the current HTTP headers set.
array | $headers | An array of HTTP headers |
Returns a header value by name.
string | $key | The header name |
mixed | $default | The default value |
bool | $first | Whether to return the first value or all header values |
string|array | The first header value if $first is true, an array of values otherwise |
Sets a header by name.
string | $key | The key |
string|array | $values | The value or an array of values |
bool | $replace | Whether to replace the actual value or not (true by default) |
Returns true if the HTTP header is defined.
string | $key | The HTTP header |
bool | true if the parameter exists, false otherwise |
Returns true if the given HTTP header contains the given value.
string | $key | The HTTP header name |
string | $value | The HTTP value |
bool | true if the value is contained in the header, false otherwise |
Removes a header.
string | $key | The HTTP header name |
Returns the HTTP header value converted to a date.
string | $key | The parameter key |
DateTime | $default | The default value |
null|DateTime | The parsed DateTime or the default value if the header does not exist |
RuntimeException | When the HTTP header is not parseable |
Adds a custom Cache-Control directive.
string | $key | The Cache-Control directive name |
mixed | $value | The Cache-Control directive value |
Returns true if the Cache-Control directive is defined.
string | $key | The Cache-Control directive |
bool | true if the directive exists, false otherwise |
Returns a Cache-Control directive value by name.
string | $key | The directive name |
mixed|null | The directive value if defined, null otherwise |
Removes a Cache-Control directive.
string | $key | The Cache-Control directive |
Returns an iterator for headers.
ArrayIterator | An \ArrayIterator instance |
Returns the number of headers.
int | The number of headers |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/HttpFoundation/HeaderBag.html