The Container Aware Event Dispatcher
Edit this pageWarning: You are browsing the documentation for Symfony 3.3, which is no longer maintained.
Read the updated version of this page for Symfony 6.3 (the current stable version).
The Container Aware Event Dispatcher
3.3
The ContainerAwareEventDispatcher class has been deprecated in Symfony 3.3
and it will be removed in Symfony 4.0. Use EventDispatcher with
closure-proxy injection instead.
Introduction
The ContainerAwareEventDispatcher
is a special EventDispatcher implementation which is coupled to the
service container that is part of
the DependencyInjection component.
It allows services to be specified as event listeners making the EventDispatcher
extremely powerful.
Services are lazy loaded meaning the services attached as listeners will only be created if an event is dispatched that requires those listeners.
Setup
Setup is straightforward by injecting a ContainerInterface into the ContainerAwareEventDispatcher:
1 2 3 4 5
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher;
$container = new ContainerBuilder();
$dispatcher = new ContainerAwareEventDispatcher($container);Adding Listeners
The ContainerAwareEventDispatcher can either load specified services
directly or services that implement EventSubscriberInterface.
The following examples assume the service container has been loaded with any services that are mentioned.
Note
Services must be marked as public in the container.
Adding Services
To connect existing service definitions, use the
addListenerService()
method where the $callback is an array of array($serviceId, $methodName):
1
$dispatcher->addListenerService($eventName, array('foo', 'logListener'));Adding Subscriber Services
Event subscribers can be added using the addSubscriberService() method where the first argument is the service ID of the subscriber service, and the second argument is the service's class name (which must implement EventSubscriberInterface) as follows:
1 2 3 4
$dispatcher->addSubscriberService(
'kernel.store_subscriber',
'StoreSubscriber'
);The EventSubscriberInterface is exactly as you would expect:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\KernelEvents;
// ...
class StoreSubscriber implements EventSubscriberInterface
{
public static function getSubscribedEvents()
{
return array(
KernelEvents::RESPONSE => array(
array('onKernelResponsePre', 10),
array('onKernelResponsePost', 0),
),
'store.order' => array('onStoreOrder', 0),
);
}
public function onKernelResponsePre(FilterResponseEvent $event)
{
// ...
}
public function onKernelResponsePost(FilterResponseEvent $event)
{
// ...
}
public function onStoreOrder(FilterOrderEvent $event)
{
// ...
}
}
