Interface

Symfony\Component\EventDispatcher\EventDispatcherInterface

interface EventDispatcherInterface

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

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

Dispatches an event to all registered listeners.

addListener(string $eventName, callable $listener, integer $priority)

Adds an event listener that listens on the specified events.

addSubscriber(EventSubscriberInterface $subscriber)

Adds an event subscriber.

removeListener(string|array $eventName, callable $listener)

Removes an event listener from the specified events.

removeSubscriber(EventSubscriberInterface $subscriber)

Removes an event subscriber.

array getListeners(string $eventName = null)

Gets the listeners of a specific event or all listeners.

Boolean hasListeners(string $eventName = null)

Checks whether an event has any registered listeners.

Details

at line 36
public 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.

at line 48
public addListener(string $eventName, callable $listener, integer $priority)

Adds an event listener that listens on the specified events.

Parameters

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

at line 60
public 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 The subscriber.

at line 68
public removeListener(string|array $eventName, callable $listener)

Removes an event listener from the specified events.

Parameters

string|array $eventName The event(s) to remove a listener from
callable $listener The listener to remove

at line 75
public removeSubscriber(EventSubscriberInterface $subscriber)

Removes an event subscriber.

Parameters

EventSubscriberInterface $subscriber The subscriber

at line 84
public array getListeners(string $eventName = null)

Gets the listeners of a specific event or all listeners.

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

at line 93
public Boolean hasListeners(string $eventName = null)

Checks whether an event has any registered listeners.

Parameters

string $eventName The name of the event

Return Value

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