\Symfony\Component\HttpFoundationHeaderBag

HeaderBag is a container for HTTP headers.

Summary

Methods

Properties

Constants

__construct()
__toString()
all()
keys()
replace()
add()
get()
set()
has()
contains()
remove()
getDate()
addCacheControlDirective()
hasCacheControlDirective()
getCacheControlDirective()
removeCacheControlDirective()
getIterator()
count()

No public properties found

UPPER
LOWER

getCacheControlHeader()
parseCacheControl()

$headers
$cacheControl

N/A

No private methods found

No private properties found

N/A

File: vendor/symfony/http-foundation/HeaderBag.php
Package: Application
Class hierarchy: \Symfony\Component\HttpFoundation\HeaderBag
Implements
Uses

Constants

UPPER

UPPER = '_ABCDEFGHIJKLMNOPQRSTUVWXYZ'

LOWER

LOWER = '-abcdefghijklmnopqrstuvwxyz'

Properties

$headers

$headers : array<string,list<string|null>>

Type

array> —

$cacheControl

$cacheControl

Methods

__construct()

__construct(array  $headers = []) : mixed

Parameters

array

$headers

Returns

mixed —

__toString()

__toString() : string

Returns the headers as a string.

Returns

string —

all()

all(string|null  $key = null) : array<string,array<int,string|null>>|array<int,string|null>

Returns the headers.

Parameters

string|null

$key

The name of the headers to return or null to get them all

Returns

array>|array —

keys()

keys() : string[]

Returns the parameter keys.

Returns

string[] —

replace()

replace(array  $headers = []) : mixed

Replaces the current HTTP headers by a new set.

Parameters

array

$headers

Returns

mixed —

add()

add(array  $headers) : mixed

Adds new headers the current HTTP headers set.

Parameters

array

$headers

Returns

mixed —

get()

get(string  $key, string  $default = null) : string|null

Returns the first header by name or the default one.

Parameters

string	$key
string	$default

Returns

string|null —

set()

set(string  $key, string|string[]|null  $values, bool  $replace = true) : mixed

Sets a header by name.

Parameters

string	$key
string\|string[]\|null	$values	The value or an array of values
bool	$replace	Whether to replace the actual value or not (true by default)

Returns

mixed —

has()

has(string  $key) : bool

Returns true if the HTTP header is defined.

Parameters

string

$key

Returns

bool —

contains()

contains(string  $key, string  $value) : bool

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

Parameters

string	$key
string	$value

Returns

bool —

remove()

remove(string  $key) : mixed

Removes a header.

Parameters

string

$key

Returns

mixed —

getDate()

getDate(string  $key, \DateTime  $default = null) : \DateTimeInterface|null

Returns the HTTP header value converted to a date.

Parameters

string	$key
\DateTime	$default

Throws

\RuntimeException: When the HTTP header is not parseable

Returns

\DateTimeInterface|null —

addCacheControlDirective()

addCacheControlDirective(string  $key, bool|string  $value = true) : mixed

Adds a custom Cache-Control directive.

Parameters

string	$key
bool\|string	$value	The Cache-Control directive value

Returns

mixed —

hasCacheControlDirective()

hasCacheControlDirective(string  $key) : bool

Returns true if the Cache-Control directive is defined.

Parameters

string

$key

Returns

bool —

getCacheControlDirective()

getCacheControlDirective(string  $key) : bool|string|null

Returns a Cache-Control directive value by name.

Parameters

string

$key

Returns

bool|string|null —

removeCacheControlDirective()

removeCacheControlDirective(string  $key) : mixed

Removes a Cache-Control directive.

Parameters

string

$key

Returns

mixed —

getIterator()

getIterator() : \ArrayIterator<string,list<string|null>>

Returns an iterator for headers.

Returns

\ArrayIterator> —

count()

count() : int

Returns the number of headers.

Returns

int —

getCacheControlHeader()

getCacheControlHeader() : mixed

Returns

mixed —

parseCacheControl()

parseCacheControl(string  $header) : array

Parses a Cache-Control HTTP header.

Parameters

string

$header

Returns

array —

author	Fabien Potencier fabien@symfony.com
implements	\IteratorAggregate<string, list<string\|null>>