Symfony2 API
Class

Symfony\Component\HttpFoundation\HeaderBag

class HeaderBag implements IteratorAggregate, Countable

HeaderBag is a container for HTTP headers.

Methods

__construct(array $headers = array())

Constructor.
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, Boolean $first = true)

Returns a header value by name.
set(string $key, string|array $values, Boolean $replace = true)

Sets a header by name.
Boolean has(string $key)

Returns true if the HTTP header is defined.
Boolean 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($key, $value = true)

hasCacheControlDirective($key)

getCacheControlDirective($key)

removeCacheControlDirective($key)

ArrayIterator getIterator()

Returns an iterator for headers.
int count()

Returns the number of headers.

Details

at line 33
public __construct(array $headers = array())

Constructor.

Parameters

array $headers An array of HTTP headers

at line 47
public string __toString()

Returns the headers as a string.

Return Value

string The headers

at line 73
public array all()

Returns the headers.

Return Value

array An array of headers

at line 85
public array keys()

Returns the parameter keys.

Return Value

array An array of parameter keys

at line 97
public replace(array $headers = array())

Replaces the current HTTP headers by a new set.

Parameters

array $headers An array of HTTP headers

at line 110
public add(array $headers)

Adds new headers the current HTTP headers set.

Parameters

array $headers An array of HTTP headers

at line 128
public string|array get(string $key, mixed $default = null, Boolean $first = true)

Returns a header value by name.

Parameters

string $key The header name
mixed $default The default value
Boolean $first Whether to return the first value or all header values

Return Value

string|array The first header value if $first is true, an array of values otherwise

at line 156
public set(string $key, string|array $values, Boolean $replace = true)

Sets a header by name.

Parameters

string $key The key
string|array $values The value or an array of values
Boolean $replace Whether to replace the actual value or not (true by default)

at line 182
public Boolean has(string $key)

Returns true if the HTTP header is defined.

Parameters

string $key The HTTP header

Return Value

Boolean true if the parameter exists, false otherwise

at line 197
public Boolean contains(string $key, string $value)

Returns true if the given HTTP header contains the given value.

Parameters

string $key The HTTP header name
string $value The HTTP value

Return Value

Boolean true if the value is contained in the header, false otherwise

at line 209
public remove(string $key)

Removes a header.

Parameters

string $key The HTTP header name

at line 232
public null|DateTime getDate(string $key, DateTime $default = null)

Returns the HTTP header value converted to a date.

Parameters

string $key The parameter key
DateTime $default The default value

Return Value

null|DateTime The parsed DateTime or the default value if the header does not exist

Exceptions

RuntimeException When the HTTP header is not parseable

at line 245
public addCacheControlDirective($key, $value = true)

Parameters

$key
$value

at line 252
public hasCacheControlDirective($key)

Parameters

$key

at line 257
public getCacheControlDirective($key)

Parameters

$key

at line 262
public removeCacheControlDirective($key)

Parameters

$key

at line 274
public ArrayIterator getIterator()

Returns an iterator for headers.

Return Value

ArrayIterator An \ArrayIterator instance

at line 284
public int count()

Returns the number of headers.

Return Value

int The number of headers