W3cubDocs

/Symfony 4.1

ExtractingEventDispatcher

class ExtractingEventDispatcher extends EventDispatcher implements EventSubscriberInterface

Properties

$listeners
static $subscriber

Methods

Event dispatch(string $eventName, Event $event = null)

Dispatches an event to all registered listeners.

from EventDispatcher
array getListeners(string $eventName = null)

Gets the listeners of a specific event or all listeners sorted by descending priority.

from EventDispatcher
int|null getListenerPriority(string $eventName, callable $listener)

Gets the listener priority for a specific event.

from EventDispatcher
bool hasListeners(string $eventName = null)

Checks whether an event has any registered listeners.

from EventDispatcher
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.

from EventDispatcher
addSubscriber(EventSubscriberInterface $subscriber)

Adds an event subscriber.

from EventDispatcher
removeSubscriber(EventSubscriberInterface $subscriber) from EventDispatcher
doDispatch(callable[] $listeners, string $eventName, Event $event)

Triggers the listeners of an event.

from EventDispatcher
static array getSubscribedEvents()

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.

Parameters

string $eventName The name of the event to dispatch. The name of the event is the name of the method that is invoked on listeners.
Event $event The event to pass to the event handlers/listeners If not supplied, an empty Event instance is created

Return Value

Event

array getListeners(string $eventName = null)

Gets the listeners of a specific event or all listeners sorted by descending priority.

Parameters

string $eventName The name of the event

Return Value

array The event listeners for the specified event, or all event listeners by event name

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.

Parameters

string $eventName The name of the event
callable $listener The listener

Return Value

int|null The event listener priority

bool hasListeners(string $eventName = null)

Checks whether an event has any registered listeners.

Parameters

string $eventName The name of the event

Return Value

bool true if the specified event has any listeners, false otherwise

addListener(string $eventName, callable $listener, int $priority = 0)

Adds an event listener that listens on the specified events.

Parameters

string $eventName The event to listen on
callable $listener The listener
int $priority The higher this value, the earlier an event listener will be triggered in the chain (defaults to 0)

removeListener(string $eventName, callable $listener)

Removes an event listener from the specified events.

Parameters

string $eventName The event to remove a listener from
callable $listener The listener to remove

addSubscriber(EventSubscriberInterface $subscriber)

Adds an event subscriber.

The subscriber is asked for all the events he is interested in and added as a listener for these events.

Parameters

EventSubscriberInterface $subscriber

removeSubscriber(EventSubscriberInterface $subscriber)

Parameters

EventSubscriberInterface $subscriber

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.

Parameters

callable[] $listeners The event listeners
string $eventName The name of the event to dispatch
Event $event The event object to pass to the event handlers/listeners

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')))

Return Value

array The event names to listen to