1. class
  2. mako
  3. \
  4. http
  5. \
  6. request
  7. \
  8. Headers

Headers

class Headers implements Countable, IteratorAggregate

Headers.

Properties

protected array $headers Headers.
protected array $acceptableContentTypes Acceptable content types.
protected array $acceptableLanguages Acceptable languages.
protected array $acceptableCharsets Acceptable character sets.
protected array $acceptableEncodings Acceptable encodings.

Methods

__construct(array $headers = [])

Constructor.

int
count()

Returns the numner of headers.

ArrayIterator
getIterator()

Retruns an array iterator object.

string
normalizeName(string $name)

Normalizes header names.

add(string $name, string $value)

Adds a header.

bool
has(string $name)

Returns TRUE if the header exists and FALSE if not.

mixed
get(string $name, mixed $default = null)

Gets a header value.

remove(string $name)

Removes a header.

array
all()

Returns all the headers.

array
parseAcceptHeader(string|null $headerValue)

Parses a accpet header and returns the values in descending order of preference.

array
getAcceptableContentTypes(string|null $default = null)

Returns an array of acceptable content types in descending order of preference.

array
getAcceptableLanguages(string|null $default = null)

Returns an array of acceptable content types in descending order of preference.

array
getAcceptableCharsets(string|null $default = null)

Returns an array of acceptable content types in descending order of preference.

array
getAcceptableEncodings(string|null $default = null)

Returns an array of acceptable content types in descending order of preference.

Details

at line 70
__construct(array $headers = [])

Constructor.

Parameters

array $headers Headers

at line 80
int count()

Returns the numner of headers.

Return Value

int

at line 90
ArrayIterator getIterator()

Retruns an array iterator object.

Return Value

ArrayIterator

at line 101
protected string normalizeName(string $name)

Normalizes header names.

Parameters

string $name Header name

Return Value

string

at line 112
add(string $name, string $value)

Adds a header.

Parameters

string $name Header name
string $value Header value

at line 123
bool has(string $name)

Returns TRUE if the header exists and FALSE if not.

Parameters

string $name Header name

Return Value

bool

at line 135
mixed get(string $name, mixed $default = null)

Gets a header value.

Parameters

string $name Header name
mixed $default Default value

Return Value

mixed

at line 145
remove(string $name)

Removes a header.

Parameters

string $name Header name

at line 155
array all()

Returns all the headers.

Return Value

array

at line 166
protected array parseAcceptHeader(string|null $headerValue)

Parses a accpet header and returns the values in descending order of preference.

Parameters

string|null $headerValue Header value

Return Value

array

at line 210
array getAcceptableContentTypes(string|null $default = null)

Returns an array of acceptable content types in descending order of preference.

Parameters

string|null $default Default content type

Return Value

array

at line 226
array getAcceptableLanguages(string|null $default = null)

Returns an array of acceptable content types in descending order of preference.

Parameters

string|null $default Default language

Return Value

array

at line 242
array getAcceptableCharsets(string|null $default = null)

Returns an array of acceptable content types in descending order of preference.

Parameters

string|null $default Default charset

Return Value

array

at line 258
array getAcceptableEncodings(string|null $default = null)

Returns an array of acceptable content types in descending order of preference.

Parameters

string|null $default Default encoding

Return Value

array