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

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the Symfony package.
  4.  *
  5.  * (c) Fabien Potencier <fabien@symfony.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace Symfony\Bundle\FrameworkBundle\Routing;
  11. use Symfony\Bundle\FrameworkBundle\Controller\ControllerNameParser;
  12. use Symfony\Component\Config\Exception\LoaderLoadException;
  13. use Symfony\Component\Config\Loader\DelegatingLoader as BaseDelegatingLoader;
  14. use Symfony\Component\Config\Loader\LoaderResolverInterface;
  15. /**
  16.  * DelegatingLoader delegates route loading to other loaders using a loader resolver.
  17.  *
  18.  * This implementation resolves the _controller attribute from the short notation
  19.  * to the fully-qualified form (from a:b:c to class::method).
  20.  *
  21.  * @author Fabien Potencier <fabien@symfony.com>
  22.  */
  23. class DelegatingLoader extends BaseDelegatingLoader
  24. {
  25.     protected $parser;
  26.     private $loading false;
  27.     private $defaultOptions;
  28.     /**
  29.      * @param ControllerNameParser    $parser   A ControllerNameParser instance
  30.      * @param LoaderResolverInterface $resolver A LoaderResolverInterface instance
  31.      */
  32.     public function __construct(ControllerNameParser $parserLoaderResolverInterface $resolver, array $defaultOptions = [])
  33.     {
  34.         $this->parser $parser;
  35.         $this->defaultOptions $defaultOptions;
  36.         parent::__construct($resolver);
  37.     }
  38.     /**
  39.      * {@inheritdoc}
  40.      */
  41.     public function load($resource$type null)
  42.     {
  43.         if ($this->loading) {
  44.             // This can happen if a fatal error occurs in parent::load().
  45.             // Here is the scenario:
  46.             // - while routes are being loaded by parent::load() below, a fatal error
  47.             //   occurs (e.g. parse error in a controller while loading annotations);
  48.             // - PHP abruptly empties the stack trace, bypassing all catch/finally blocks;
  49.             //   it then calls the registered shutdown functions;
  50.             // - the ErrorHandler catches the fatal error and re-injects it for rendering
  51.             //   thanks to HttpKernel->terminateWithException() (that calls handleException());
  52.             // - at this stage, if we try to load the routes again, we must prevent
  53.             //   the fatal error from occurring a second time,
  54.             //   otherwise the PHP process would be killed immediately;
  55.             // - while rendering the exception page, the router can be required
  56.             //   (by e.g. the web profiler that needs to generate an URL);
  57.             // - this handles the case and prevents the second fatal error
  58.             //   by triggering an exception beforehand.
  59.             throw new LoaderLoadException($resourcenullnullnull$type);
  60.         }
  61.         $this->loading true;
  62.         try {
  63.             $collection parent::load($resource$type);
  64.         } finally {
  65.             $this->loading false;
  66.         }
  67.         foreach ($collection->all() as $route) {
  68.             if ($this->defaultOptions) {
  69.                 $route->setOptions($route->getOptions() + $this->defaultOptions);
  70.             }
  71.             if (!\is_string($controller $route->getDefault('_controller'))) {
  72.                 continue;
  73.             }
  74.             if (false !== strpos($controller'::')) {
  75.                 continue;
  76.             }
  77.             if (=== substr_count($controller':')) {
  78.                 $deprecatedNotation $controller;
  79.                 try {
  80.                     $controller $this->parser->parse($controllerfalse);
  81.                     @trigger_error(sprintf('Referencing controllers with %s is deprecated since Symfony 4.1, use "%s" instead.'$deprecatedNotation$controller), E_USER_DEPRECATED);
  82.                 } catch (\InvalidArgumentException $e) {
  83.                     // unable to optimize unknown notation
  84.                 }
  85.             }
  86.             if (=== substr_count($controller':')) {
  87.                 $nonDeprecatedNotation str_replace(':''::'$controller);
  88.                 // TODO deprecate this in 5.1
  89.             }
  90.             $route->setDefault('_controller'$controller);
  91.         }
  92.         return $collection;
  93.     }
  94. }