vendor/symfony/http-kernel/DataCollector/RouterDataCollector.php line 72

  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\HttpFoundation\RedirectResponse;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\Response;
  17. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  19. /**
  20.  * @author Fabien Potencier <fabien@symfony.com>
  21.  */
  22. class RouterDataCollector extends DataCollector
  23. {
  24.     /**
  25.      * @var \SplObjectStorage<Request, callable>
  26.      */
  27.     protected $controllers;
  29.     public function __construct()
  30.     {
  31.         $this->reset();
  32.     }
  34.     /**
  35.      * @final
  36.      */
  37.     public function collect(Request $request, Response $response, ?\Throwable $exception = null): void
  38.     {
  39.         if ($response instanceof RedirectResponse) {
  40.             $this->data['redirect'] = true;
  41.             $this->data['url'] = $response->getTargetUrl();
  43.             if ($this->controllers->contains($request)) {
  44.                 $this->data['route'] = $this->guessRoute($request, $this->controllers[$request]);
  45.             }
  46.         }
  48.         unset($this->controllers[$request]);
  49.     }
  51.     /**
  52.      * @return void
  53.      */
  54.     public function reset()
  55.     {
  56.         $this->controllers = new \SplObjectStorage();
  58.         $this->data = [
  59.             'redirect' => false,
  60.             'url' => null,
  61.             'route' => null,
  62.         ];
  63.     }
  65.     /**
  66.      * @return string
  67.      */
  68.     protected function guessRoute(Request $request, string|object|array $controller)
  69.     {
  70.         return 'n/a';
  71.     }
  73.     /**
  74.      * Remembers the controller associated to each request.
  75.      *
  76.      * @return void
  77.      */
  78.     public function onKernelController(ControllerEvent $event)
  79.     {
  80.         $this->controllers[$event->getRequest()] = $event->getController();
  81.     }
  83.     /**
  84.      * @return bool Whether this request will result in a redirect
  85.      */
  86.     public function getRedirect(): bool
  87.     {
  88.         return $this->data['redirect'];
  89.     }
  91.     public function getTargetUrl(): ?string
  92.     {
  93.         return $this->data['url'];
  94.     }
  96.     public function getTargetRoute(): ?string
  97.     {
  98.         return $this->data['route'];
  99.     }
  101.     public function getName(): string
  102.     {
  103.         return 'router';
  104.     }
  105. }