W3cubDocs

/Symfony 2.8

Symfony\Component\EventDispatcher\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
setDispatcher(EventDispatcherInterface $dispatcher)

Stores the EventDispatcher that dispatches this Event.

from Event
EventDispatcherInterface getDispatcher()

Returns the EventDispatcher that dispatches this Event.

from Event
string getName()

Gets the event's name.

from Event
setName(string $name)

Sets the event's name property.

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.

GenericEvent setArgument(string $key, mixed $value)

Add argument to event.

array getArguments()

Getter for all arguments.

GenericEvent 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

public 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()

public 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().

public setDispatcher(EventDispatcherInterface $dispatcher)

Stores the EventDispatcher that dispatches this Event.

Parameters

EventDispatcherInterface $dispatcher

public EventDispatcherInterface getDispatcher()

Returns the EventDispatcher that dispatches this Event.

public string getName()

Gets the event's name.

Return Value

string

public setName(string $name)

Sets the event's name property.

Parameters

string $name The event name.

public __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.
array $arguments Arguments to store in the event.

public mixed getSubject()

Getter for subject property.

Return Value

mixed $subject The observer subject.

public 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.

public GenericEvent setArgument(string $key, mixed $value)

Add argument to event.

Parameters

string $key Argument name.
mixed $value Value.

Return Value

GenericEvent

public array getArguments()

Getter for all arguments.

Return Value

array

public GenericEvent setArguments(array $args = array())

Set args property.

Parameters

array $args Arguments.

Return Value

GenericEvent

public bool hasArgument(string $key)

Has argument.

Parameters

string $key Key of arguments array.

Return Value

bool

public 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.

public offsetSet(string $key, mixed $value)

ArrayAccess for argument setter.

Parameters

string $key Array key to set.
mixed $value Value.

public offsetUnset(string $key)

ArrayAccess for unset argument.

Parameters

string $key Array key.

public bool offsetExists(string $key)

ArrayAccess has argument.

Parameters

string $key Array key.

Return Value

bool

public ArrayIterator getIterator()

IteratorAggregate for iterating over the object like an array.

Return Value

ArrayIterator

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