Symfony2 API
Class

Symfony\Bundle\FrameworkBundle\Debug\TraceableEventDispatcher

class TraceableEventDispatcher extends ContainerAwareEventDispatcher implements TraceableEventDispatcherInterface

Extends the ContainerAwareEventDispatcher to add some debugging tools.

Methods

__construct(ContainerInterface $container, LoggerInterface $logger = null)

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

Adds a service as event listener

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

Removes an event listener from the specified events.

 from ContainerAwareEventDispatcher
Boolean hasListeners(string $eventName = null)

Checks whether an event has any registered listeners.

 from ContainerAwareEventDispatcher
array getListeners(string $eventName = null)

Gets the listeners of a specific event or all listeners.

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

Dispatches an event to all registered listeners.

 from ContainerAwareEventDispatcher
addListener($eventName, $listener, $priority)

{@inheritDoc}
array getCalledListeners()

Gets the called listeners.
array getNotCalledListeners()

Gets the not called listeners.

Details

at line 36
public __construct(ContainerInterface $container, LoggerInterface $logger = null)

Constructor.

Parameters

ContainerInterface $container A ContainerInterface instance
LoggerInterface $logger A LoggerInterface instance

in ContainerAwareEventDispatcher 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.

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

in ContainerAwareEventDispatcher 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 49
public addListener($eventName, $listener, $priority)

{@inheritDoc}

Parameters

$eventName
$listener
$priority

Exceptions

RuntimeException if the listener method is not callable

at line 121
public array getCalledListeners()

Gets the called listeners.

Return Value

array An array of called listeners

at line 129
public array getNotCalledListeners()

Gets the not called listeners.

Return Value

array An array of not called listeners