\Symfony\Component\EventDispatcherImmutableEventDispatcher

A read-only proxy for an event dispatcher.

Summary

Methods

Properties

Constants

__construct()
dispatch()
addListener()
addSubscriber()
removeListener()
removeSubscriber()
getListeners()
getListenerPriority()
hasListeners()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$dispatcher

N/A

File: vendor/symfony/event-dispatcher/ImmutableEventDispatcher.php
Package: Application
Class hierarchy: \Symfony\Component\EventDispatcher\ImmutableEventDispatcher
Implements: \Symfony\Component\EventDispatcher\EventDispatcherInterface
Uses

Properties

$dispatcher

$dispatcher

Methods

__construct()

__construct(\Symfony\Component\EventDispatcher\EventDispatcherInterface  $dispatcher) : mixed

Parameters

\Symfony\Component\EventDispatcher\EventDispatcherInterface

$dispatcher

Returns

mixed —

dispatch()

dispatch(object  $event, string  $eventName = null) : object

{@inheritdoc}

Parameters

object	$event
string	$eventName

Returns

object —

addListener()

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

Adds an event listener that listens on the specified events.

Parameters

string	$eventName
mixed	$listener
int	$priority	The higher this value, the earlier an event listener will be triggered in the chain (defaults to 0)

Returns

mixed —

addSubscriber()

addSubscriber(\Symfony\Component\EventDispatcher\EventSubscriberInterface  $subscriber) : mixed

Adds an event subscriber.

Parameters

\Symfony\Component\EventDispatcher\EventSubscriberInterface

$subscriber

Returns

mixed —

removeListener()

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

Removes an event listener from the specified events.

Parameters

string	$eventName
mixed	$listener

Returns

mixed —

removeSubscriber()

removeSubscriber(\Symfony\Component\EventDispatcher\EventSubscriberInterface  $subscriber) : mixed

Parameters

\Symfony\Component\EventDispatcher\EventSubscriberInterface

$subscriber

Returns

mixed —

getListeners()

getListeners(string  $eventName = null) : (callable[]|callable)[]

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

Parameters

string

$eventName

Returns

(callable[]|callable)[] —

getListenerPriority()

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

Gets the listener priority for a specific event.

Parameters

string	$eventName
mixed	$listener

Returns

int|null —

hasListeners()

hasListeners(string  $eventName = null) : bool

Checks whether an event has any registered listeners.

Parameters

string

$eventName

Returns

bool —