vendor/symfony/http-kernel/Debug/TraceableEventDispatcher.php line 24

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\Debug;
  14. use Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher as BaseTraceableEventDispatcher;
  15. use Symfony\Component\HttpKernel\KernelEvents;
  17. /**
  18.  * Collects some data about event listeners.
  19.  *
  20.  * This event dispatcher delegates the dispatching to another one.
  21.  *
  22.  * @author Fabien Potencier <fabien@symfony.com>
  23.  */
  24. class TraceableEventDispatcher extends BaseTraceableEventDispatcher
  25. {
  26.     /**
  27.      * {@inheritdoc}
  28.      */
  29.     protected function beforeDispatch(string $eventName, object $event)
  30.     {
  31.         switch ($eventName) {
  32.             case KernelEvents::REQUEST:
  33.                 $event->getRequest()->attributes->set('_stopwatch_token', substr(hash('sha256', uniqid(mt_rand(), true)), 0, 6));
  34.                 $this->stopwatch->openSection();
  35.                 break;
  36.             case KernelEvents::VIEW:
  37.             case KernelEvents::RESPONSE:
  38.                 // stop only if a controller has been executed
  39.                 if ($this->stopwatch->isStarted('controller')) {
  40.                     $this->stopwatch->stop('controller');
  41.                 }
  42.                 break;
  43.             case KernelEvents::TERMINATE:
  44.                 $sectionId = $event->getRequest()->attributes->get('_stopwatch_token');
  45.                 if (null === $sectionId) {
  46.                     break;
  47.                 }
  48.                 // There is a very special case when using built-in AppCache class as kernel wrapper, in the case
  49.                 // of an ESI request leading to a `stale` response [B]  inside a `fresh` cached response [A].
  50.                 // In this case, `$token` contains the [B] debug token, but the  open `stopwatch` section ID
  51.                 // is equal to the [A] debug token. Trying to reopen section with the [B] token throws an exception
  52.                 // which must be caught.
  53.                 try {
  54.                     $this->stopwatch->openSection($sectionId);
  55.                 } catch (\LogicException $e) {
  56.                 }
  57.                 break;
  58.         }
  59.     }
  61.     /**
  62.      * {@inheritdoc}
  63.      */
  64.     protected function afterDispatch(string $eventName, object $event)
  65.     {
  66.         switch ($eventName) {
  67.             case KernelEvents::CONTROLLER_ARGUMENTS:
  68.                 $this->stopwatch->start('controller', 'section');
  69.                 break;
  70.             case KernelEvents::RESPONSE:
  71.                 $sectionId = $event->getRequest()->attributes->get('_stopwatch_token');
  72.                 if (null === $sectionId) {
  73.                     break;
  74.                 }
  75.                 $this->stopwatch->stopSection($sectionId);
  76.                 break;
  77.             case KernelEvents::TERMINATE:
  78.                 // In the special case described in the `preDispatch` method above, the `$token` section
  79.                 // does not exist, then closing it throws an exception which must be caught.
  80.                 $sectionId = $event->getRequest()->attributes->get('_stopwatch_token');
  81.                 if (null === $sectionId) {
  82.                     break;
  83.                 }
  84.                 try {
  85.                     $this->stopwatch->stopSection($sectionId);
  86.                 } catch (\LogicException $e) {
  87.                 }
  88.                 break;
  89.         }
  90.     }
  91. }