Warning: You are browsing the documentation for Symfony 2.5, which is no longer maintained.

Read the updated version of this page for Symfony 5.3 (the current stable version).

The Traceable Event Dispatcher

Name: SymfonyWorld 2021 Winter
Start: 2021-12-09
End: 2021-12-10

2.5 version

Maintained

4.4 5.3 current 5.4 dev 6.0

Unmaintained

2.3 2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 3.4 4.0 4.1 4.2 4.3 5.0 5.1 5.2

The Traceable Event Dispatcher¶

New in version 2.5: The TraceableEventDispatcher class was moved to the EventDispatcher component in Symfony 2.5. Before, it was located in the HttpKernel component.

The Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher is an event dispatcher that wraps any other event dispatcher and can then be used to determine which event listeners have been called by the dispatcher. Pass the event dispatcher to be wrapped and an instance of the Symfony\Component\Stopwatch\Stopwatch to its constructor:

use Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher;
use Symfony\Component\Stopwatch\Stopwatch;

// the event dispatcher to debug
$eventDispatcher = ...;

$traceableEventDispatcher = new TraceableEventDispatcher(
    $eventDispatcher,
    new Stopwatch()
);

Now, the TraceableEventDispatcher can be used like any other event dispatcher to register event listeners and dispatch events:

// ...

// register an event listener
$eventListener = ...;
$priority = ...;
$traceableEventDispatcher->addListener(
    'event.the_name',
    $eventListener,
    $priority
);

// dispatch an event
$event = ...;
$traceableEventDispatcher->dispatch('event.the_name', $event);

After your application has been processed, you can use the getCalledListeners() method to retrieve an array of event listeners that have been called in your application. Similarly, the getNotCalledListeners() method returns an array of event listeners that have not been called:

// ...

$calledListeners = $traceableEventDispatcher->getCalledListeners();
$notCalledListeners = $traceableEventDispatcher->getNotCalledListeners();

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.