vendor/symfony/symfony/src/Symfony/Component/EventDispatcher/Debug/TraceableEventDispatcher.php line 139

Open in your IDE?
  1. <?php
  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.  */
  12. namespace Symfony\Component\EventDispatcher\Debug;
  14. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  15. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  16. use Symfony\Component\EventDispatcher\Event;
  17. use Symfony\Component\Stopwatch\Stopwatch;
  18. use Psr\Log\LoggerInterface;
  20. /**
  21.  * Collects some data about event listeners.
  22.  *
  23.  * This event dispatcher delegates the dispatching to another one.
  24.  *
  25.  * @author Fabien Potencier <fabien@symfony.com>
  26.  */
  27. class TraceableEventDispatcher implements TraceableEventDispatcherInterface
  28. {
  29.     protected $logger;
  30.     protected $stopwatch;
  32.     private $called;
  33.     private $dispatcher;
  34.     private $wrappedListeners;
  36.     public function __construct(EventDispatcherInterface $dispatcher, Stopwatch $stopwatch, LoggerInterface $logger = null)
  37.     {
  38.         $this->dispatcher = $dispatcher;
  39.         $this->stopwatch = $stopwatch;
  40.         $this->logger = $logger;
  41.         $this->called = array();
  42.         $this->wrappedListeners = array();
  43.     }
  45.     /**
  46.      * {@inheritdoc}
  47.      */
  48.     public function addListener($eventName, $listener, $priority = 0)
  49.     {
  50.         $this->dispatcher->addListener($eventName, $listener, $priority);
  51.     }
  53.     /**
  54.      * {@inheritdoc}
  55.      */
  56.     public function addSubscriber(EventSubscriberInterface $subscriber)
  57.     {
  58.         $this->dispatcher->addSubscriber($subscriber);
  59.     }
  61.     /**
  62.      * {@inheritdoc}
  63.      */
  64.     public function removeListener($eventName, $listener)
  65.     {
  66.         if (isset($this->wrappedListeners[$eventName])) {
  67.             foreach ($this->wrappedListeners[$eventName] as $index => $wrappedListener) {
  68.                 if ($wrappedListener->getWrappedListener() === $listener) {
  69.                     $listener = $wrappedListener;
  70.                     unset($this->wrappedListeners[$eventName][$index]);
  71.                     break;
  72.                 }
  73.             }
  74.         }
  76.         return $this->dispatcher->removeListener($eventName, $listener);
  77.     }
  79.     /**
  80.      * {@inheritdoc}
  81.      */
  82.     public function removeSubscriber(EventSubscriberInterface $subscriber)
  83.     {
  84.         return $this->dispatcher->removeSubscriber($subscriber);
  85.     }
  87.     /**
  88.      * {@inheritdoc}
  89.      */
  90.     public function getListeners($eventName = null)
  91.     {
  92.         return $this->dispatcher->getListeners($eventName);
  93.     }
  95.     /**
  96.      * {@inheritdoc}
  97.      */
  98.     public function getListenerPriority($eventName, $listener)
  99.     {
  100.         // we might have wrapped listeners for the event (if called while dispatching)
  101.         // in that case get the priority by wrapper
  102.         if (isset($this->wrappedListeners[$eventName])) {
  103.             foreach ($this->wrappedListeners[$eventName] as $index => $wrappedListener) {
  104.                 if ($wrappedListener->getWrappedListener() === $listener) {
  105.                     return $this->dispatcher->getListenerPriority($eventName, $wrappedListener);
  106.                 }
  107.             }
  108.         }
  110.         return $this->dispatcher->getListenerPriority($eventName, $listener);
  111.     }
  113.     /**
  114.      * {@inheritdoc}
  115.      */
  116.     public function hasListeners($eventName = null)
  117.     {
  118.         return $this->dispatcher->hasListeners($eventName);
  119.     }
  121.     /**
  122.      * {@inheritdoc}
  123.      */
  124.     public function dispatch($eventName, Event $event = null)
  125.     {
  126.         if (null === $event) {
  127.             $event = new Event();
  128.         }
  130.         if (null !== $this->logger && $event->isPropagationStopped()) {
  131.             $this->logger->debug(sprintf('The "%s" event is already stopped. No listeners have been called.', $eventName));
  132.         }
  134.         $this->preProcess($eventName);
  135.         $this->preDispatch($eventName, $event);
  137.         $e = $this->stopwatch->start($eventName, 'section');
  139.         $this->dispatcher->dispatch($eventName, $event);
  141.         if ($e->isStarted()) {
  142.             $e->stop();
  143.         }
  145.         $this->postDispatch($eventName, $event);
  146.         $this->postProcess($eventName);
  148.         return $event;
  149.     }
  151.     /**
  152.      * {@inheritdoc}
  153.      */
  154.     public function getCalledListeners()
  155.     {
  156.         $called = array();
  157.         foreach ($this->called as $eventName => $listeners) {
  158.             foreach ($listeners as $listener) {
  159.                 $called[$eventName.'.'.$listener->getPretty()] = $listener->getInfo($eventName);
  160.             }
  161.         }
  163.         return $called;
  164.     }
  166.     /**
  167.      * {@inheritdoc}
  168.      */
  169.     public function getNotCalledListeners()
  170.     {
  171.         try {
  172.             $allListeners = $this->getListeners();
  173.         } catch (\Exception $e) {
  174.             if (null !== $this->logger) {
  175.                 $this->logger->info('An exception was thrown while getting the uncalled listeners.', array('exception' => $e));
  176.             }
  178.             // unable to retrieve the uncalled listeners
  179.             return array();
  180.         }
  182.         $notCalled = array();
  183.         foreach ($allListeners as $eventName => $listeners) {
  184.             foreach ($listeners as $listener) {
  185.                 $called = false;
  186.                 if (isset($this->called[$eventName])) {
  187.                     foreach ($this->called[$eventName] as $l) {
  188.                         if ($l->getWrappedListener() === $listener) {
  189.                             $called = true;
  191.                             break;
  192.                         }
  193.                     }
  194.                 }
  196.                 if (!$called) {
  197.                     if (!$listener instanceof WrappedListener) {
  198.                         $listener = new WrappedListener($listener, null, $this->stopwatch, $this);
  199.                     }
  200.                     $notCalled[$eventName.'.'.$listener->getPretty()] = $listener->getInfo($eventName);
  201.                 }
  202.             }
  203.         }
  205.         uasort($notCalled, array($this, 'sortListenersByPriority'));
  207.         return $notCalled;
  208.     }
  210.     /**
  211.      * Proxies all method calls to the original event dispatcher.
  212.      *
  213.      * @param string $method    The method name
  214.      * @param array  $arguments The method arguments
  215.      *
  216.      * @return mixed
  217.      */
  218.     public function __call($method, $arguments)
  219.     {
  220.         return call_user_func_array(array($this->dispatcher, $method), $arguments);
  221.     }
  223.     /**
  224.      * Called before dispatching the event.
  225.      *
  226.      * @param string $eventName The event name
  227.      * @param Event  $event     The event
  228.      */
  229.     protected function preDispatch($eventName, Event $event)
  230.     {
  231.     }
  233.     /**
  234.      * Called after dispatching the event.
  235.      *
  236.      * @param string $eventName The event name
  237.      * @param Event  $event     The event
  238.      */
  239.     protected function postDispatch($eventName, Event $event)
  240.     {
  241.     }
  243.     private function preProcess($eventName)
  244.     {
  245.         foreach ($this->dispatcher->getListeners($eventName) as $listener) {
  246.             $priority = $this->getListenerPriority($eventName, $listener);
  247.             $wrappedListener = new WrappedListener($listener, null, $this->stopwatch, $this);
  248.             $this->wrappedListeners[$eventName][] = $wrappedListener;
  249.             $this->dispatcher->removeListener($eventName, $listener);
  250.             $this->dispatcher->addListener($eventName, $wrappedListener, $priority);
  251.         }
  252.     }
  254.     private function postProcess($eventName)
  255.     {
  256.         unset($this->wrappedListeners[$eventName]);
  257.         $skipped = false;
  258.         foreach ($this->dispatcher->getListeners($eventName) as $listener) {
  259.             if (!$listener instanceof WrappedListener) { // #12845: a new listener was added during dispatch.
  260.                 continue;
  261.             }
  262.             // Unwrap listener
  263.             $priority = $this->getListenerPriority($eventName, $listener);
  264.             $this->dispatcher->removeListener($eventName, $listener);
  265.             $this->dispatcher->addListener($eventName, $listener->getWrappedListener(), $priority);
  267.             if (null !== $this->logger) {
  268.                 $context = array('event' => $eventName, 'listener' => $listener->getPretty());
  269.             }
  271.             if ($listener->wasCalled()) {
  272.                 if (null !== $this->logger) {
  273.                     $this->logger->debug('Notified event "{event}" to listener "{listener}".', $context);
  274.                 }
  276.                 if (!isset($this->called[$eventName])) {
  277.                     $this->called[$eventName] = new \SplObjectStorage();
  278.                 }
  280.                 $this->called[$eventName]->attach($listener);
  281.             }
  283.             if (null !== $this->logger && $skipped) {
  284.                 $this->logger->debug('Listener "{listener}" was not called for event "{event}".', $context);
  285.             }
  287.             if ($listener->stoppedPropagation()) {
  288.                 if (null !== $this->logger) {
  289.                     $this->logger->debug('Listener "{listener}" stopped propagation of the event "{event}".', $context);
  290.                 }
  292.                 $skipped = true;
  293.             }
  294.         }
  295.     }
  297.     private function sortListenersByPriority($a, $b)
  298.     {
  299.         if (is_int($a['priority']) && !is_int($b['priority'])) {
  300.             return 1;
  301.         }
  303.         if (!is_int($a['priority']) && is_int($b['priority'])) {
  304.             return -1;
  305.         }
  307.         if ($a['priority'] === $b['priority']) {
  308.             return 0;
  309.         }
  311.         if ($a['priority'] > $b['priority']) {
  312.             return -1;
  313.         }
  315.         return 1;
  316.     }
  317. }