vendor/symfony/http-kernel/DataCollector/EventDataCollector.php line 62

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\HttpKernel\DataCollector;
  14. use Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\RequestStack;
  17. use Symfony\Component\HttpFoundation\Response;
  18. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  19. use Symfony\Contracts\Service\ResetInterface;
  21. /**
  22.  * EventDataCollector.
  23.  *
  24.  * @author Fabien Potencier <fabien@symfony.com>
  25.  *
  26.  * @final
  27.  */
  28. class EventDataCollector extends DataCollector implements LateDataCollectorInterface
  29. {
  30.     protected $dispatcher;
  31.     private $requestStack;
  32.     private $currentRequest;
  34.     public function __construct(EventDispatcherInterface $dispatcher = null, RequestStack $requestStack = null)
  35.     {
  36.         $this->dispatcher = $dispatcher;
  37.         $this->requestStack = $requestStack;
  38.     }
  40.     /**
  41.      * {@inheritdoc}
  42.      */
  43.     public function collect(Request $request, Response $response, \Throwable $exception = null)
  44.     {
  45.         $this->currentRequest = $this->requestStack && $this->requestStack->getMainRequest() !== $request ? $request : null;
  46.         $this->data = [
  47.             'called_listeners' => [],
  48.             'not_called_listeners' => [],
  49.             'orphaned_events' => [],
  50.         ];
  51.     }
  53.     public function reset()
  54.     {
  55.         $this->data = [];
  57.         if ($this->dispatcher instanceof ResetInterface) {
  58.             $this->dispatcher->reset();
  59.         }
  60.     }
  62.     public function lateCollect()
  63.     {
  64.         if ($this->dispatcher instanceof TraceableEventDispatcher) {
  65.             $this->setCalledListeners($this->dispatcher->getCalledListeners($this->currentRequest));
  66.             $this->setNotCalledListeners($this->dispatcher->getNotCalledListeners($this->currentRequest));
  67.             $this->setOrphanedEvents($this->dispatcher->getOrphanedEvents($this->currentRequest));
  68.         }
  70.         $this->data = $this->cloneVar($this->data);
  71.     }
  73.     /**
  74.      * Sets the called listeners.
  75.      *
  76.      * @param array $listeners An array of called listeners
  77.      *
  78.      * @see TraceableEventDispatcher
  79.      */
  80.     public function setCalledListeners(array $listeners)
  81.     {
  82.         $this->data['called_listeners'] = $listeners;
  83.     }
  85.     /**
  86.      * Gets the called listeners.
  87.      *
  88.      * @return array An array of called listeners
  89.      *
  90.      * @see TraceableEventDispatcher
  91.      */
  92.     public function getCalledListeners()
  93.     {
  94.         return $this->data['called_listeners'];
  95.     }
  97.     /**
  98.      * Sets the not called listeners.
  99.      *
  100.      * @see TraceableEventDispatcher
  101.      */
  102.     public function setNotCalledListeners(array $listeners)
  103.     {
  104.         $this->data['not_called_listeners'] = $listeners;
  105.     }
  107.     /**
  108.      * Gets the not called listeners.
  109.      *
  110.      * @return array
  111.      *
  112.      * @see TraceableEventDispatcher
  113.      */
  114.     public function getNotCalledListeners()
  115.     {
  116.         return $this->data['not_called_listeners'];
  117.     }
  119.     /**
  120.      * Sets the orphaned events.
  121.      *
  122.      * @param array $events An array of orphaned events
  123.      *
  124.      * @see TraceableEventDispatcher
  125.      */
  126.     public function setOrphanedEvents(array $events)
  127.     {
  128.         $this->data['orphaned_events'] = $events;
  129.     }
  131.     /**
  132.      * Gets the orphaned events.
  133.      *
  134.      * @return array An array of orphaned events
  135.      *
  136.      * @see TraceableEventDispatcher
  137.      */
  138.     public function getOrphanedEvents()
  139.     {
  140.         return $this->data['orphaned_events'];
  141.     }
  143.     /**
  144.      * {@inheritdoc}
  145.      */
  146.     public function getName()
  147.     {
  148.         return 'events';
  149.     }
  150. }