vendor/symfony/framework-bundle/Routing/DelegatingLoader.php line 70

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\Bundle\FrameworkBundle\Routing;
  14. use Symfony\Component\Config\Exception\LoaderLoadException;
  15. use Symfony\Component\Config\Loader\DelegatingLoader as BaseDelegatingLoader;
  16. use Symfony\Component\Config\Loader\LoaderResolverInterface;
  17. use Symfony\Component\Routing\RouteCollection;
  19. /**
  20. * DelegatingLoader delegates route loading to other loaders using a loader resolver.
  21. *
  22. * This implementation resolves the _controller attribute from the short notation
  23. * to the fully-qualified form (from a:b:c to class::method).
  24. *
  25. * @author Fabien Potencier <fabien@symfony.com>
  26. *
  27. * @final
  28. */
  29. class DelegatingLoader extends BaseDelegatingLoader
  30. {
  31. private $loading = false;
  32. private $defaultOptions;
  33. private $defaultRequirements;
  35. public function __construct(LoaderResolverInterface $resolver, array $defaultOptions = [], array $defaultRequirements = [])
  36. {
  37. $this->defaultOptions = $defaultOptions;
  38. $this->defaultRequirements = $defaultRequirements;
  40. parent::__construct($resolver);
  41. }
  43. /**
  44. * {@inheritdoc}
  45. */
  46. public function load($resource, ?string $type = null): RouteCollection
  47. {
  48. if ($this->loading) {
  49. // This can happen if a fatal error occurs in parent::load().
  50. // Here is the scenario:
  51. // - while routes are being loaded by parent::load() below, a fatal error
  52. // occurs (e.g. parse error in a controller while loading annotations);
  53. // - PHP abruptly empties the stack trace, bypassing all catch/finally blocks;
  54. // it then calls the registered shutdown functions;
  55. // - the ErrorHandler catches the fatal error and re-injects it for rendering
  56. // thanks to HttpKernel->terminateWithException() (that calls handleException());
  57. // - at this stage, if we try to load the routes again, we must prevent
  58. // the fatal error from occurring a second time,
  59. // otherwise the PHP process would be killed immediately;
  60. // - while rendering the exception page, the router can be required
  61. // (by e.g. the web profiler that needs to generate an URL);
  62. // - this handles the case and prevents the second fatal error
  63. // by triggering an exception beforehand.
  65. throw new LoaderLoadException($resource, null, 0, null, $type);
  66. }
  67. $this->loading = true;
  69. try {
  70. $collection = parent::load($resource, $type);
  71. } finally {
  72. $this->loading = false;
  73. }
  75. foreach ($collection->all() as $route) {
  76. if ($this->defaultOptions) {
  77. $route->setOptions($route->getOptions() + $this->defaultOptions);
  78. }
  79. if ($this->defaultRequirements) {
  80. $route->setRequirements($route->getRequirements() + $this->defaultRequirements);
  81. }
  82. if (!\is_string($controller = $route->getDefault('_controller'))) {
  83. continue;
  84. }
  86. if (str_contains($controller, '::')) {
  87. continue;
  88. }
  90. $route->setDefault('_controller', $controller);
  91. }
  93. return $collection;
  94. }
  95. }