W3cubDocs

/Symfony 2.7

Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher

class ContainerAwareEventDispatcher extends EventDispatcher

Lazily loads listeners and subscribers from the dependency injection container

Methods

Event dispatch(string $eventName, Event $event = null)
array getListeners(string $eventName = null)
bool hasListeners(string $eventName = null)
addListener(string $eventName, callable $listener, int $priority) from EventDispatcher
removeListener(string $eventName, callable $listener)
addSubscriber(EventSubscriberInterface $subscriber) from EventDispatcher
removeSubscriber(EventSubscriberInterface $subscriber) from EventDispatcher
__construct(ContainerInterface $container)

Constructor.
addListenerService(string $eventName, array $callback, int $priority)

Adds a service as event listener
addSubscriberService(string $serviceId, string $class)

Adds a service as event subscriber
getContainer()

Details

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

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

public bool hasListeners(string $eventName = null)

Parameters

string $eventName The name of the event

Return Value

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

See also

EventDispatcherInterface::hasListeners

public addListener(string $eventName, callable $listener, int $priority)

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)

See also

EventDispatcherInterface::addListener

public removeListener(string $eventName, callable $listener)

Parameters

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

public addSubscriber(EventSubscriberInterface $subscriber)

Parameters

EventSubscriberInterface $subscriber The subscriber.

See also

EventDispatcherInterface::addSubscriber

public removeSubscriber(EventSubscriberInterface $subscriber)

Parameters

EventSubscriberInterface $subscriber The subscriber

See also

EventDispatcherInterface::removeSubscriber

public __construct(ContainerInterface $container)

Constructor.

Parameters

ContainerInterface $container A ContainerInterface instance

public addListenerService(string $eventName, array $callback, int $priority)

Adds a service as event listener

Parameters

string $eventName Event for which the listener is added
array $callback The service ID of the listener service & the method name that has to be called
int $priority The higher this value, the earlier an event listener will be triggered in the chain. Defaults to 0.

Exceptions

InvalidArgumentException

public addSubscriberService(string $serviceId, string $class)

Adds a service as event subscriber

Parameters

string $serviceId The service ID of the subscriber service
string $class The service's class name (which must implement EventSubscriberInterface)

public getContainer()

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/EventDispatcher/ContainerAwareEventDispatcher.html