\Symfony\Component\EventDispatcherEventDispatcherInterface

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.

Summary

Methods
Constants
dispatch()
addListener()
addSubscriber()
removeListener()
removeSubscriber()
getListeners()
getListenerPriority()
hasListeners()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

dispatch()

dispatch(object  $event) : object

Provide all relevant listeners with an event to process.

Parameters

object $event

The object to process.

Returns

object —

The Event that was passed, now modified by listeners.

addListener()

addListener(\Symfony\Component\EventDispatcher\string  $eventName, callable  $listener, integer  $priority) 

Adds an event listener that listens on the specified events.

Parameters

\Symfony\Component\EventDispatcher\string $eventName
callable $listener

The listener

integer $priority

The higher this value, the earlier an event listener will be triggered in the chain (defaults to 0)

addSubscriber()

addSubscriber(\Symfony\Component\EventDispatcher\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

\Symfony\Component\EventDispatcher\EventSubscriberInterface $subscriber

removeListener()

removeListener(\Symfony\Component\EventDispatcher\string  $eventName, callable  $listener) 

Removes an event listener from the specified events.

Parameters

\Symfony\Component\EventDispatcher\string $eventName
callable $listener

The listener to remove

getListeners()

getListeners(\Symfony\Component\EventDispatcher\string  $eventName = null) : array

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

Parameters

\Symfony\Component\EventDispatcher\string $eventName

Returns

array —

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

getListenerPriority()

getListenerPriority(\Symfony\Component\EventDispatcher\string  $eventName, callable  $listener) : integer|null

Gets the listener priority for a specific event.

Returns null if the event or the listener does not exist.

Parameters

\Symfony\Component\EventDispatcher\string $eventName
callable $listener

The listener

Returns

integer|null —

The event listener priority

hasListeners()

hasListeners(\Symfony\Component\EventDispatcher\string  $eventName = null) : boolean

Checks whether an event has any registered listeners.

Parameters

\Symfony\Component\EventDispatcher\string $eventName

Returns

boolean —

true if the specified event has any listeners, false otherwise