interface EventDispatcherInterface implementsEventDispatcherInterface

The EventDispatcherInterface is the central point of Symfony's event listener system.

Listeners are registered on the manager and events are dispatched through the manager.

Methods

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

Adds an event listener that listens on the specified events.

void
addSubscriber(EventSubscriberInterface$subscriber)

Adds an event subscriber.

void
removeListener(string$eventName,callable$listener)

Removes an event listener from the specified events.

void
removeSubscriber(EventSubscriberInterface$subscriber)

No description

array
getListeners(string$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.

bool
hasListeners(string$eventName =null)

Checks whether an event has any registered listeners.

Details

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

Adds an event listener that listens on the specified events.

Parameters

string $eventName
callable $listener
int $priority

Return Value

void

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

Parameters

EventSubscriberInterface $subscriber

Return Value

void

void removeListener(string$eventName,callable$listener)

Removes an event listener from the specified events.

Parameters

string $eventName
callable $listener

Return Value

void

void removeSubscriber(EventSubscriberInterface$subscriber)

Parameters

EventSubscriberInterface $subscriber

Return Value

void

array getListeners(string$eventName =null)

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

Parameters

string $eventName

Return Value

array

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
callable $listener

Return Value

int|null

bool hasListeners(string$eventName =null)

Checks whether an event has any registered listeners.

Parameters

string $eventName

Return Value

bool