class Collector implements CollectorInterface, ArrayAccess, Countable, IteratorAggregate (View source)

The Collector class.

Methods

__construct(array $data = array())

Class init.

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

Get a value.

set(string $name, mixed $value)

set

array
getData()

Get all data.

setData(array $data)

setData

integer
count()

Count the number of arguments.

boolean
offsetExists(string $name)

Tell if the given event argument exists.

mixed
offsetGet(string $name)

Get an event argument value.

void
offsetSet(string $name, mixed $value)

Set the value of an event argument.

void
offsetUnset(string $name)

Remove an event argument.

getIterator()

Retrieve an external iterator

Details

at line line 30
__construct(array $data = array())

Class init.

Parameters

array $data

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

Get a value.

Parameters

string $name The data name you want to get.
mixed $default The default value if not exists.

Return Value

mixed The found value or default.

at line line 61
Collector set(string $name, mixed $value)

set

Parameters

string $name
mixed $value

Return Value

Collector

at line line 73
array getData()

Get all data.

Return Value

array

at line line 85
Collector setData(array $data)

setData

Parameters

array $data

Return Value

Collector

at line line 99
integer count()

Count the number of arguments.

Return Value

integer The number of arguments.

at line line 113
boolean offsetExists(string $name)

Tell if the given event argument exists.

Parameters

string $name The argument name.

Return Value

boolean True if it exists, false otherwise.

at line line 127
mixed offsetGet(string $name)

Get an event argument value.

Parameters

string $name The argument name.

Return Value

mixed The argument value or null if not existing.

at line line 144
void offsetSet(string $name, mixed $value)

Set the value of an event argument.

Parameters

string $name The argument name.
mixed $value The argument value.

Return Value

void

Exceptions

InvalidArgumentException If the argument name is null.

at line line 163
void offsetUnset(string $name)

Remove an event argument.

Parameters

string $name The argument name.

Return Value

void

at line line 176
Traversable getIterator()

Retrieve an external iterator

Return Value

Traversable An instance of an object implementing Iterator