TraceableEventDispatcher
in package
implements
EventDispatcherInterface, ResetInterface
Collects some data about event listeners.
This event dispatcher delegates the dispatching to another one.
Tags
Table of Contents
Interfaces
- EventDispatcherInterface
- The EventDispatcherInterface is the central point of Symfony's event listener system.
- ResetInterface
- Provides a way to reset an object to its initial state.
Properties
- $logger : mixed
- $stopwatch : mixed
- $callStack : SplObjectStorage<WrappedListener, array{: string, : string}>|null
- $currentRequestHash : string
- $dispatcher : mixed
- $orphanedEvents : array<string|int, mixed>
- $requestStack : mixed
- $wrappedListeners : array<string|int, mixed>
Methods
- __call() : mixed
- Proxies all method calls to the original event dispatcher.
- __construct() : mixed
- addListener() : mixed
- Adds an event listener that listens on the specified events.
- addSubscriber() : mixed
- Adds an event subscriber.
- dispatch() : object
- {@inheritdoc}
- getCalledListeners() : array<string|int, mixed>
- getListenerPriority() : int|null
- Gets the listener priority for a specific event.
- getListeners() : array<string|int, array<string|int, callable>|callable>
- Gets the listeners of a specific event or all listeners sorted by descending priority.
- getNotCalledListeners() : array<string|int, mixed>
- getOrphanedEvents() : array<string|int, mixed>
- hasListeners() : bool
- Checks whether an event has any registered listeners.
- removeListener() : mixed
- Removes an event listener from the specified events.
- removeSubscriber() : mixed
- reset() : mixed
- afterDispatch() : mixed
- Called after dispatching the event.
- beforeDispatch() : mixed
- Called before dispatching the event.
- postProcess() : void
- preProcess() : void
- sortNotCalledListeners() : mixed
Properties
$logger
protected
mixed
$logger
$stopwatch
protected
mixed
$stopwatch
$callStack
private
SplObjectStorage<WrappedListener, array{: string, : string}>|null
$callStack
= null
$currentRequestHash
private
string
$currentRequestHash
= ''
$dispatcher
private
mixed
$dispatcher
$orphanedEvents
private
array<string|int, mixed>
$orphanedEvents
= []
$requestStack
private
mixed
$requestStack
$wrappedListeners
private
array<string|int, mixed>
$wrappedListeners
= []
Methods
__call()
Proxies all method calls to the original event dispatcher.
public
__call(string $method, array<string|int, mixed> $arguments) : mixed
Parameters
- $method : string
-
The method name
- $arguments : array<string|int, mixed>
-
The method arguments
__construct()
public
__construct(EventDispatcherInterface $dispatcher, Stopwatch $stopwatch[, LoggerInterface $logger = null ][, RequestStack $requestStack = null ]) : mixed
Parameters
- $dispatcher : EventDispatcherInterface
- $stopwatch : Stopwatch
- $logger : LoggerInterface = null
- $requestStack : RequestStack = null
addListener()
Adds an event listener that listens on the specified events.
public
addListener(string $eventName, callable|array<string|int, mixed> $listener[, int $priority = 0 ]) : mixed
Parameters
- $eventName : string
- $listener : callable|array<string|int, mixed>
- $priority : int = 0
-
The higher this value, the earlier an event listener will be triggered in the chain (defaults to 0)
addSubscriber()
Adds an event subscriber.
public
addSubscriber(EventSubscriberInterface $subscriber) : mixed
Parameters
- $subscriber : EventSubscriberInterface
dispatch()
{@inheritdoc}
public
dispatch(object $event[, string $eventName = null ]) : object
Parameters
- $event : object
- $eventName : string = null
Return values
objectgetCalledListeners()
public
getCalledListeners([Request $request = null ]) : array<string|int, mixed>
Parameters
- $request : Request = null
Return values
array<string|int, mixed>getListenerPriority()
Gets the listener priority for a specific event.
public
getListenerPriority(string $eventName, callable|array<string|int, mixed> $listener) : int|null
Parameters
- $eventName : string
- $listener : callable|array<string|int, mixed>
Return values
int|nullgetListeners()
Gets the listeners of a specific event or all listeners sorted by descending priority.
public
getListeners([string $eventName = null ]) : array<string|int, array<string|int, callable>|callable>
Parameters
- $eventName : string = null
Return values
array<string|int, array<string|int, callable>|callable>getNotCalledListeners()
public
getNotCalledListeners([Request $request = null ]) : array<string|int, mixed>
Parameters
- $request : Request = null
Return values
array<string|int, mixed>getOrphanedEvents()
public
getOrphanedEvents([Request $request = null ]) : array<string|int, mixed>
Parameters
- $request : Request = null
Return values
array<string|int, mixed>hasListeners()
Checks whether an event has any registered listeners.
public
hasListeners([string $eventName = null ]) : bool
Parameters
- $eventName : string = null
Return values
boolremoveListener()
Removes an event listener from the specified events.
public
removeListener(string $eventName, callable|array<string|int, mixed> $listener) : mixed
Parameters
- $eventName : string
- $listener : callable|array<string|int, mixed>
removeSubscriber()
public
removeSubscriber(EventSubscriberInterface $subscriber) : mixed
Parameters
- $subscriber : EventSubscriberInterface
reset()
public
reset() : mixed
afterDispatch()
Called after dispatching the event.
protected
afterDispatch(string $eventName, object $event) : mixed
Parameters
- $eventName : string
- $event : object
beforeDispatch()
Called before dispatching the event.
protected
beforeDispatch(string $eventName, object $event) : mixed
Parameters
- $eventName : string
- $event : object
postProcess()
private
postProcess(string $eventName) : void
Parameters
- $eventName : string
preProcess()
private
preProcess(string $eventName) : void
Parameters
- $eventName : string
sortNotCalledListeners()
private
sortNotCalledListeners(array<string|int, mixed> $a, array<string|int, mixed> $b) : mixed
Parameters
- $a : array<string|int, mixed>
- $b : array<string|int, mixed>