Symfony2 API
Class

Symfony\Bundle\FrameworkBundle\ContainerAwareEventDispatcher

class ContainerAwareEventDispatcher extends EventDispatcher

Lazily loads listeners and subscribers from the dependency injection container

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.

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

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

Adds an event subscriber.

 from EventDispatcher
removeSubscriber(EventSubscriberInterface $subscriber)

Removes an event subscriber.

 from EventDispatcher
__construct(ContainerInterface $container)

Constructor.
addListenerService(string $eventName, array $callback, integer $priority)

Adds a service as event listener

Details

at line 141
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 120
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 104
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

in EventDispatcher 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 74
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

in EventDispatcher 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

in EventDispatcher at line 128
public removeSubscriber(EventSubscriberInterface $subscriber)

Removes an event subscriber.

Parameters

EventSubscriberInterface $subscriber The subscriber

See also

EventDispatcherInterface::removeSubscriber

at line 50
public __construct(ContainerInterface $container)

Constructor.

Parameters

ContainerInterface $container A ContainerInterface instance

at line 65
public addListenerService(string $eventName, array $callback, integer $priority)

Adds a service as event listener

Parameters

string $eventName Event for which the listener is added
array $callback The service ID of the listener service & the method name that has to be called
integer $priority The higher this value, the earlier an event listener will be triggered in the chain. Defaults to 0.