Class

Symfony\Component\EventDispatcher\EventDispatcher

class EventDispatcher implements EventDispatcherInterface

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

Listeners are registered on the manager and events are dispatched through the manager.

Methods

Event dispatch(string $eventName, Event $event = null)

array getListeners(string $eventName = null)

Boolean hasListeners(string $eventName = null)

addListener(string $eventName, callable $listener, integer $priority)

removeListener(string|array $eventName, callable $listener)

addSubscriber(EventSubscriberInterface $subscriber)

removeSubscriber(EventSubscriberInterface $subscriber)

Details

at line 40
public Event dispatch(string $eventName, Event $event = null)

Parameters

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

Return Value

Event

See also

EventDispatcherInterface::dispatch

at line 61
public array getListeners(string $eventName = null)

Parameters

string $eventName The name of the event

Return Value

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

See also

EventDispatcherInterface::getListeners

at line 83
public Boolean hasListeners(string $eventName = null)

Parameters

string $eventName The name of the event

Return Value

Boolean true if the specified event has any listeners, false otherwise

See also

EventDispatcherInterface::hasListeners

at line 93
public addListener(string $eventName, callable $listener, integer $priority)

Parameters

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

See also

EventDispatcherInterface::addListener

at line 102
public removeListener(string|array $eventName, callable $listener)

Parameters

string|array $eventName The event(s) to remove a listener from
callable $listener The listener to remove

See also

EventDispatcherInterface::removeListener

at line 120
public addSubscriber(EventSubscriberInterface $subscriber)

Parameters

EventSubscriberInterface $subscriber The subscriber.

See also

EventDispatcherInterface::addSubscriber

at line 138
public removeSubscriber(EventSubscriberInterface $subscriber)

Parameters

EventSubscriberInterface $subscriber The subscriber

See also

EventDispatcherInterface::removeSubscriber