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 \SplObjectStorage $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. public function reset(): void
  52. {
  53. $this->controllers = new \SplObjectStorage();
  55. $this->data = [
  56. 'redirect' => false,
  57. 'url' => null,
  58. 'route' => null,
  59. ];
  60. }
  62. protected function guessRoute(Request $request, string|object|array $controller): string
  63. {
  64. return 'n/a';
  65. }
  67. /**
  68. * Remembers the controller associated to each request.
  69. */
  70. public function onKernelController(ControllerEvent $event): void
  71. {
  72. $this->controllers[$event->getRequest()] = $event->getController();
  73. }
  75. /**
  76. * @return bool Whether this request will result in a redirect
  77. */
  78. public function getRedirect(): bool
  79. {
  80. return $this->data['redirect'];
  81. }
  83. public function getTargetUrl(): ?string
  84. {
  85. return $this->data['url'];
  86. }
  88. public function getTargetRoute(): ?string
  89. {
  90. return $this->data['route'];
  91. }
  93. public function getName(): string
  94. {
  95. return 'router';
  96. }
  97. }