GenericEvent

class GenericEvent extends Event implements ArrayAccess, IteratorAggregate

Event encapsulation class.

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

Methods

bool isPropagationStopped()

Returns whether further event listeners should be triggered.

from Event
stopPropagation()

Stops the propagation of the event to further event listeners.

from Event
__construct(mixed $subject = null, array $arguments = array())

Encapsulate an event with $subject and $args.

mixed getSubject()

Getter for subject property.

mixed getArgument(string $key)

Get argument by key.

$this setArgument(string $key, mixed $value)

Add argument to event.

array getArguments()

Getter for all arguments.

$this setArguments(array $args = array())

Set args property.

bool hasArgument(string $key)

Has argument.

mixed offsetGet(string $key)

ArrayAccess for argument getter.

offsetSet(string $key, mixed $value)

ArrayAccess for argument setter.

offsetUnset(string $key)

ArrayAccess for unset argument.

bool offsetExists(string $key)

ArrayAccess has argument.

ArrayIterator getIterator()

IteratorAggregate for iterating over the object like an array.

Details

bool isPropagationStopped()

Returns whether further event listeners should be triggered.

Return Value

bool Whether propagation was already stopped for this event

See also

Event::stopPropagation()

stopPropagation()

Stops the propagation of the event to further event listeners.

If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().

__construct(mixed $subject = null, array $arguments = array())

Encapsulate an event with $subject and $args.

Parameters

mixed $subject The subject of the event, usually an object or a callable
array $arguments Arguments to store in the event

mixed getSubject()

Getter for subject property.

Return Value

mixed $subject The observer subject

mixed getArgument(string $key)

Get argument by key.

Parameters

string $key Key

Return Value

mixed Contents of array key

Exceptions

InvalidArgumentException if key is not found

$this setArgument(string $key, mixed $value)

Add argument to event.

Parameters

string $key Argument name
mixed $value Value

Return Value

$this

array getArguments()

Getter for all arguments.

Return Value

array

$this setArguments(array $args = array())

Set args property.

Parameters

array $args Arguments

Return Value

$this

bool hasArgument(string $key)

Has argument.

Parameters

string $key Key of arguments array

Return Value

bool

mixed offsetGet(string $key)

ArrayAccess for argument getter.

Parameters

string $key Array key

Return Value

mixed

Exceptions

InvalidArgumentException if key does not exist in $this->args

offsetSet(string $key, mixed $value)

ArrayAccess for argument setter.

Parameters

string $key Array key to set
mixed $value Value

offsetUnset(string $key)

ArrayAccess for unset argument.

Parameters

string $key Array key

bool offsetExists(string $key)

ArrayAccess has argument.

Parameters

string $key Array key

Return Value

bool

ArrayIterator getIterator()

IteratorAggregate for iterating over the object like an array.

Return Value

ArrayIterator

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/EventDispatcher/GenericEvent.html