Open Journal Systems  3.3.0
Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher Class Reference
Inheritance diagram for Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher:
Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcherInterface Symfony\Component\EventDispatcher\EventDispatcherInterface

Public Member Functions

 __call ($method, $arguments)
 
 __call ($method, $arguments)
 
 __construct (EventDispatcherInterface $dispatcher, Stopwatch $stopwatch, LoggerInterface $logger=null)
 
 __construct (EventDispatcherInterface $dispatcher, Stopwatch $stopwatch, LoggerInterface $logger=null)
 
 addListener ($eventName, $listener, $priority=0)
 
 addListener ($eventName, $listener, $priority=0)
 
 addSubscriber (EventSubscriberInterface $subscriber)
 
 addSubscriber (EventSubscriberInterface $subscriber)
 
 dispatch ($eventName, Event $event=null)
 
 dispatch ($eventName, Event $event=null)
 
 getCalledListeners ()
 
 getCalledListeners ()
 
 getListenerPriority ($eventName, $listener)
 
 getListenerPriority ($eventName, $listener)
 
 getListeners ($eventName=null)
 
 getListeners ($eventName=null)
 
 getNotCalledListeners ()
 
 getNotCalledListeners ()
 
 hasListeners ($eventName=null)
 
 hasListeners ($eventName=null)
 
 removeListener ($eventName, $listener)
 
 removeListener ($eventName, $listener)
 
 removeSubscriber (EventSubscriberInterface $subscriber)
 
 removeSubscriber (EventSubscriberInterface $subscriber)
 

Protected Member Functions

 postDispatch ($eventName, Event $event)
 
 postDispatch ($eventName, Event $event)
 
 preDispatch ($eventName, Event $event)
 
 preDispatch ($eventName, Event $event)
 

Protected Attributes

 $logger
 
 $stopwatch
 

Detailed Description

Collects some data about event listeners.

This event dispatcher delegates the dispatching to another one.

Author
Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Definition at line 27 of file lib/vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

Constructor & Destructor Documentation

◆ __construct() [1/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::__construct ( EventDispatcherInterface  $dispatcher,
Stopwatch  $stopwatch,
LoggerInterface  $logger = null 
)

◆ __construct() [2/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::__construct ( EventDispatcherInterface  $dispatcher,
Stopwatch  $stopwatch,
LoggerInterface  $logger = null 
)

Member Function Documentation

◆ __call() [1/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::__call (   $method,
  $arguments 
)

Proxies all method calls to the original event dispatcher.

Parameters
string$methodThe method name
array$argumentsThe method arguments
Returns
mixed

Definition at line 211 of file lib/vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

◆ __call() [2/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::__call (   $method,
  $arguments 
)

Proxies all method calls to the original event dispatcher.

Parameters
string$methodThe method name
array$argumentsThe method arguments
Returns
mixed

Definition at line 211 of file vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

◆ addListener() [1/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::addListener (   $eventName,
  $listener,
  $priority = 0 
)

{Adds an event listener that listens on the specified events.

Parameters
string$eventNameThe event to listen on
callable$listenerThe listener
int$priorityThe higher this value, the earlier an event listener will be triggered in the chain (defaults to 0)
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 48 of file lib/vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

◆ addListener() [2/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::addListener (   $eventName,
  $listener,
  $priority = 0 
)

{Adds an event listener that listens on the specified events.

Parameters
string$eventNameThe event to listen on
callable$listenerThe listener
int$priorityThe higher this value, the earlier an event listener will be triggered in the chain (defaults to 0)
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 48 of file vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

◆ addSubscriber() [1/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::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.}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 56 of file lib/vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

◆ addSubscriber() [2/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::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.}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 56 of file vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

◆ dispatch() [1/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::dispatch (   $eventName,
Event  $event = null 
)

{Dispatches an event to all registered listeners.

Parameters
string$eventNameThe name of the event to dispatch. The name of the event is the name of the method that is invoked on listeners.
Event$eventThe event to pass to the event handlers/listeners If not supplied, an empty Event instance is created
Returns
Event
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 118 of file lib/vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

References Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher\postDispatch(), and Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher\preDispatch().

◆ dispatch() [2/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::dispatch (   $eventName,
Event  $event = null 
)

{Dispatches an event to all registered listeners.

Parameters
string$eventNameThe name of the event to dispatch. The name of the event is the name of the method that is invoked on listeners.
Event$eventThe event to pass to the event handlers/listeners If not supplied, an empty Event instance is created
Returns
Event
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 118 of file vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

References Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher\postDispatch(), and Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher\preDispatch().

◆ getCalledListeners() [1/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::getCalledListeners ( )

{Gets the called listeners.

Returns
array An array of called listeners
}

Implements Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcherInterface.

Definition at line 148 of file lib/vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

◆ getCalledListeners() [2/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::getCalledListeners ( )

{Gets the called listeners.

Returns
array An array of called listeners
}

Implements Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcherInterface.

Definition at line 148 of file vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

◆ getListenerPriority() [1/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::getListenerPriority (   $eventName,
  $listener 
)

◆ getListenerPriority() [2/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::getListenerPriority (   $eventName,
  $listener 
)

◆ getListeners() [1/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::getListeners (   $eventName = null)

{Gets the listeners of a specific event or all listeners sorted by descending priority.

Parameters
string$eventNameThe name of the event
Returns
array The event listeners for the specified event, or all event listeners by event name
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 90 of file vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

◆ getListeners() [2/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::getListeners (   $eventName = null)

{Gets the listeners of a specific event or all listeners sorted by descending priority.

Parameters
string$eventNameThe name of the event
Returns
array The event listeners for the specified event, or all event listeners by event name
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 90 of file lib/vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

Referenced by Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher\getNotCalledListeners().

◆ getNotCalledListeners() [1/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::getNotCalledListeners ( )

◆ getNotCalledListeners() [2/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::getNotCalledListeners ( )

◆ hasListeners() [1/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::hasListeners (   $eventName = null)

{Checks whether an event has any registered listeners.

Parameters
string$eventNameThe name of the event
Returns
bool true if the specified event has any listeners, false otherwise
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 110 of file vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

◆ hasListeners() [2/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::hasListeners (   $eventName = null)

{Checks whether an event has any registered listeners.

Parameters
string$eventNameThe name of the event
Returns
bool true if the specified event has any listeners, false otherwise
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 110 of file lib/vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

◆ postDispatch() [1/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::postDispatch (   $eventName,
Event  $event 
)
protected

Called after dispatching the event.

Parameters
string$eventNameThe event name
Event$eventThe event

Definition at line 232 of file vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

◆ postDispatch() [2/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::postDispatch (   $eventName,
Event  $event 
)
protected

Called after dispatching the event.

Parameters
string$eventNameThe event name
Event$eventThe event

Definition at line 232 of file lib/vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

Referenced by Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher\dispatch().

◆ preDispatch() [1/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::preDispatch (   $eventName,
Event  $event 
)
protected

Called before dispatching the event.

Parameters
string$eventNameThe event name
Event$eventThe event

Definition at line 222 of file lib/vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

Referenced by Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher\dispatch().

◆ preDispatch() [2/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::preDispatch (   $eventName,
Event  $event 
)
protected

Called before dispatching the event.

Parameters
string$eventNameThe event name
Event$eventThe event

Definition at line 222 of file vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

◆ removeListener() [1/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::removeListener (   $eventName,
  $listener 
)

{Removes an event listener from the specified events.

Parameters
string$eventNameThe event to remove a listener from
callable$listenerThe listener to remove
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 64 of file vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

◆ removeListener() [2/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::removeListener (   $eventName,
  $listener 
)

{Removes an event listener from the specified events.

Parameters
string$eventNameThe event to remove a listener from
callable$listenerThe listener to remove
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 64 of file lib/vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php.

◆ removeSubscriber() [1/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::removeSubscriber ( EventSubscriberInterface  $subscriber)

◆ removeSubscriber() [2/2]

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::removeSubscriber ( EventSubscriberInterface  $subscriber)

Field Documentation

◆ $logger

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::$logger
protected

◆ $stopwatch

Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher::$stopwatch
protected

The documentation for this class was generated from the following file: