TrackManiaControl/libs/Symfony/Component/EventDispatcher/ContainerAwareEventDispatcher.php

203 lines
6.4 KiB
PHP
Raw Permalink Normal View History

2014-02-18 18:15:12 +01:00
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\EventDispatcher;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* Lazily loads listeners and subscribers from the dependency injection
2015-01-19 11:11:45 +01:00
* container.
2014-02-18 18:15:12 +01:00
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Bernhard Schussek <bschussek@gmail.com>
* @author Jordan Alliot <jordan.alliot@gmail.com>
*/
class ContainerAwareEventDispatcher extends EventDispatcher
{
/**
2015-01-19 11:11:45 +01:00
* The container from where services are loaded.
*
2014-02-18 18:15:12 +01:00
* @var ContainerInterface
*/
private $container;
/**
2015-01-19 11:11:45 +01:00
* The service IDs of the event listeners and subscribers.
*
2014-02-18 18:15:12 +01:00
* @var array
*/
private $listenerIds = array();
/**
2015-01-19 11:11:45 +01:00
* The services registered as listeners.
*
2014-02-18 18:15:12 +01:00
* @var array
*/
private $listeners = array();
/**
* Constructor.
*
* @param ContainerInterface $container A ContainerInterface instance
*/
public function __construct(ContainerInterface $container)
{
$this->container = $container;
}
/**
2015-01-19 11:11:45 +01:00
* Adds a service as event listener.
2014-02-18 18:15:12 +01:00
*
* @param string $eventName Event for which the listener is added
* @param array $callback The service ID of the listener service & the method
2015-01-19 11:11:45 +01:00
* name that has to be called
* @param int $priority The higher this value, the earlier an event listener
* will be triggered in the chain.
* Defaults to 0.
2014-02-18 18:15:12 +01:00
*
* @throws \InvalidArgumentException
*/
public function addListenerService($eventName, $callback, $priority = 0)
{
if (!is_array($callback) || 2 !== count($callback)) {
throw new \InvalidArgumentException('Expected an array("service", "method") argument');
}
$this->listenerIds[$eventName][] = array($callback[0], $callback[1], $priority);
}
public function removeListener($eventName, $listener)
{
$this->lazyLoad($eventName);
2015-01-19 11:11:45 +01:00
if (isset($this->listenerIds[$eventName])) {
foreach ($this->listenerIds[$eventName] as $i => $args) {
list($serviceId, $method, $priority) = $args;
$key = $serviceId.'.'.$method;
if (isset($this->listeners[$eventName][$key]) && $listener === array($this->listeners[$eventName][$key], $method)) {
unset($this->listeners[$eventName][$key]);
if (empty($this->listeners[$eventName])) {
unset($this->listeners[$eventName]);
}
unset($this->listenerIds[$eventName][$i]);
if (empty($this->listenerIds[$eventName])) {
unset($this->listenerIds[$eventName]);
2014-02-18 18:15:12 +01:00
}
}
}
}
parent::removeListener($eventName, $listener);
}
/**
2015-01-19 11:11:45 +01:00
* @see EventDispatcherInterface::hasListeners()
2014-02-18 18:15:12 +01:00
*/
public function hasListeners($eventName = null)
{
if (null === $eventName) {
2015-01-19 11:11:45 +01:00
return (bool) count($this->listenerIds) || (bool) count($this->listeners);
2014-02-18 18:15:12 +01:00
}
if (isset($this->listenerIds[$eventName])) {
return true;
}
return parent::hasListeners($eventName);
}
/**
2015-01-19 11:11:45 +01:00
* @see EventDispatcherInterface::getListeners()
2014-02-18 18:15:12 +01:00
*/
public function getListeners($eventName = null)
{
if (null === $eventName) {
2015-06-19 18:51:09 +02:00
foreach ($this->listenerIds as $serviceEventName => $args) {
2014-02-18 18:15:12 +01:00
$this->lazyLoad($serviceEventName);
}
} else {
$this->lazyLoad($eventName);
}
return parent::getListeners($eventName);
}
/**
2015-01-19 11:11:45 +01:00
* Adds a service as event subscriber.
2014-02-18 18:15:12 +01:00
*
* @param string $serviceId The service ID of the subscriber service
* @param string $class The service's class name (which must implement EventSubscriberInterface)
*/
public function addSubscriberService($serviceId, $class)
{
foreach ($class::getSubscribedEvents() as $eventName => $params) {
if (is_string($params)) {
$this->listenerIds[$eventName][] = array($serviceId, $params, 0);
} elseif (is_string($params[0])) {
$this->listenerIds[$eventName][] = array($serviceId, $params[0], isset($params[1]) ? $params[1] : 0);
} else {
foreach ($params as $listener) {
$this->listenerIds[$eventName][] = array($serviceId, $listener[0], isset($listener[1]) ? $listener[1] : 0);
}
}
}
}
/**
2015-01-19 11:11:45 +01:00
* {@inheritdoc}
2014-02-18 18:15:12 +01:00
*
* Lazily loads listeners for this event from the dependency injection
* container.
*
* @throws \InvalidArgumentException if the service is not defined
*/
public function dispatch($eventName, Event $event = null)
{
$this->lazyLoad($eventName);
return parent::dispatch($eventName, $event);
}
public function getContainer()
{
return $this->container;
}
/**
* Lazily loads listeners for this event from the dependency injection
* container.
*
* @param 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.
*/
protected function lazyLoad($eventName)
{
if (isset($this->listenerIds[$eventName])) {
foreach ($this->listenerIds[$eventName] as $args) {
list($serviceId, $method, $priority) = $args;
$listener = $this->container->get($serviceId);
$key = $serviceId.'.'.$method;
if (!isset($this->listeners[$eventName][$key])) {
$this->addListener($eventName, array($listener, $method), $priority);
} elseif ($listener !== $this->listeners[$eventName][$key]) {
parent::removeListener($eventName, array($this->listeners[$eventName][$key], $method));
$this->addListener($eventName, array($listener, $method), $priority);
}
$this->listeners[$eventName][$key] = $listener;
}
}
}
}