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

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\Bundle\FrameworkBundle\Controller\ControllerNameParser;
  15. use Symfony\Component\Config\Exception\LoaderLoadException;
  16. use Symfony\Component\Config\Loader\DelegatingLoader as BaseDelegatingLoader;
  17. use Symfony\Component\Config\Loader\LoaderResolverInterface;
  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 since Symfony 4.4
  28.  */
  29. class DelegatingLoader extends BaseDelegatingLoader
  30. {
  31.     /**
  32.      * @deprecated since Symfony 4.4
  33.      */
  34.     protected $parser;
  35.     private $loading = false;
  36.     private $defaultOptions;
  38.     /**
  39.      * @param LoaderResolverInterface $resolver
  40.      * @param array                   $defaultOptions
  41.      */
  42.     public function __construct($resolver, $defaultOptions = [])
  43.     {
  44.         if ($resolver instanceof ControllerNameParser) {
  45.             @trigger_error(sprintf('Passing a "%s" instance as first argument to "%s()" is deprecated since Symfony 4.4, pass a "%s" instance instead.', ControllerNameParser::class, __METHOD__, LoaderResolverInterface::class), \E_USER_DEPRECATED);
  46.             $this->parser = $resolver;
  47.             $resolver = $defaultOptions;
  48.             $defaultOptions = 2 < \func_num_args() ? func_get_arg(2) : [];
  49.         } elseif (2 < \func_num_args() && func_get_arg(2) instanceof ControllerNameParser) {
  50.             $this->parser = func_get_arg(2);
  51.         }
  53.         $this->defaultOptions = $defaultOptions;
  55.         parent::__construct($resolver);
  56.     }
  58.     /**
  59.      * {@inheritdoc}
  60.      */
  61.     public function load($resource, $type = null)
  62.     {
  63.         if ($this->loading) {
  64.             // This can happen if a fatal error occurs in parent::load().
  65.             // Here is the scenario:
  66.             // - while routes are being loaded by parent::load() below, a fatal error
  67.             //   occurs (e.g. parse error in a controller while loading annotations);
  68.             // - PHP abruptly empties the stack trace, bypassing all catch/finally blocks;
  69.             //   it then calls the registered shutdown functions;
  70.             // - the ErrorHandler catches the fatal error and re-injects it for rendering
  71.             //   thanks to HttpKernel->terminateWithException() (that calls handleException());
  72.             // - at this stage, if we try to load the routes again, we must prevent
  73.             //   the fatal error from occurring a second time,
  74.             //   otherwise the PHP process would be killed immediately;
  75.             // - while rendering the exception page, the router can be required
  76.             //   (by e.g. the web profiler that needs to generate an URL);
  77.             // - this handles the case and prevents the second fatal error
  78.             //   by triggering an exception beforehand.
  80.             throw new LoaderLoadException($resource, null, 0, null, $type);
  81.         }
  82.         $this->loading = true;
  84.         try {
  85.             $collection = parent::load($resource, $type);
  86.         } finally {
  87.             $this->loading = false;
  88.         }
  90.         foreach ($collection->all() as $route) {
  91.             if ($this->defaultOptions) {
  92.                 $route->setOptions($route->getOptions() + $this->defaultOptions);
  93.             }
  94.             if (!\is_string($controller = $route->getDefault('_controller'))) {
  95.                 continue;
  96.             }
  98.             if (str_contains($controller, '::')) {
  99.                 continue;
  100.             }
  102.             if ($this->parser && 2 === substr_count($controller, ':')) {
  103.                 $deprecatedNotation = $controller;
  105.                 try {
  106.                     $controller = $this->parser->parse($controller, false);
  108.                     @trigger_error(sprintf('Referencing controllers with %s is deprecated since Symfony 4.1, use "%s" instead.', $deprecatedNotation, $controller), \E_USER_DEPRECATED);
  109.                 } catch (\InvalidArgumentException $e) {
  110.                     // unable to optimize unknown notation
  111.                 }
  112.             }
  114.             $route->setDefault('_controller', $controller);
  115.         }
  117.         return $collection;
  118.     }
  119. }