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

  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 bool $loading = false;
  32.     private array $defaultOptions;
  33.     private array $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.     public function load(mixed $resource, string $type = null): RouteCollection
  44.     {
  45.         if ($this->loading) {
  46.             // This can happen if a fatal error occurs in parent::load().
  47.             // Here is the scenario:
  48.             // - while routes are being loaded by parent::load() below, a fatal error
  49.             //   occurs (e.g. parse error in a controller while loading annotations);
  50.             // - PHP abruptly empties the stack trace, bypassing all catch/finally blocks;
  51.             //   it then calls the registered shutdown functions;
  52.             // - the ErrorHandler catches the fatal error and re-injects it for rendering
  53.             //   thanks to HttpKernel->terminateWithException() (that calls handleException());
  54.             // - at this stage, if we try to load the routes again, we must prevent
  55.             //   the fatal error from occurring a second time,
  56.             //   otherwise the PHP process would be killed immediately;
  57.             // - while rendering the exception page, the router can be required
  58.             //   (by e.g. the web profiler that needs to generate a URL);
  59.             // - this handles the case and prevents the second fatal error
  60.             //   by triggering an exception beforehand.
  62.             throw new LoaderLoadException($resource, null, 0, null, $type);
  63.         }
  64.         $this->loading = true;
  66.         try {
  67.             $collection = parent::load($resource, $type);
  68.         } finally {
  69.             $this->loading = false;
  70.         }
  72.         foreach ($collection->all() as $route) {
  73.             if ($this->defaultOptions) {
  74.                 $route->setOptions($route->getOptions() + $this->defaultOptions);
  75.             }
  76.             if ($this->defaultRequirements) {
  77.                 $route->setRequirements($route->getRequirements() + $this->defaultRequirements);
  78.             }
  79.             if (!\is_string($controller = $route->getDefault('_controller'))) {
  80.                 continue;
  81.             }
  83.             if (str_contains($controller, '::')) {
  84.                 continue;
  85.             }
  87.             $route->setDefault('_controller', $controller);
  88.         }
  90.         return $collection;
  91.     }
  92. }