Symfony2 API
Class

Symfony\Component\EventDispatcher\EventDispatcher

class EventDispatcher implements 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.
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.
addListener(string $eventName, callable $listener, integer $priority)

Adds an event listener that listens on the specified events.
removeListener(string|array $eventName, callable $listener)

Removes an event listener from the specified events.
addSubscriber(EventSubscriberInterface $subscriber)

Adds an event subscriber.
removeSubscriber(EventSubscriberInterface $subscriber)

Removes an event subscriber.

Details

at line 39
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.

See also

EventDispatcherInterface::dispatch

at line 55
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

See also

EventDispatcherInterface::getListeners

at line 77
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

See also

EventDispatcherInterface::hasListeners

at line 87
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)

See also

EventDispatcherInterface::addListener

at line 96
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

See also

EventDispatcherInterface::removeListener

at line 114
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.

See also

EventDispatcherInterface::addSubscriber

at line 128
public removeSubscriber(EventSubscriberInterface $subscriber)

Removes an event subscriber.

Parameters

EventSubscriberInterface $subscriber The subscriber

See also

EventDispatcherInterface::removeSubscriber