vendor/symfony/http-kernel/EventListener/ProfilerListener.php line 89

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\EventListener;
  14. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  15. use Symfony\Component\HttpFoundation\RequestMatcherInterface;
  16. use Symfony\Component\HttpFoundation\RequestStack;
  17. use Symfony\Component\HttpKernel\Event\ExceptionEvent;
  18. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  19. use Symfony\Component\HttpKernel\Event\TerminateEvent;
  20. use Symfony\Component\HttpKernel\KernelEvents;
  21. use Symfony\Component\HttpKernel\Profiler\Profiler;
  23. /**
  24.  * ProfilerListener collects data for the current request by listening to the kernel events.
  25.  *
  26.  * @author Fabien Potencier <fabien@symfony.com>
  27.  *
  28.  * @final
  29.  */
  30. class ProfilerListener implements EventSubscriberInterface
  31. {
  32.     protected $profiler;
  33.     protected $matcher;
  34.     protected $onlyException;
  35.     protected $onlyMainRequests;
  36.     protected $exception;
  37.     protected $profiles;
  38.     protected $requestStack;
  39.     protected $parents;
  41.     /**
  42.      * @param bool $onlyException    True if the profiler only collects data when an exception occurs, false otherwise
  43.      * @param bool $onlyMainRequests True if the profiler only collects data when the request is the main request, false otherwise
  44.      */
  45.     public function __construct(Profiler $profiler, RequestStack $requestStack, RequestMatcherInterface $matcher = null, bool $onlyException = false, bool $onlyMainRequests = false)
  46.     {
  47.         $this->profiler = $profiler;
  48.         $this->matcher = $matcher;
  49.         $this->onlyException = $onlyException;
  50.         $this->onlyMainRequests = $onlyMainRequests;
  51.         $this->profiles = new \SplObjectStorage();
  52.         $this->parents = new \SplObjectStorage();
  53.         $this->requestStack = $requestStack;
  54.     }
  56.     /**
  57.      * Handles the onKernelException event.
  58.      */
  59.     public function onKernelException(ExceptionEvent $event)
  60.     {
  61.         if ($this->onlyMainRequests && !$event->isMainRequest()) {
  62.             return;
  63.         }
  65.         $this->exception = $event->getThrowable();
  66.     }
  68.     /**
  69.      * Handles the onKernelResponse event.
  70.      */
  71.     public function onKernelResponse(ResponseEvent $event)
  72.     {
  73.         if ($this->onlyMainRequests && !$event->isMainRequest()) {
  74.             return;
  75.         }
  77.         if ($this->onlyException && null === $this->exception) {
  78.             return;
  79.         }
  81.         $request = $event->getRequest();
  82.         $exception = $this->exception;
  83.         $this->exception = null;
  85.         if (null !== $this->matcher && !$this->matcher->matches($request)) {
  86.             return;
  87.         }
  89.         if (!$profile = $this->profiler->collect($request, $event->getResponse(), $exception)) {
  90.             return;
  91.         }
  93.         $this->profiles[$request] = $profile;
  95.         $this->parents[$request] = $this->requestStack->getParentRequest();
  96.     }
  98.     public function onKernelTerminate(TerminateEvent $event)
  99.     {
  100.         // attach children to parents
  101.         foreach ($this->profiles as $request) {
  102.             if (null !== $parentRequest = $this->parents[$request]) {
  103.                 if (isset($this->profiles[$parentRequest])) {
  104.                     $this->profiles[$parentRequest]->addChild($this->profiles[$request]);
  105.                 }
  106.             }
  107.         }
  109.         // save profiles
  110.         foreach ($this->profiles as $request) {
  111.             $this->profiler->saveProfile($this->profiles[$request]);
  112.         }
  114.         $this->profiles = new \SplObjectStorage();
  115.         $this->parents = new \SplObjectStorage();
  116.     }
  118.     public static function getSubscribedEvents(): array
  119.     {
  120.         return [
  121.             KernelEvents::RESPONSE => ['onKernelResponse', -100],
  122.             KernelEvents::EXCEPTION => ['onKernelException', 0],
  123.             KernelEvents::TERMINATE => ['onKernelTerminate', -1024],
  124.         ];
  125.     }
  126. }