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

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <[email protected]>
  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\Request;
  16. use Symfony\Component\HttpFoundation\RequestMatcherInterface;
  17. use Symfony\Component\HttpFoundation\RequestStack;
  18. use Symfony\Component\HttpFoundation\Session\Session;
  19. use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
  20. use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
  21. use Symfony\Component\HttpKernel\Event\PostResponseEvent;
  22. use Symfony\Component\HttpKernel\KernelEvents;
  23. use Symfony\Component\HttpKernel\Profiler\Profiler;
  25. /**
  26.  * ProfilerListener collects data for the current request by listening to the kernel events.
  27.  *
  28.  * @author Fabien Potencier <[email protected]>
  29.  *
  30.  * @final since Symfony 4.3
  31.  */
  32. class ProfilerListener implements EventSubscriberInterface
  33. {
  34.     protected $profiler;
  35.     protected $matcher;
  36.     protected $onlyException;
  37.     protected $onlyMasterRequests;
  38.     protected $exception;
  39.     protected $profiles;
  40.     protected $requestStack;
  41.     protected $parents;
  43.     /**
  44.      * @param bool $onlyException      True if the profiler only collects data when an exception occurs, false otherwise
  45.      * @param bool $onlyMasterRequests True if the profiler only collects data when the request is a master request, false otherwise
  46.      */
  47.     public function __construct(Profiler $profiler, RequestStack $requestStack, RequestMatcherInterface $matcher = null, bool $onlyException = false, bool $onlyMasterRequests = false)
  48.     {
  49.         $this->profiler = $profiler;
  50.         $this->matcher = $matcher;
  51.         $this->onlyException = $onlyException;
  52.         $this->onlyMasterRequests = $onlyMasterRequests;
  53.         $this->profiles = new \SplObjectStorage();
  54.         $this->parents = new \SplObjectStorage();
  55.         $this->requestStack = $requestStack;
  56.     }
  58.     /**
  59.      * Handles the onKernelException event.
  60.      */
  61.     public function onKernelException(GetResponseForExceptionEvent $event)
  62.     {
  63.         if ($this->onlyMasterRequests && !$event->isMasterRequest()) {
  64.             return;
  65.         }
  67.         $this->exception = $event->getThrowable();
  68.     }
  70.     /**
  71.      * Handles the onKernelResponse event.
  72.      */
  73.     public function onKernelResponse(FilterResponseEvent $event)
  74.     {
  75.         $master = $event->isMasterRequest();
  76.         if ($this->onlyMasterRequests && !$master) {
  77.             return;
  78.         }
  80.         if ($this->onlyException && null === $this->exception) {
  81.             return;
  82.         }
  84.         $request = $event->getRequest();
  85.         $exception = $this->exception;
  86.         $this->exception = null;
  88.         if (null !== $this->matcher && !$this->matcher->matches($request)) {
  89.             return;
  90.         }
  92.         $session = method_exists(Request::class, 'getPreferredFormat') && $request->hasPreviousSession() && $request->hasSession() ? $request->getSession() : null;
  94.         if ($session instanceof Session) {
  95.             $usageIndexValue = $usageIndexReference = &$session->getUsageIndex();
  96.             $usageIndexReference = \PHP_INT_MIN;
  97.         }
  99.         try {
  100.             if (!$profile = $this->profiler->collect($request, $event->getResponse(), $exception)) {
  101.                 return;
  102.             }
  103.         } finally {
  104.             if ($session instanceof Session) {
  105.                 $usageIndexReference = $usageIndexValue;
  106.             }
  107.         }
  109.         $this->profiles[$request] = $profile;
  111.         $this->parents[$request] = $this->requestStack->getParentRequest();
  112.     }
  114.     public function onKernelTerminate(PostResponseEvent $event)
  115.     {
  116.         // attach children to parents
  117.         foreach ($this->profiles as $request) {
  118.             if (null !== $parentRequest = $this->parents[$request]) {
  119.                 if (isset($this->profiles[$parentRequest])) {
  120.                     $this->profiles[$parentRequest]->addChild($this->profiles[$request]);
  121.                 }
  122.             }
  123.         }
  125.         // save profiles
  126.         foreach ($this->profiles as $request) {
  127.             $this->profiler->saveProfile($this->profiles[$request]);
  128.         }
  130.         $this->profiles = new \SplObjectStorage();
  131.         $this->parents = new \SplObjectStorage();
  132.     }
  134.     public static function getSubscribedEvents()
  135.     {
  136.         return [
  137.             KernelEvents::RESPONSE => ['onKernelResponse', -100],
  138.             KernelEvents::EXCEPTION => ['onKernelException', 0],
  139.             KernelEvents::TERMINATE => ['onKernelTerminate', -1024],
  140.         ];
  141.     }
  142. }