1. class
  2. Windwalker
  3. Event
  4. Event

Event

class Event implements EventInterface, ArrayAccess, Serializable, Countable (View source)

Class Event

Methods

__construct(string $name, array $arguments = array())

Constructor.

string
getName()

Get the event name.

Event
setName(string $name)

Method to set property name

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

Get an event argument value.

boolean
hasArgument(string $name)

Tell if the given event argument exists.

array
getArguments()

Get all event arguments.

Event
setArguments(array $arguments)

Method to set property arguments

Event
addArgument(string $name, mixed $value)

Add an event argument, only if it is not existing.

Event
setArgument(string $name, mixed $value)

Set the value of an event argument.

Event
mergeArguments(array $arguments)

mergeArguments

mixed
removeArgument(string $name)

Remove an event argument.

Event
clearArguments()

Clear all event arguments.

void
stop()

Stop the event propagation.

boolean
isStopped()

Tell if the event propagation is stopped.

integer
count()

Count the number of arguments.

string
serialize()

Serialize the event.

void
unserialize(string $serialized)

Unserialize the event.

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.

Details

at line line 53
__construct(string $name, array $arguments = array())

Constructor.

Parameters

string $name The event name.
array $arguments The event arguments.

at line line 67
string getName()

Get the event name.

Return Value

string The event name.

at line line 79
Event setName(string $name)

Method to set property name

Parameters

string $name

Return Value

Event Return self to support chaining.

at line line 96
mixed getArgument(string $name, mixed $default = null)

Get an event argument value.

Parameters

string $name The argument name.
mixed $default The default value if not found.

Return Value

mixed The argument value or the default value.

at line line 115
boolean hasArgument(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 128
array getArguments()

Get all event arguments.

Return Value

array An associative array of argument names as keys and their values as values.

at line line 141
Event setArguments(array $arguments)

Method to set property arguments

Parameters

array $arguments An associative array of argument names as keys and their values as values.

Return Value

Event Return self to support chaining.

at line line 160
Event addArgument(string $name, mixed $value)

Add an event argument, only if it is not existing.

Parameters

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

Return Value

Event This method is chainable.

at line line 181
Event setArgument(string $name, mixed $value)

Set the value of an event argument.

If the argument already exists, it will be overridden.

Parameters

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

Return Value

Event This method is chainable.

at line line 195
Event mergeArguments(array $arguments)

mergeArguments

Parameters

array $arguments

Return Value

Event

at line line 214
mixed removeArgument(string $name)

Remove an event argument.

Parameters

string $name The argument name.

Return Value

mixed The old argument value or null if it is not existing.

at line line 235
Event clearArguments()

Clear all event arguments.

Return Value

Event Return self to support chaining.

at line line 252
void stop()

Stop the event propagation.

Return Value

void

at line line 264
boolean isStopped()

Tell if the event propagation is stopped.

Return Value

boolean True if stopped, false otherwise.

at line line 276
integer count()

Count the number of arguments.

Return Value

integer The number of arguments.

at line line 288
string serialize()

Serialize the event.

Return Value

string The serialized event.

at line line 302
void unserialize(string $serialized)

Unserialize the event.

Parameters

string $serialized The serialized event.

Return Value

void

at line line 316
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 330
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 347
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 366
void offsetUnset(string $name)

Remove an event argument.

Parameters

string $name The argument name.

Return Value

void