TraceableEventDispatcher
class TraceableEventDispatcher extends TraceableEventDispatcher
Collects some data about event listeners.
This event dispatcher delegates the dispatching to another one.
Methods
__construct(EventDispatcherInterface $dispatcher, Stopwatch $stopwatch, LoggerInterface $logger = null) Constructor. | from TraceableEventDispatcher | |
addListener(string $eventName, callable $listener, int $priority) Adds an event listener that listens on the specified events. | from TraceableEventDispatcher | |
addSubscriber(EventSubscriberInterface $subscriber) Adds an event subscriber. | from TraceableEventDispatcher | |
removeListener(string $eventName, callable $listener) Removes an event listener from the specified events. | from TraceableEventDispatcher | |
removeSubscriber(EventSubscriberInterface $subscriber) Removes an event subscriber. | from TraceableEventDispatcher | |
array | getListeners(string $eventName = null) Gets the listeners of a specific event or all listeners sorted by descending priority. | from TraceableEventDispatcher |
getListenerPriority($eventName, $listener) {@inheritdoc} | from TraceableEventDispatcher | |
bool | hasListeners(string $eventName = null) Checks whether an event has any registered listeners. | from TraceableEventDispatcher |
Event | dispatch(string $eventName, Event $event = null) Dispatches an event to all registered listeners. | from TraceableEventDispatcher |
array | getCalledListeners() Gets the called listeners. | from TraceableEventDispatcher |
array | getNotCalledListeners() Gets the not called listeners. | from TraceableEventDispatcher |
mixed | __call(string $method, array $arguments) Proxies all method calls to the original event dispatcher. | from TraceableEventDispatcher |
setProfiler(Profiler $profiler = null) deprecated Sets the profiler. |
Details
__construct(EventDispatcherInterface $dispatcher, Stopwatch $stopwatch, LoggerInterface $logger = null)
Constructor.
Parameters
EventDispatcherInterface | $dispatcher | An EventDispatcherInterface instance |
Stopwatch | $stopwatch | A Stopwatch instance |
LoggerInterface | $logger | A LoggerInterface instance |
addListener(string $eventName, callable $listener, int $priority)
Adds an event listener that listens on the specified events.
Parameters
string | $eventName | The event to listen on |
callable | $listener | The listener |
int | $priority | The higher this value, the earlier an event listener will be triggered in the chain (defaults to 0) |
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. |
removeListener(string $eventName, callable $listener)
Removes an event listener from the specified events.
Parameters
string | $eventName | The event to remove a listener from |
callable | $listener | The listener to remove |
removeSubscriber(EventSubscriberInterface $subscriber)
Removes an event subscriber.
Parameters
EventSubscriberInterface | $subscriber | The subscriber |
array getListeners(string $eventName = null)
Gets the listeners of a specific event or all listeners sorted by descending priority.
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 |
getListenerPriority($eventName, $listener)
{@inheritdoc}
Parameters
$eventName | ||
$listener |
bool hasListeners(string $eventName = null)
Checks whether an event has any registered listeners.
Parameters
string | $eventName | The name of the event |
Return Value
bool | true if the specified event has any listeners, false otherwise |
Event 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. |
Return Value
Event |
array getCalledListeners()
Gets the called listeners.
Return Value
array | An array of called listeners |
array getNotCalledListeners()
Gets the not called listeners.
Return Value
array | An array of not called listeners |
mixed __call(string $method, array $arguments)
Proxies all method calls to the original event dispatcher.
Parameters
string | $method | The method name |
array | $arguments | The method arguments |
Return Value
mixed |
setProfiler(Profiler $profiler = null) deprecated
deprecated
Sets the profiler.
The traceable event dispatcher does not use the profiler anymore. The job is now done directly by the Profiler listener and the data collectors themselves.
Parameters
Profiler | $profiler | A Profiler instance |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/HttpKernel/Debug/TraceableEventDispatcher.html