Class HeaderBag

HeaderBag is a container for HTTP headers.

Direct known subclasses

Symfony\Component\HttpFoundation\ResponseHeaderBag

Namespace: Symfony\Component\HttpFoundation
Author: Fabien Potencier <fabien@symfony.com>
Api
Located at vendor/Symfony/Component/HttpFoundation/HeaderBag.php

Methods summary
`public`	# `__construct( array $headers = array() )` Constructor. Constructor. Parameters `$headers` `array` An array of HTTP headers Api
`public string`	# `__toString( )` Returns the headers as a string. Returns the headers as a string. Returns `string` The headers
`public array`	# `all( )` Returns the headers. Returns the headers. Returns `array` An array of headers Api
`public array`	# `keys( )` Returns the parameter keys. Returns the parameter keys. Returns `array` An array of parameter keys Api
`public`	# `replace( array $headers = array() )` Replaces the current HTTP headers by a new set. Replaces the current HTTP headers by a new set. Parameters `$headers` `array` An array of HTTP headers Api
`public`	# `add( array $headers )` Adds new headers the current HTTP headers set. Adds new headers the current HTTP headers set. Parameters `$headers` `array` An array of HTTP headers Api
`public string\|array`	# `get( string $key, mixed $default = null, Boolean $first = true )` Returns a header value by name. Returns a header value by name. Parameters `$key` `string` The header name `$default` `mixed` The default value `$first` `Boolean` Whether to return the first value or all header values Returns `string\|array` The first header value if $first is true, an array of values otherwise Api
`public`	# `set( string $key, string\|array $values, Boolean $replace = true )` Sets a header by name. Sets a header by name. Parameters `$key` `string` The key `$values` `string\|array` The value or an array of values `$replace` `Boolean` Whether to replace the actual value of not (true by default) Api
`public Boolean`	# `has( string $key )` Returns true if the HTTP header is defined. Returns true if the HTTP header is defined. Parameters `$key` `string` The HTTP header Returns `Boolean` true if the parameter exists, false otherwise Api
`public Boolean`	# `contains( string $key, string $value )` Returns true if the given HTTP header contains the given value. Returns true if the given HTTP header contains the given value. Parameters `$key` `string` The HTTP header name `$value` `string` The HTTP value Returns `Boolean` true if the value is contained in the header, false otherwise Api
`public`	# `remove( string $key )` Removes a header. Removes a header. Parameters `$key` `string` The HTTP header name Api
`public DateTime`	# `getDate( string $key, DateTime $default = null )` Returns the HTTP header value converted to a date. Returns the HTTP header value converted to a date. Parameters `$key` `string` The parameter key `$default` `DateTime` The default value Returns `DateTime` The filtered value Api
`public`	# `addCacheControlDirective( $key, $value = true )`
`public`	# `hasCacheControlDirective( $key )`
`public`	# `getCacheControlDirective( $key )`
`public`	# `removeCacheControlDirective( $key )`
`protected`	# `getCacheControlHeader( )`
`protected array`	# `parseCacheControl( string $header )` Parses a Cache-Control HTTP header. Parses a Cache-Control HTTP header. Parameters `$header` `string` The value of the Cache-Control HTTP header Returns `array` An array representing the attribute values

Properties summary
`protected`	`$headers`		#
`protected`	`$cacheControl`		#