Documentation

TraceableEventDispatcher
in package
implements TraceableEventDispatcherInterface

Collects some data about event listeners.

This event dispatcher delegates the dispatching to another one.

Tags
author

Fabien Potencier fabien@symfony.com

Table of Contents

Interfaces

TraceableEventDispatcherInterface
The EventDispatcherInterface is the central point of Symfony's event listener system.

Properties

$logger  : mixed
$stopwatch  : mixed
$callStack  : mixed
$currentRequestHash  : mixed
$dispatcher  : mixed
$orphanedEvents  : mixed
$requestStack  : mixed
$wrappedListeners  : 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
Dispatches an event to all registered listeners.
getCalledListeners()  : array<string|int, mixed>
Gets the called listeners.
getListenerPriority()  : int|null
Gets the listener priority for a specific event.
getListeners()  : array<string|int, mixed>
Gets the listeners of a specific event or all listeners sorted by descending priority.
getNotCalledListeners()  : array<string|int, mixed>
Gets the not called listeners.
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.
postDispatch()  : mixed
preDispatch()  : mixed
postProcess()  : mixed
preProcess()  : mixed
sortNotCalledListeners()  : mixed

Properties

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

addListener()

Adds an event listener that listens on the specified events.

public addListener(mixed $eventName, mixed $listener[, mixed $priority = 0 ]) : mixed
Parameters
$eventName : mixed

The event to listen on

$listener : mixed

The listener

$priority : mixed = 0

The higher this value, the earlier an event listener will be triggered in the chain (defaults to 0)

dispatch()

Dispatches an event to all registered listeners.

public dispatch(mixed $event) : object
Parameters
$event : mixed

The event to pass to the event handlers/listeners

Return values
object —

The passed $event MUST be returned

getCalledListeners()

Gets the called listeners.

public getCalledListeners() : array<string|int, mixed>
Return values
array<string|int, mixed> —

An array of called listeners

getListenerPriority()

Gets the listener priority for a specific event.

public getListenerPriority(mixed $eventName, mixed $listener) : int|null
Parameters
$eventName : mixed

The name of the event

$listener : mixed

The listener

Return values
int|null —

The event listener priority

getListeners()

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

public getListeners([mixed $eventName = null ]) : array<string|int, mixed>
Parameters
$eventName : mixed = null

The name of the event

Return values
array<string|int, mixed> —

The event listeners for the specified event, or all event listeners by event name

getNotCalledListeners()

Gets the not called listeners.

public getNotCalledListeners() : array<string|int, mixed>
Return values
array<string|int, mixed> —

An array of not called listeners

getOrphanedEvents()

public getOrphanedEvents() : array<string|int, mixed>
Return values
array<string|int, mixed>

hasListeners()

Checks whether an event has any registered listeners.

public hasListeners([mixed $eventName = null ]) : bool
Parameters
$eventName : mixed = null

The name of the event

Return values
bool —

true if the specified event has any listeners, false otherwise

removeListener()

Removes an event listener from the specified events.

public removeListener(mixed $eventName, mixed $listener) : mixed
Parameters
$eventName : mixed

The event to remove a listener from

$listener : mixed

The listener to remove

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

postDispatch()

protected postDispatch(mixed $eventName, Event $event) : mixed

since Symfony 4.3, will be removed in 5.0, use afterDispatch instead

Parameters
$eventName : mixed
$event : Event

preDispatch()

protected preDispatch(mixed $eventName, Event $event) : mixed

since Symfony 4.3, will be removed in 5.0, use beforeDispatch instead

Parameters
$eventName : mixed
$event : Event

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> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results