vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php line 141

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <[email protected]>
  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 Psr\Log\LoggerInterface;
  15. use Symfony\Component\EventDispatcher\Event;
  16. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  17. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. use Symfony\Component\Stopwatch\Stopwatch;
  20. /**
  21.  * Collects some data about event listeners.
  22.  *
  23.  * This event dispatcher delegates the dispatching to another one.
  24.  *
  25.  * @author Fabien Potencier <[email protected]>
  26.  */
  27. class TraceableEventDispatcher implements TraceableEventDispatcherInterface
  28. {
  29.     protected $logger;
  30.     protected $stopwatch;
  32.     private $called;
  33.     private $dispatcher;
  34.     private $wrappedListeners;
  35.     private $orphanedEvents;
  37.     public function __construct(EventDispatcherInterface $dispatcher, Stopwatch $stopwatch, LoggerInterface $logger = null)
  38.     {
  39.         $this->dispatcher = $dispatcher;
  40.         $this->stopwatch = $stopwatch;
  41.         $this->logger = $logger;
  42.         $this->called = array();
  43.         $this->wrappedListeners = array();
  44.         $this->orphanedEvents = array();
  45.     }
  47.     /**
  48.      * {@inheritdoc}
  49.      */
  50.     public function addListener($eventName, $listener, $priority = 0)
  51.     {
  52.         $this->dispatcher->addListener($eventName, $listener, $priority);
  53.     }
  55.     /**
  56.      * {@inheritdoc}
  57.      */
  58.     public function addSubscriber(EventSubscriberInterface $subscriber)
  59.     {
  60.         $this->dispatcher->addSubscriber($subscriber);
  61.     }
  63.     /**
  64.      * {@inheritdoc}
  65.      */
  66.     public function removeListener($eventName, $listener)
  67.     {
  68.         if (isset($this->wrappedListeners[$eventName])) {
  69.             foreach ($this->wrappedListeners[$eventName] as $index => $wrappedListener) {
  70.                 if ($wrappedListener->getWrappedListener() === $listener) {
  71.                     $listener = $wrappedListener;
  72.                     unset($this->wrappedListeners[$eventName][$index]);
  73.                     break;
  74.                 }
  75.             }
  76.         }
  78.         return $this->dispatcher->removeListener($eventName, $listener);
  79.     }
  81.     /**
  82.      * {@inheritdoc}
  83.      */
  84.     public function removeSubscriber(EventSubscriberInterface $subscriber)
  85.     {
  86.         return $this->dispatcher->removeSubscriber($subscriber);
  87.     }
  89.     /**
  90.      * {@inheritdoc}
  91.      */
  92.     public function getListeners($eventName = null)
  93.     {
  94.         return $this->dispatcher->getListeners($eventName);
  95.     }
  97.     /**
  98.      * {@inheritdoc}
  99.      */
  100.     public function getListenerPriority($eventName, $listener)
  101.     {
  102.         // we might have wrapped listeners for the event (if called while dispatching)
  103.         // in that case get the priority by wrapper
  104.         if (isset($this->wrappedListeners[$eventName])) {
  105.             foreach ($this->wrappedListeners[$eventName] as $index => $wrappedListener) {
  106.                 if ($wrappedListener->getWrappedListener() === $listener) {
  107.                     return $this->dispatcher->getListenerPriority($eventName, $wrappedListener);
  108.                 }
  109.             }
  110.         }
  112.         return $this->dispatcher->getListenerPriority($eventName, $listener);
  113.     }
  115.     /**
  116.      * {@inheritdoc}
  117.      */
  118.     public function hasListeners($eventName = null)
  119.     {
  120.         return $this->dispatcher->hasListeners($eventName);
  121.     }
  123.     /**
  124.      * {@inheritdoc}
  125.      */
  126.     public function dispatch($eventName, Event $event = null)
  127.     {
  128.         if (null === $event) {
  129.             $event = new Event();
  130.         }
  132.         if (null !== $this->logger && $event->isPropagationStopped()) {
  133.             $this->logger->debug(sprintf('The "%s" event is already stopped. No listeners have been called.', $eventName));
  134.         }
  136.         $this->preProcess($eventName);
  137.         $this->preDispatch($eventName, $event);
  139.         $e = $this->stopwatch->start($eventName, 'section');
  141.         $this->dispatcher->dispatch($eventName, $event);
  143.         if ($e->isStarted()) {
  144.             $e->stop();
  145.         }
  147.         $this->postDispatch($eventName, $event);
  148.         $this->postProcess($eventName);
  150.         return $event;
  151.     }
  153.     /**
  154.      * {@inheritdoc}
  155.      */
  156.     public function getCalledListeners()
  157.     {
  158.         $called = array();
  159.         foreach ($this->called as $eventName => $listeners) {
  160.             foreach ($listeners as $listener) {
  161.                 $called[$eventName.'.'.$listener->getPretty()] = $listener->getInfo($eventName);
  162.             }
  163.         }
  165.         return $called;
  166.     }
  168.     /**
  169.      * {@inheritdoc}
  170.      */
  171.     public function getNotCalledListeners()
  172.     {
  173.         try {
  174.             $allListeners = $this->getListeners();
  175.         } catch (\Exception $e) {
  176.             if (null !== $this->logger) {
  177.                 $this->logger->info('An exception was thrown while getting the uncalled listeners.', array('exception' => $e));
  178.             }
  180.             // unable to retrieve the uncalled listeners
  181.             return array();
  182.         }
  184.         $notCalled = array();
  185.         foreach ($allListeners as $eventName => $listeners) {
  186.             foreach ($listeners as $listener) {
  187.                 $called = false;
  188.                 if (isset($this->called[$eventName])) {
  189.                     foreach ($this->called[$eventName] as $l) {
  190.                         if ($l->getWrappedListener() === $listener) {
  191.                             $called = true;
  193.                             break;
  194.                         }
  195.                     }
  196.                 }
  198.                 if (!$called) {
  199.                     if (!$listener instanceof WrappedListener) {
  200.                         $listener = new WrappedListener($listener, null, $this->stopwatch, $this);
  201.                     }
  202.                     $notCalled[$eventName.'.'.$listener->getPretty()] = $listener->getInfo($eventName);
  203.                 }
  204.             }
  205.         }
  207.         uasort($notCalled, array($this, 'sortListenersByPriority'));
  209.         return $notCalled;
  210.     }
  212.     public function getOrphanedEvents(): array
  213.     {
  214.         return $this->orphanedEvents;
  215.     }
  217.     public function reset()
  218.     {
  219.         $this->called = array();
  220.         $this->orphanedEvents = array();
  221.     }
  223.     /**
  224.      * Proxies all method calls to the original event dispatcher.
  225.      *
  226.      * @param string $method    The method name
  227.      * @param array  $arguments The method arguments
  228.      *
  229.      * @return mixed
  230.      */
  231.     public function __call($method, $arguments)
  232.     {
  233.         return \call_user_func_array(array($this->dispatcher, $method), $arguments);
  234.     }
  236.     /**
  237.      * Called before dispatching the event.
  238.      *
  239.      * @param string $eventName The event name
  240.      * @param Event  $event     The event
  241.      */
  242.     protected function preDispatch($eventName, Event $event)
  243.     {
  244.     }
  246.     /**
  247.      * Called after dispatching the event.
  248.      *
  249.      * @param string $eventName The event name
  250.      * @param Event  $event     The event
  251.      */
  252.     protected function postDispatch($eventName, Event $event)
  253.     {
  254.     }
  256.     private function preProcess($eventName)
  257.     {
  258.         if (!$this->dispatcher->hasListeners($eventName)) {
  259.             $this->orphanedEvents[] = $eventName;
  261.             return;
  262.         }
  264.         foreach ($this->dispatcher->getListeners($eventName) as $listener) {
  265.             $priority = $this->getListenerPriority($eventName, $listener);
  266.             $wrappedListener = new WrappedListener($listener, null, $this->stopwatch, $this);
  267.             $this->wrappedListeners[$eventName][] = $wrappedListener;
  268.             $this->dispatcher->removeListener($eventName, $listener);
  269.             $this->dispatcher->addListener($eventName, $wrappedListener, $priority);
  270.         }
  271.     }
  273.     private function postProcess($eventName)
  274.     {
  275.         unset($this->wrappedListeners[$eventName]);
  276.         $skipped = false;
  277.         foreach ($this->dispatcher->getListeners($eventName) as $listener) {
  278.             if (!$listener instanceof WrappedListener) { // #12845: a new listener was added during dispatch.
  279.                 continue;
  280.             }
  281.             // Unwrap listener
  282.             $priority = $this->getListenerPriority($eventName, $listener);
  283.             $this->dispatcher->removeListener($eventName, $listener);
  284.             $this->dispatcher->addListener($eventName, $listener->getWrappedListener(), $priority);
  286.             if (null !== $this->logger) {
  287.                 $context = array('event' => $eventName, 'listener' => $listener->getPretty());
  288.             }
  290.             if ($listener->wasCalled()) {
  291.                 if (null !== $this->logger) {
  292.                     $this->logger->debug('Notified event "{event}" to listener "{listener}".', $context);
  293.                 }
  295.                 if (!isset($this->called[$eventName])) {
  296.                     $this->called[$eventName] = new \SplObjectStorage();
  297.                 }
  299.                 $this->called[$eventName]->attach($listener);
  300.             }
  302.             if (null !== $this->logger && $skipped) {
  303.                 $this->logger->debug('Listener "{listener}" was not called for event "{event}".', $context);
  304.             }
  306.             if ($listener->stoppedPropagation()) {
  307.                 if (null !== $this->logger) {
  308.                     $this->logger->debug('Listener "{listener}" stopped propagation of the event "{event}".', $context);
  309.                 }
  311.                 $skipped = true;
  312.             }
  313.         }
  314.     }
  316.     private function sortListenersByPriority($a, $b)
  317.     {
  318.         if (\is_int($a['priority']) && !\is_int($b['priority'])) {
  319.             return 1;
  320.         }
  322.         if (!\is_int($a['priority']) && \is_int($b['priority'])) {
  323.             return -1;
  324.         }
  326.         if ($a['priority'] === $b['priority']) {
  327.             return 0;
  328.         }
  330.         if ($a['priority'] > $b['priority']) {
  331.             return -1;
  332.         }
  334.         return 1;
  335.     }
  336. }