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

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 $onlyMasterRequests;
  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 $onlyMasterRequests True if the profiler only collects data when the request is a master request, false otherwise
  44.      */
  45.     public function __construct(Profiler $profiler, RequestStack $requestStack, RequestMatcherInterface $matcher = null, bool $onlyException = false, bool $onlyMasterRequests = false)
  46.     {
  47.         $this->profiler = $profiler;
  48.         $this->matcher = $matcher;
  49.         $this->onlyException = $onlyException;
  50.         $this->onlyMasterRequests = $onlyMasterRequests;
  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->onlyMasterRequests && !$event->isMasterRequest()) {
  62.             return;
  63.         }
  65.         $this->exception = $event->getThrowable();
  66.     }
  68.     /**
  69.      * Handles the onKernelResponse event.
  70.      */
  71.     public function onKernelResponse(ResponseEvent $event)
  72.     {
  73.         $master = $event->isMasterRequest();
  74.         if ($this->onlyMasterRequests && !$master) {
  75.             return;
  76.         }
  78.         if ($this->onlyException && null === $this->exception) {
  79.             return;
  80.         }
  82.         $request = $event->getRequest();
  83.         $exception = $this->exception;
  84.         $this->exception = null;
  86.         if (null !== $this->matcher && !$this->matcher->matches($request)) {
  87.             return;
  88.         }
  90.         if (!$profile = $this->profiler->collect($request, $event->getResponse(), $exception)) {
  91.             return;
  92.         }
  94.         $this->profiles[$request] = $profile;
  96.         $this->parents[$request] = $this->requestStack->getParentRequest();
  97.     }
  99.     public function onKernelTerminate(TerminateEvent $event)
  100.     {
  101.         // attach children to parents
  102.         foreach ($this->profiles as $request) {
  103.             if (null !== $parentRequest = $this->parents[$request]) {
  104.                 if (isset($this->profiles[$parentRequest])) {
  105.                     $this->profiles[$parentRequest]->addChild($this->profiles[$request]);
  106.                 }
  107.             }
  108.         }
  110.         // save profiles
  111.         foreach ($this->profiles as $request) {
  112.             $this->profiler->saveProfile($this->profiles[$request]);
  113.         }
  115.         $this->profiles = new \SplObjectStorage();
  116.         $this->parents = new \SplObjectStorage();
  117.     }
  119.     public static function getSubscribedEvents(): array
  120.     {
  121.         return [
  122.             KernelEvents::RESPONSE => ['onKernelResponse', -100],
  123.             KernelEvents::EXCEPTION => ['onKernelException', 0],
  124.             KernelEvents::TERMINATE => ['onKernelTerminate', -1024],
  125.         ];
  126.     }
  127. }