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

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