Documentation

ImmutableEventDispatcher
in package
implements EventDispatcherInterface

A read-only proxy for an event dispatcher.

Tags
author

Bernhard Schussek bschussek@gmail.com

Interfaces, Classes and Traits

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

Table of Contents

$dispatcher  : mixed
__construct()  : mixed
addListener()  : mixed
Adds an event listener that listens on the specified events.
addSubscriber()  : mixed
Adds an event subscriber.
dispatch()  : object
{@inheritdoc}
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.
hasListeners()  : bool
Checks whether an event has any registered listeners.
removeListener()  : mixed
Removes an event listener from the specified events.
removeSubscriber()  : mixed

Properties

Methods

addListener()

Adds an event listener that listens on the specified events.

public addListener(string $eventName, mixed $listener, int $priority) : mixed
Parameters
$eventName : string
$listener : mixed

The listener

$priority : int

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

Return values
mixed

dispatch()

{@inheritdoc}

public dispatch(object $event[, string $eventName = null ]) : object
Parameters
$event : object
$eventName : string = null
Return values
object

getListenerPriority()

Gets the listener priority for a specific event.

public getListenerPriority(string $eventName, mixed $listener) : int|null
Parameters
$eventName : string
$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([string $eventName = null ]) : array<string|int, mixed>
Parameters
$eventName : string = null
Return values
array<string|int, mixed>

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

hasListeners()

Checks whether an event has any registered listeners.

public hasListeners([string $eventName = null ]) : bool
Parameters
$eventName : string = null
Return values
bool

true if the specified event has any listeners, false otherwise

removeListener()

Removes an event listener from the specified events.

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

The listener to remove

Return values
mixed

Search results