Class GenericEvent

Event encapsulation class.

Encapsulates events thus decoupling the observer from the subject they encapsulate.

Symfony\Component\EventDispatcher\GenericEvent implements ArrayAccess, IteratorAggregate

Namespace: Symfony\Component\EventDispatcher
Author: Drak drak@zikula.org
Located at GenericEvent.php

Methods summary
`public`	# `__construct( mixed $subject = null, array $arguments = array() )` Encapsulate an event with $subject and $args. Encapsulate an event with $subject and $args. Parameters `$subject` The subject of the event, usually an object. `$arguments` Arguments to store in the event.
`public mixed`	# `getSubject( )` Getter for subject property. Getter for subject property. Returns mixed $subject The observer subject.
`public mixed`	# `getArgument( string $key )` Get argument by key. Get argument by key. Parameters `$key` Key. Returns mixed Contents of array key. Throws `InvalidArgumentException` If key is not found.
`public Symfony\Component\EventDispatcher\GenericEvent`	# `setArgument( string $key, mixed $value )` Add argument to event. Add argument to event. Parameters `$key` Argument name. `$value` Value. Returns `Symfony\Component\EventDispatcher\GenericEvent`
`public array`	# `getArguments( )` Getter for all arguments. Getter for all arguments. Returns array
`public Symfony\Component\EventDispatcher\GenericEvent`	# `setArguments( array $args = array() )` Set args property. Set args property. Parameters `$args` Arguments. Returns `Symfony\Component\EventDispatcher\GenericEvent`
`public boolean`	# `hasArgument( string $key )` Has argument. Has argument. Parameters `$key` Key of arguments array. Returns boolean
`public mixed`	# `offsetGet( string $key )` ArrayAccess for argument getter. ArrayAccess for argument getter. Parameters `$key` Array key. Returns mixed Throws `InvalidArgumentException` If key does not exist in $this->args. Implementation of `ArrayAccess::offsetGet()`
`public`	# `offsetSet( string $key, mixed $value )` ArrayAccess for argument setter. ArrayAccess for argument setter. Parameters `$key` Array key to set. `$value` Value. Implementation of `ArrayAccess::offsetSet()`
`public`	# `offsetUnset( string $key )` ArrayAccess for unset argument. ArrayAccess for unset argument. Parameters `$key` Array key. Implementation of `ArrayAccess::offsetUnset()`
`public boolean`	# `offsetExists( string $key )` ArrayAccess has argument. ArrayAccess has argument. Parameters `$key` Array key. Returns boolean Implementation of `ArrayAccess::offsetExists()`
`public ArrayIterator`	# `getIterator( )` IteratorAggregate for iterating over the object like an array. IteratorAggregate for iterating over the object like an array. Returns `ArrayIterator` Implementation of `IteratorAggregate::getIterator()`

Methods inherited from Symfony\Component\EventDispatcher\Event
`isPropagationStopped(), stopPropagation()`

Properties summary
`protected mixed`	`$subject` Event subject. Event subject.	#
`protected array`	`$arguments` Array of arguments. Array of arguments.	#

Namespaces

Classes

Interfaces

Class GenericEvent

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of