TraceableEventDispatcher
class TraceableEventDispatcher implements TraceableEventDispatcherInterface
Collects some data about event listeners.
This event dispatcher delegates the dispatching to another one.
Methods
__construct(EventDispatcherInterface $dispatcher, Stopwatch $stopwatch, LoggerInterface $logger = null) | ||
addListener(string $eventName, callable $listener, int $priority) Adds an event listener that listens on the specified events. | ||
addSubscriber(EventSubscriberInterface $subscriber) Adds an event subscriber. | ||
removeListener(string $eventName, callable $listener) Removes an event listener from the specified events. | ||
removeSubscriber(EventSubscriberInterface $subscriber) | ||
array | getListeners(string $eventName = null) Gets the listeners of a specific event or all listeners sorted by descending priority. | |
int|null | getListenerPriority(string $eventName, callable $listener) Gets the listener priority for a specific event. | |
bool | hasListeners(string $eventName = null) Checks whether an event has any registered listeners. | |
Event | dispatch(string $eventName, Event $event = null) Dispatches an event to all registered listeners. | |
array | getCalledListeners() Gets the called listeners. | |
array | getNotCalledListeners() Gets the not called listeners. | |
reset() Resets the trace. | ||
mixed | __call(string $method, array $arguments) Proxies all method calls to the original event dispatcher. |
Details
__construct(EventDispatcherInterface $dispatcher, Stopwatch $stopwatch, LoggerInterface $logger = null)
Parameters
EventDispatcherInterface | $dispatcher | |
Stopwatch | $stopwatch | |
LoggerInterface | $logger |
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 |
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)
Parameters
EventSubscriberInterface | $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 |
int|null getListenerPriority(string $eventName, callable $listener)
Gets the listener priority for a specific event.
Returns null if the event or the listener does not exist.
Parameters
string | $eventName | The name of the event |
callable | $listener | The listener |
Return Value
int|null | The event listener priority |
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 |
reset()
Resets the trace.
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 |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/EventDispatcher/Debug/TraceableEventDispatcher.html