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

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 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 <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;
  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.         try {
  138.             $this->preDispatch($eventName, $event);
  139.             try {
  140.                 $e = $this->stopwatch->start($eventName, 'section');
  141.                 try {
  142.                     $this->dispatcher->dispatch($eventName, $event);
  143.                 } finally {
  144.                     if ($e->isStarted()) {
  145.                         $e->stop();
  146.                     }
  147.                 }
  148.             } finally {
  149.                 $this->postDispatch($eventName, $event);
  150.             }
  151.         } finally {
  152.             $this->postProcess($eventName);
  153.         }
  155.         return $event;
  156.     }
  158.     /**
  159.      * {@inheritdoc}
  160.      */
  161.     public function getCalledListeners()
  162.     {
  163.         $called = array();
  164.         foreach ($this->called as $eventName => $listeners) {
  165.             foreach ($listeners as $listener) {
  166.                 $called[$eventName.'.'.$listener->getPretty()] = $listener->getInfo($eventName);
  167.             }
  168.         }
  170.         return $called;
  171.     }
  173.     /**
  174.      * {@inheritdoc}
  175.      */
  176.     public function getNotCalledListeners()
  177.     {
  178.         try {
  179.             $allListeners = $this->getListeners();
  180.         } catch (\Exception $e) {
  181.             if (null !== $this->logger) {
  182.                 $this->logger->info('An exception was thrown while getting the uncalled listeners.', array('exception' => $e));
  183.             }
  185.             // unable to retrieve the uncalled listeners
  186.             return array();
  187.         }
  189.         $notCalled = array();
  190.         foreach ($allListeners as $eventName => $listeners) {
  191.             foreach ($listeners as $listener) {
  192.                 $called = false;
  193.                 if (isset($this->called[$eventName])) {
  194.                     foreach ($this->called[$eventName] as $l) {
  195.                         if ($l->getWrappedListener() === $listener) {
  196.                             $called = true;
  198.                             break;
  199.                         }
  200.                     }
  201.                 }
  203.                 if (!$called) {
  204.                     if (!$listener instanceof WrappedListener) {
  205.                         $listener = new WrappedListener($listener, null, $this->stopwatch, $this);
  206.                     }
  207.                     $notCalled[$eventName.'.'.$listener->getPretty()] = $listener->getInfo($eventName);
  208.                 }
  209.             }
  210.         }
  212.         uasort($notCalled, array($this, 'sortListenersByPriority'));
  214.         return $notCalled;
  215.     }
  217.     public function getOrphanedEvents(): array
  218.     {
  219.         return $this->orphanedEvents;
  220.     }
  222.     public function reset()
  223.     {
  224.         $this->called = array();
  225.         $this->orphanedEvents = array();
  226.     }
  228.     /**
  229.      * Proxies all method calls to the original event dispatcher.
  230.      *
  231.      * @param string $method    The method name
  232.      * @param array  $arguments The method arguments
  233.      *
  234.      * @return mixed
  235.      */
  236.     public function __call($method, $arguments)
  237.     {
  238.         return $this->dispatcher->{$method}(...$arguments);
  239.     }
  241.     /**
  242.      * Called before dispatching the event.
  243.      *
  244.      * @param string $eventName The event name
  245.      * @param Event  $event     The event
  246.      */
  247.     protected function preDispatch($eventName, Event $event)
  248.     {
  249.     }
  251.     /**
  252.      * Called after dispatching the event.
  253.      *
  254.      * @param string $eventName The event name
  255.      * @param Event  $event     The event
  256.      */
  257.     protected function postDispatch($eventName, Event $event)
  258.     {
  259.     }
  261.     private function preProcess($eventName)
  262.     {
  263.         if (!$this->dispatcher->hasListeners($eventName)) {
  264.             $this->orphanedEvents[] = $eventName;
  266.             return;
  267.         }
  269.         foreach ($this->dispatcher->getListeners($eventName) as $listener) {
  270.             $priority = $this->getListenerPriority($eventName, $listener);
  271.             $wrappedListener = new WrappedListener($listener instanceof WrappedListener ? $listener->getWrappedListener() : $listener, null, $this->stopwatch, $this);
  272.             $this->wrappedListeners[$eventName][] = $wrappedListener;
  273.             $this->dispatcher->removeListener($eventName, $listener);
  274.             $this->dispatcher->addListener($eventName, $wrappedListener, $priority);
  275.         }
  276.     }
  278.     private function postProcess($eventName)
  279.     {
  280.         unset($this->wrappedListeners[$eventName]);
  281.         $skipped = false;
  282.         foreach ($this->dispatcher->getListeners($eventName) as $listener) {
  283.             if (!$listener instanceof WrappedListener) { // #12845: a new listener was added during dispatch.
  284.                 continue;
  285.             }
  286.             // Unwrap listener
  287.             $priority = $this->getListenerPriority($eventName, $listener);
  288.             $this->dispatcher->removeListener($eventName, $listener);
  289.             $this->dispatcher->addListener($eventName, $listener->getWrappedListener(), $priority);
  291.             if (null !== $this->logger) {
  292.                 $context = array('event' => $eventName, 'listener' => $listener->getPretty());
  293.             }
  295.             if ($listener->wasCalled()) {
  296.                 if (null !== $this->logger) {
  297.                     $this->logger->debug('Notified event "{event}" to listener "{listener}".', $context);
  298.                 }
  300.                 if (!isset($this->called[$eventName])) {
  301.                     $this->called[$eventName] = new \SplObjectStorage();
  302.                 }
  304.                 $this->called[$eventName]->attach($listener);
  305.             }
  307.             if (null !== $this->logger && $skipped) {
  308.                 $this->logger->debug('Listener "{listener}" was not called for event "{event}".', $context);
  309.             }
  311.             if ($listener->stoppedPropagation()) {
  312.                 if (null !== $this->logger) {
  313.                     $this->logger->debug('Listener "{listener}" stopped propagation of the event "{event}".', $context);
  314.                 }
  316.                 $skipped = true;
  317.             }
  318.         }
  319.     }
  321.     private function sortListenersByPriority($a, $b)
  322.     {
  323.         if (\is_int($a['priority']) && !\is_int($b['priority'])) {
  324.             return 1;
  325.         }
  327.         if (!\is_int($a['priority']) && \is_int($b['priority'])) {
  328.             return -1;
  329.         }
  331.         if ($a['priority'] === $b['priority']) {
  332.             return 0;
  333.         }
  335.         if ($a['priority'] > $b['priority']) {
  336.             return -1;
  337.         }
  339.         return 1;
  340.     }
  341. }