www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony/event-dispatcher/ContainerAwareEventDispatcher.php

   1 <?php
   2
   3 /*
   4  * This file is part of the Symfony package.
   5  *
   6  * (c) Fabien Potencier <fabien@symfony.com>
   7  *
   8  * For the full copyright and license information, please view the LICENSE
   9  * file that was distributed with this source code.
  10  */
  11
  12 namespace Symfony\Component\EventDispatcher;
  13
  14 use Symfony\Component\DependencyInjection\ContainerInterface;
  15
  16 /**
  17  * Lazily loads listeners and subscribers from the dependency injection
  18  * container.
  19  *
  20  * @author Fabien Potencier <fabien@symfony.com>
  21  * @author Bernhard Schussek <bschussek@gmail.com>
  22  * @author Jordan Alliot <jordan.alliot@gmail.com>
  23  */
  24 class ContainerAwareEventDispatcher extends EventDispatcher
  25 {
  26     /**
  27      * The container from where services are loaded.
  28      *
  29      * @var ContainerInterface
  30      */
  31     private $container;
  32
  33     /**
  34      * The service IDs of the event listeners and subscribers.
  35      *
  36      * @var array
  37      */
  38     private $listenerIds = array();
  39
  40     /**
  41      * The services registered as listeners.
  42      *
  43      * @var array
  44      */
  45     private $listeners = array();
  46
  47     /**
  48      * Constructor.
  49      *
  50      * @param ContainerInterface $container A ContainerInterface instance
  51      */
  52     public function __construct(ContainerInterface $container)
  53     {
  54         $this->container = $container;
  55     }
  56
  57     /**
  58      * Adds a service as event listener.
  59      *
  60      * @param string $eventName Event for which the listener is added
  61      * @param array  $callback  The service ID of the listener service & the method
  62      *                          name that has to be called
  63      * @param int    $priority  The higher this value, the earlier an event listener
  64      *                          will be triggered in the chain.
  65      *                          Defaults to 0.
  66      *
  67      * @throws \InvalidArgumentException
  68      */
  69     public function addListenerService($eventName, $callback, $priority = 0)
  70     {
  71         if (!is_array($callback) || 2 !== count($callback)) {
  72             throw new \InvalidArgumentException('Expected an array("service", "method") argument');
  73         }
  74
  75         $this->listenerIds[$eventName][] = array($callback[0], $callback[1], $priority);
  76     }
  77
  78     public function removeListener($eventName, $listener)
  79     {
  80         $this->lazyLoad($eventName);
  81
  82         if (isset($this->listenerIds[$eventName])) {
  83             foreach ($this->listenerIds[$eventName] as $i => list($serviceId, $method, $priority)) {
  84                 $key = $serviceId.'.'.$method;
  85                 if (isset($this->listeners[$eventName][$key]) && $listener === array($this->listeners[$eventName][$key], $method)) {
  86                     unset($this->listeners[$eventName][$key]);
  87                     if (empty($this->listeners[$eventName])) {
  88                         unset($this->listeners[$eventName]);
  89                     }
  90                     unset($this->listenerIds[$eventName][$i]);
  91                     if (empty($this->listenerIds[$eventName])) {
  92                         unset($this->listenerIds[$eventName]);
  93                     }
  94                 }
  95             }
  96         }
  97
  98         parent::removeListener($eventName, $listener);
  99     }
 100
 101     /**
 102      * {@inheritdoc}
 103      */
 104     public function hasListeners($eventName = null)
 105     {
 106         if (null === $eventName) {
 107             return $this->listenerIds || $this->listeners || parent::hasListeners();
 108         }
 109
 110         if (isset($this->listenerIds[$eventName])) {
 111             return true;
 112         }
 113
 114         return parent::hasListeners($eventName);
 115     }
 116
 117     /**
 118      * {@inheritdoc}
 119      */
 120     public function getListeners($eventName = null)
 121     {
 122         if (null === $eventName) {
 123             foreach ($this->listenerIds as $serviceEventName => $args) {
 124                 $this->lazyLoad($serviceEventName);
 125             }
 126         } else {
 127             $this->lazyLoad($eventName);
 128         }
 129
 130         return parent::getListeners($eventName);
 131     }
 132
 133     /**
 134      * {@inheritdoc}
 135      */
 136     public function getListenerPriority($eventName, $listener)
 137     {
 138         $this->lazyLoad($eventName);
 139
 140         return parent::getListenerPriority($eventName, $listener);
 141     }
 142
 143     /**
 144      * Adds a service as event subscriber.
 145      *
 146      * @param string $serviceId The service ID of the subscriber service
 147      * @param string $class     The service's class name (which must implement EventSubscriberInterface)
 148      */
 149     public function addSubscriberService($serviceId, $class)
 150     {
 151         foreach ($class::getSubscribedEvents() as $eventName => $params) {
 152             if (is_string($params)) {
 153                 $this->listenerIds[$eventName][] = array($serviceId, $params, 0);
 154             } elseif (is_string($params[0])) {
 155                 $this->listenerIds[$eventName][] = array($serviceId, $params[0], isset($params[1]) ? $params[1] : 0);
 156             } else {
 157                 foreach ($params as $listener) {
 158                     $this->listenerIds[$eventName][] = array($serviceId, $listener[0], isset($listener[1]) ? $listener[1] : 0);
 159                 }
 160             }
 161         }
 162     }
 163
 164     public function getContainer()
 165     {
 166         return $this->container;
 167     }
 168
 169     /**
 170      * Lazily loads listeners for this event from the dependency injection
 171      * container.
 172      *
 173      * @param string $eventName The name of the event to dispatch. The name of
 174      *                          the event is the name of the method that is
 175      *                          invoked on listeners.
 176      */
 177     protected function lazyLoad($eventName)
 178     {
 179         if (isset($this->listenerIds[$eventName])) {
 180             foreach ($this->listenerIds[$eventName] as list($serviceId, $method, $priority)) {
 181                 $listener = $this->container->get($serviceId);
 182
 183                 $key = $serviceId.'.'.$method;
 184                 if (!isset($this->listeners[$eventName][$key])) {
 185                     $this->addListener($eventName, array($listener, $method), $priority);
 186                 } elseif ($listener !== $this->listeners[$eventName][$key]) {
 187                     parent::removeListener($eventName, array($this->listeners[$eventName][$key], $method));
 188                     $this->addListener($eventName, array($listener, $method), $priority);
 189                 }
 190
 191                 $this->listeners[$eventName][$key] = $listener;
 192             }
 193         }
 194     }
 195 }