\app\framework\Component\Route\Klein\DataCollectionHeaderDataCollection

__construct()

__construct(array  $headers = array(), integer  $normalization = self::NORMALIZE_ALL) 

Constructor

Parameters

keys()

keys(array  $mask = null, boolean  $fill_with_nulls = true) : array

Returns all of the key names in the collection

If an optional mask array is passed, this only returns the keys that match the mask

Parameters

Returns

all()

all(array  $mask = null, boolean  $fill_with_nulls = true) : array

Returns all of the attributes in the collection

If an optional mask array is passed, this only returns the keys that match the mask

Parameters

Returns

get()

get(string  $key, mixed  $default_val = null) : mixed

Get a header

Return a default value if the key doesn't exist

Parameters

Returns

set()

set(string  $key, mixed  $value) : \app\framework\Component\Route\Klein\DataCollection\HeaderDataCollection

Set a header

Parameters

Returns

replace()

replace(array  $attributes = array()) : \app\framework\Component\Route\Klein\DataCollection\DataCollection

Replace the collection's attributes

Parameters

Returns

merge()

merge(array  $attributes = array(), boolean  $hard = false) : \app\framework\Component\Route\Klein\DataCollection\DataCollection

Merge attributes with the collection's attributes

Optionally allows a second boolean parameter to merge the attributes into the collection in a "hard" manner, using the "array_replace" method instead of the usual "array_merge" method

Parameters

Returns

exists()

exists(string  $key) : boolean

Check if a header exists

Parameters

Returns

remove()

remove(string  $key) : void

Remove a header

Parameters

clear()

clear() : \app\framework\Component\Route\Klein\DataCollection\DataCollection

Clear the collection's contents

Semantic alias of a no-argument $this->replace call

Returns

isEmpty()

isEmpty() : boolean

Check if the collection is empty

Returns

cloneEmpty()

cloneEmpty() : \app\framework\Component\Route\Klein\DataCollection\DataCollection

A quick convenience method to get an empty clone of the collection. Great for dependency injection. :)

Returns

__get()

__get(string  $key) : mixed

Magic "__get" method

Allows the ability to arbitrarily request an attribute from this instance while treating it as an instance property

Parameters

Returns

__set()

__set(string  $key, mixed  $value) : void

Magic "__set" method

Allows the ability to arbitrarily set an attribute from this instance while treating it as an instance property

Parameters

__isset()

__isset(string  $key) : boolean

Magic "__isset" method

Allows the ability to arbitrarily check the existence of an attribute from this instance while treating it as an instance property

Parameters

Returns

__unset()

__unset(string  $key) : void

Magic "__unset" method

Allows the ability to arbitrarily remove an attribute from this instance while treating it as an instance property

Parameters

getIterator()

getIterator() : \ArrayIterator

Get the aggregate iterator

IteratorAggregate interface required method

Returns

offsetGet()

offsetGet(string  $key) : mixed

Get an attribute via array syntax

Allows the access of attributes of this instance while treating it like an array

Parameters

Returns

offsetSet()

offsetSet(string  $key, mixed  $value) : void

Set an attribute via array syntax

Allows the access of attributes of this instance while treating it like an array

Parameters

offsetExists()

offsetExists(string  $key) : boolean

Check existence an attribute via array syntax

Allows the access of attributes of this instance while treating it like an array

Parameters

Returns

offsetUnset()

offsetUnset(string  $key) : void

Remove an attribute via array syntax

Allows the access of attributes of this instance while treating it like an array

Parameters

count()

count() : integer

Count the attributes via a simple "count" call

Allows the use of the "count" function (or any internal counters) to simply count the number of attributes in the collection.

Returns

getNormalization()

getNormalization() : integer

Get the header key normalization technique/style to use

Returns

setNormalization()

setNormalization(integer  $normalization) : \app\framework\Component\Route\Klein\DataCollection\HeaderDataCollection

Set the header key normalization technique/style to use

Parameters

Returns

normalizeKeyDelimiters()

normalizeKeyDelimiters(string  $key) : string

Normalize a header key's delimiters

This will convert any space or underscore characters to a more standard hyphen (-) character

Parameters

Returns

canonicalizeKey()

canonicalizeKey(string  $key) : string

Canonicalize a header key

The canonical format is all lower case except for the first letter of "words" separated by a hyphen

Parameters

Returns

normalizeName()

normalizeName(string  $name, boolean  $make_lowercase = true) : string

Normalize a header name by formatting it in a standard way

This is useful since PHP automatically capitalizes and underscore separates the words of headers

Parameters

Returns

normalizeKey()

normalizeKey(string  $key) : string

Normalize a header key based on our set normalization style

Parameters

Returns