Symfony\Component\EventDispatcher\EventDispatcherInterface Interface Reference

Inheritance diagram for Symfony\Component\EventDispatcher\EventDispatcherInterface:

Public Member Functions
	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)
	getListeners ($eventName=null)
	getListeners ($eventName=null)
	hasListeners ($eventName=null)
	hasListeners ($eventName=null)
	removeListener ($eventName, $listener)
	removeListener ($eventName, $listener)
	removeSubscriber (EventSubscriberInterface $subscriber)
	removeSubscriber (EventSubscriberInterface $subscriber)

Detailed Description

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.

Author

Bernhard Schussek bschu.nosp@m.ssek.nosp@m.@gmai.nosp@m.l.co.nosp@m.m

Definition at line 21 of file lib/vendor/symfony/event-dispatcher/EventDispatcherInterface.php.

Member Function Documentation

addListener() [1/2]

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

Adds an event listener that listens on the specified events.

Parameters

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

Implemented in Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\ImmutableEventDispatcher, and Symfony\Component\EventDispatcher\ImmutableEventDispatcher.

addListener() [2/2]

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

Adds an event listener that listens on the specified events.

Parameters

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

Implemented in Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\ImmutableEventDispatcher, and Symfony\Component\EventDispatcher\ImmutableEventDispatcher.

addSubscriber() [1/2]

Symfony\Component\EventDispatcher\EventDispatcherInterface::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.

Implemented in Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\ImmutableEventDispatcher, and Symfony\Component\EventDispatcher\ImmutableEventDispatcher.

addSubscriber() [2/2]

Symfony\Component\EventDispatcher\EventDispatcherInterface::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.

Implemented in Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\ImmutableEventDispatcher, and Symfony\Component\EventDispatcher\ImmutableEventDispatcher.

dispatch() [1/2]

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

Dispatches an event to all registered listeners.

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

Returns

Event

Implemented in Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\ImmutableEventDispatcher, and Symfony\Component\EventDispatcher\ImmutableEventDispatcher.

dispatch() [2/2]

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

Dispatches an event to all registered listeners.

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

Returns

Event

Implemented in Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\ImmutableEventDispatcher, and Symfony\Component\EventDispatcher\ImmutableEventDispatcher.

getListeners() [1/2]

Symfony\Component\EventDispatcher\EventDispatcherInterface::getListeners

(

$eventName = null

)

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

Parameters

string

$eventName

The name of the event

Returns

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

Implemented in Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher, Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\ImmutableEventDispatcher, Symfony\Component\EventDispatcher\ImmutableEventDispatcher, Symfony\Component\EventDispatcher\EventDispatcher, and Symfony\Component\EventDispatcher\EventDispatcher.

getListeners() [2/2]

Symfony\Component\EventDispatcher\EventDispatcherInterface::getListeners

(

$eventName = null

)

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

Parameters

string

$eventName

The name of the event

Returns

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

Implemented in Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher, Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\ImmutableEventDispatcher, Symfony\Component\EventDispatcher\ImmutableEventDispatcher, Symfony\Component\EventDispatcher\EventDispatcher, and Symfony\Component\EventDispatcher\EventDispatcher.

hasListeners() [1/2]

Symfony\Component\EventDispatcher\EventDispatcherInterface::hasListeners

(

$eventName = null

)

Checks whether an event has any registered listeners.

Parameters

string

$eventName

The name of the event

Returns

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

Implemented in Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher, Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher, Symfony\Component\EventDispatcher\ImmutableEventDispatcher, and Symfony\Component\EventDispatcher\ImmutableEventDispatcher.

hasListeners() [2/2]

Symfony\Component\EventDispatcher\EventDispatcherInterface::hasListeners

(

$eventName = null

)

Checks whether an event has any registered listeners.

Parameters

string

$eventName

The name of the event

Returns

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

Implemented in Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher, Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher, Symfony\Component\EventDispatcher\ImmutableEventDispatcher, and Symfony\Component\EventDispatcher\ImmutableEventDispatcher.

removeListener() [1/2]

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

Removes an event listener from the specified events.

Parameters

string	$eventName	The event to remove a listener from
callable	$listener	The listener to remove

Implemented in Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\ImmutableEventDispatcher, and Symfony\Component\EventDispatcher\ImmutableEventDispatcher.

removeListener() [2/2]

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

Removes an event listener from the specified events.

Parameters

string	$eventName	The event to remove a listener from
callable	$listener	The listener to remove

Implemented in Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\ImmutableEventDispatcher, and Symfony\Component\EventDispatcher\ImmutableEventDispatcher.

removeSubscriber() [1/2]

Symfony\Component\EventDispatcher\EventDispatcherInterface::removeSubscriber

(

EventSubscriberInterface

$subscriber

)

Implemented in Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\ImmutableEventDispatcher, and Symfony\Component\EventDispatcher\ImmutableEventDispatcher.

removeSubscriber() [2/2]

Symfony\Component\EventDispatcher\EventDispatcherInterface::removeSubscriber

(

EventSubscriberInterface

$subscriber

)

Implemented in Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\EventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher, Symfony\Component\EventDispatcher\ImmutableEventDispatcher, and Symfony\Component\EventDispatcher\ImmutableEventDispatcher.

---

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

• lib/vendor/symfony/event-dispatcher/EventDispatcherInterface.php