ExtractingEventDispatcher
class ExtractingEventDispatcher extends EventDispatcher implements EventSubscriberInterface
Properties
$listeners | |||
static | $subscriber |
Methods
Gets the listeners of a specific event or all listeners sorted by descending priority.
Gets the listener priority for a specific event.
Checks whether an event has any registered listeners.
Adds an event listener that listens on the specified events.
Removes an event listener from the specified events.
Triggers the listeners of an event.
Returns an array of event names this subscriber wants to listen to.
Details
Event
dispatch(string $eventName, Event $event = null)
Dispatches an event to all registered listeners.
array
getListeners(string|null $eventName = null)
Gets the listeners of a specific event or all listeners sorted by descending priority.
int|null
getListenerPriority(string $eventName, callable $listener)
Gets the listener priority for a specific event.
Returns null if the event or the listener does not exist.
bool
hasListeners(string|null $eventName = null)
Checks whether an event has any registered listeners.
addListener(string $eventName, callable $listener, int $priority = 0)
Adds an event listener that listens on the specified events.
removeListener(string $eventName, callable $listener)
Removes an event listener from the specified events.
addSubscriber(EventSubscriberInterface $subscriber)
Adds an event subscriber.
The subscriber is asked for all the events it is interested in and added as a listener for these events.
protected
doDispatch(callable[] $listeners, string $eventName, Event $event)
Triggers the listeners of an event.
This method can be overridden to add functionality that is executed for each listener.
static array
getSubscribedEvents()
Returns an array of event names this subscriber wants to listen to.
The array keys are event names and the value can be:
- The method name to call (priority defaults to 0)
- An array composed of the method name to call and the priority
- An array of arrays composed of the method names to call and respective priorities, or 0 if unset
For instance:
- array('eventName' => 'methodName')
- array('eventName' => array('methodName', $priority))
- array('eventName' => array(array('methodName1', $priority), array('methodName2')))