Symfony\Component\EventDispatcher\GenericEvent
Event encapsulation class.
Encapsulates events thus decoupling the observer from the subject they encapsulate.
- Author: Drak <drak@zikula.org>
Synopsis
class GenericEvent
extends Event
implements
ArrayAccess,IteratorAggregate
{
- // members
- protected mixed $subject;
- protected array $arguments;
- // methods
- public void __construct()
- public mixed getSubject()
- public mixed getArgument()
- public GenericEvent setArgument()
- public array getArguments()
- public GenericEvent setArguments()
- public boolean hasArgument()
- public mixed offsetGet()
- public void offsetSet()
- public void offsetUnset()
- public boolean offsetExists()
- public ArrayIterator getIterator()
- // Inherited methods from Event
- public Boolean isPropagationStopped()
- public void stopPropagation()
- public void setDispatcher()
- public EventDispatcherInterface getDispatcher()
- public string getName()
- public void setName()
Hierarchy
Members
protected
- $arguments
—
array
Array of arguments. - $subject
—
mixed
Observer pattern subject.
Methods
public
- __construct() — Encapsulate an event with $subject and $args.
- getArgument() — Get argument by key.
- getArguments() — Getter for all arguments.
- getIterator() — IteratorAggregate for iterating over the object like an array
- getSubject() — Getter for subject property.
- hasArgument() — Has argument.
- offsetExists() — ArrayAccess has argument.
- offsetGet() — ArrayAccess for argument getter.
- offsetSet() — ArrayAccess for argument setter.
- offsetUnset() — ArrayAccess for unset argument.
- setArgument() — Add argument to event.
- setArguments() — Set args property.
Inherited from Symfony\Component\EventDispatcher\Event
public
- getDispatcher() — Returns the EventDispatcher that dispatches this Event
- getName() — Gets the event's name.
- isPropagationStopped() — Returns whether further event listeners should be triggered.
- setDispatcher() — Stores the EventDispatcher that dispatches this Event
- setName() — Sets the event's name property.
- stopPropagation() — Stops the propagation of the event to further event listeners.