vendor/symfony/routing/Router.php line 257

  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\Routing;
  14. use Psr\Log\LoggerInterface;
  15. use Symfony\Component\Config\ConfigCacheFactory;
  16. use Symfony\Component\Config\ConfigCacheFactoryInterface;
  17. use Symfony\Component\Config\ConfigCacheInterface;
  18. use Symfony\Component\Config\Loader\LoaderInterface;
  19. use Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface;
  20. use Symfony\Component\HttpFoundation\Request;
  21. use Symfony\Component\Routing\Generator\CompiledUrlGenerator;
  22. use Symfony\Component\Routing\Generator\ConfigurableRequirementsInterface;
  23. use Symfony\Component\Routing\Generator\Dumper\CompiledUrlGeneratorDumper;
  24. use Symfony\Component\Routing\Generator\Dumper\GeneratorDumperInterface;
  25. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  26. use Symfony\Component\Routing\Matcher\CompiledUrlMatcher;
  27. use Symfony\Component\Routing\Matcher\Dumper\CompiledUrlMatcherDumper;
  28. use Symfony\Component\Routing\Matcher\Dumper\MatcherDumperInterface;
  29. use Symfony\Component\Routing\Matcher\RequestMatcherInterface;
  30. use Symfony\Component\Routing\Matcher\UrlMatcherInterface;
  32. /**
  33.  * The Router class is an example of the integration of all pieces of the
  34.  * routing system for easier use.
  35.  *
  36.  * @author Fabien Potencier <fabien@symfony.com>
  37.  */
  38. class Router implements RouterInterface, RequestMatcherInterface
  39. {
  40.     /**
  41.      * @var UrlMatcherInterface|null
  42.      */
  43.     protected $matcher;
  45.     /**
  46.      * @var UrlGeneratorInterface|null
  47.      */
  48.     protected $generator;
  50.     /**
  51.      * @var RequestContext
  52.      */
  53.     protected $context;
  55.     /**
  56.      * @var LoaderInterface
  57.      */
  58.     protected $loader;
  60.     /**
  61.      * @var RouteCollection|null
  62.      */
  63.     protected $collection;
  65.     /**
  66.      * @var mixed
  67.      */
  68.     protected $resource;
  70.     /**
  71.      * @var array
  72.      */
  73.     protected $options = [];
  75.     /**
  76.      * @var LoggerInterface|null
  77.      */
  78.     protected $logger;
  80.     /**
  81.      * @var string|null
  82.      */
  83.     protected $defaultLocale;
  85.     private ConfigCacheFactoryInterface $configCacheFactory;
  87.     /**
  88.      * @var ExpressionFunctionProviderInterface[]
  89.      */
  90.     private array $expressionLanguageProviders = [];
  92.     private static ?array $cache = [];
  94.     public function __construct(LoaderInterface $loader, mixed $resource, array $options = [], ?RequestContext $context = null, ?LoggerInterface $logger = null, ?string $defaultLocale = null)
  95.     {
  96.         $this->loader = $loader;
  97.         $this->resource = $resource;
  98.         $this->logger = $logger;
  99.         $this->context = $context ?? new RequestContext();
  100.         $this->setOptions($options);
  101.         $this->defaultLocale = $defaultLocale;
  102.     }
  104.     /**
  105.      * Sets options.
  106.      *
  107.      * Available options:
  108.      *
  109.      *   * cache_dir:              The cache directory (or null to disable caching)
  110.      *   * debug:                  Whether to enable debugging or not (false by default)
  111.      *   * generator_class:        The name of a UrlGeneratorInterface implementation
  112.      *   * generator_dumper_class: The name of a GeneratorDumperInterface implementation
  113.      *   * matcher_class:          The name of a UrlMatcherInterface implementation
  114.      *   * matcher_dumper_class:   The name of a MatcherDumperInterface implementation
  115.      *   * resource_type:          Type hint for the main resource (optional)
  116.      *   * strict_requirements:    Configure strict requirement checking for generators
  117.      *                             implementing ConfigurableRequirementsInterface (default is true)
  118.      *
  119.      * @return void
  120.      *
  121.      * @throws \InvalidArgumentException When unsupported option is provided
  122.      */
  123.     public function setOptions(array $options)
  124.     {
  125.         $this->options = [
  126.             'cache_dir' => null,
  127.             'debug' => false,
  128.             'generator_class' => CompiledUrlGenerator::class,
  129.             'generator_dumper_class' => CompiledUrlGeneratorDumper::class,
  130.             'matcher_class' => CompiledUrlMatcher::class,
  131.             'matcher_dumper_class' => CompiledUrlMatcherDumper::class,
  132.             'resource_type' => null,
  133.             'strict_requirements' => true,
  134.         ];
  136.         // check option names and live merge, if errors are encountered Exception will be thrown
  137.         $invalid = [];
  138.         foreach ($options as $key => $value) {
  139.             if (\array_key_exists($key, $this->options)) {
  140.                 $this->options[$key] = $value;
  141.             } else {
  142.                 $invalid[] = $key;
  143.             }
  144.         }
  146.         if ($invalid) {
  147.             throw new \InvalidArgumentException(sprintf('The Router does not support the following options: "%s".', implode('", "', $invalid)));
  148.         }
  149.     }
  151.     /**
  152.      * Sets an option.
  153.      *
  154.      * @return void
  155.      *
  156.      * @throws \InvalidArgumentException
  157.      */
  158.     public function setOption(string $key, mixed $value)
  159.     {
  160.         if (!\array_key_exists($key, $this->options)) {
  161.             throw new \InvalidArgumentException(sprintf('The Router does not support the "%s" option.', $key));
  162.         }
  164.         $this->options[$key] = $value;
  165.     }
  167.     /**
  168.      * Gets an option value.
  169.      *
  170.      * @throws \InvalidArgumentException
  171.      */
  172.     public function getOption(string $key): mixed
  173.     {
  174.         if (!\array_key_exists($key, $this->options)) {
  175.             throw new \InvalidArgumentException(sprintf('The Router does not support the "%s" option.', $key));
  176.         }
  178.         return $this->options[$key];
  179.     }
  181.     /**
  182.      * @return RouteCollection
  183.      */
  184.     public function getRouteCollection()
  185.     {
  186.         return $this->collection ??= $this->loader->load($this->resource, $this->options['resource_type']);
  187.     }
  189.     /**
  190.      * @return void
  191.      */
  192.     public function setContext(RequestContext $context)
  193.     {
  194.         $this->context = $context;
  196.         if (isset($this->matcher)) {
  197.             $this->getMatcher()->setContext($context);
  198.         }
  199.         if (isset($this->generator)) {
  200.             $this->getGenerator()->setContext($context);
  201.         }
  202.     }
  204.     public function getContext(): RequestContext
  205.     {
  206.         return $this->context;
  207.     }
  209.     /**
  210.      * Sets the ConfigCache factory to use.
  211.      *
  212.      * @return void
  213.      */
  214.     public function setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory)
  215.     {
  216.         $this->configCacheFactory = $configCacheFactory;
  217.     }
  219.     public function generate(string $name, array $parameters = [], int $referenceType = self::ABSOLUTE_PATH): string
  220.     {
  221.         return $this->getGenerator()->generate($name, $parameters, $referenceType);
  222.     }
  224.     public function match(string $pathinfo): array
  225.     {
  226.         return $this->getMatcher()->match($pathinfo);
  227.     }
  229.     public function matchRequest(Request $request): array
  230.     {
  231.         $matcher = $this->getMatcher();
  232.         if (!$matcher instanceof RequestMatcherInterface) {
  233.             // fallback to the default UrlMatcherInterface
  234.             return $matcher->match($request->getPathInfo());
  235.         }
  237.         return $matcher->matchRequest($request);
  238.     }
  240.     /**
  241.      * Gets the UrlMatcher or RequestMatcher instance associated with this Router.
  242.      */
  243.     public function getMatcher(): UrlMatcherInterface|RequestMatcherInterface
  244.     {
  245.         if (isset($this->matcher)) {
  246.             return $this->matcher;
  247.         }
  249.         if (null === $this->options['cache_dir']) {
  250.             $routes = $this->getRouteCollection();
  251.             $compiled = is_a($this->options['matcher_class'], CompiledUrlMatcher::class, true);
  252.             if ($compiled) {
  253.                 $routes = (new CompiledUrlMatcherDumper($routes))->getCompiledRoutes();
  254.             }
  255.             $this->matcher = new $this->options['matcher_class']($routes, $this->context);
  256.             if (method_exists($this->matcher, 'addExpressionLanguageProvider')) {
  257.                 foreach ($this->expressionLanguageProviders as $provider) {
  258.                     $this->matcher->addExpressionLanguageProvider($provider);
  259.                 }
  260.             }
  262.             return $this->matcher;
  263.         }
  265.         $cache = $this->getConfigCacheFactory()->cache($this->options['cache_dir'].'/url_matching_routes.php',
  266.             function (ConfigCacheInterface $cache) {
  267.                 $dumper = $this->getMatcherDumperInstance();
  268.                 if (method_exists($dumper, 'addExpressionLanguageProvider')) {
  269.                     foreach ($this->expressionLanguageProviders as $provider) {
  270.                         $dumper->addExpressionLanguageProvider($provider);
  271.                     }
  272.                 }
  274.                 $cache->write($dumper->dump(), $this->getRouteCollection()->getResources());
  275.             }
  276.         );
  278.         return $this->matcher = new $this->options['matcher_class'](self::getCompiledRoutes($cache->getPath()), $this->context);
  279.     }
  281.     /**
  282.      * Gets the UrlGenerator instance associated with this Router.
  283.      */
  284.     public function getGenerator(): UrlGeneratorInterface
  285.     {
  286.         if (isset($this->generator)) {
  287.             return $this->generator;
  288.         }
  290.         if (null === $this->options['cache_dir']) {
  291.             $routes = $this->getRouteCollection();
  292.             $compiled = is_a($this->options['generator_class'], CompiledUrlGenerator::class, true);
  293.             if ($compiled) {
  294.                 $generatorDumper = new CompiledUrlGeneratorDumper($routes);
  295.                 $routes = array_merge($generatorDumper->getCompiledRoutes(), $generatorDumper->getCompiledAliases());
  296.             }
  297.             $this->generator = new $this->options['generator_class']($routes, $this->context, $this->logger, $this->defaultLocale);
  298.         } else {
  299.             $cache = $this->getConfigCacheFactory()->cache($this->options['cache_dir'].'/url_generating_routes.php',
  300.                 function (ConfigCacheInterface $cache) {
  301.                     $dumper = $this->getGeneratorDumperInstance();
  303.                     $cache->write($dumper->dump(), $this->getRouteCollection()->getResources());
  304.                 }
  305.             );
  307.             $this->generator = new $this->options['generator_class'](self::getCompiledRoutes($cache->getPath()), $this->context, $this->logger, $this->defaultLocale);
  308.         }
  310.         if ($this->generator instanceof ConfigurableRequirementsInterface) {
  311.             $this->generator->setStrictRequirements($this->options['strict_requirements']);
  312.         }
  314.         return $this->generator;
  315.     }
  317.     /**
  318.      * @return void
  319.      */
  320.     public function addExpressionLanguageProvider(ExpressionFunctionProviderInterface $provider)
  321.     {
  322.         $this->expressionLanguageProviders[] = $provider;
  323.     }
  325.     protected function getGeneratorDumperInstance(): GeneratorDumperInterface
  326.     {
  327.         return new $this->options['generator_dumper_class']($this->getRouteCollection());
  328.     }
  330.     protected function getMatcherDumperInstance(): MatcherDumperInterface
  331.     {
  332.         return new $this->options['matcher_dumper_class']($this->getRouteCollection());
  333.     }
  335.     /**
  336.      * Provides the ConfigCache factory implementation, falling back to a
  337.      * default implementation if necessary.
  338.      */
  339.     private function getConfigCacheFactory(): ConfigCacheFactoryInterface
  340.     {
  341.         return $this->configCacheFactory ??= new ConfigCacheFactory($this->options['debug']);
  342.     }
  344.     private static function getCompiledRoutes(string $path): array
  345.     {
  346.         if ([] === self::$cache && \function_exists('opcache_invalidate') && filter_var(\ini_get('opcache.enable'), \FILTER_VALIDATE_BOOL) && (!\in_array(\PHP_SAPI, ['cli', 'phpdbg', 'embed'], true) || filter_var(\ini_get('opcache.enable_cli'), \FILTER_VALIDATE_BOOL))) {
  347.             self::$cache = null;
  348.         }
  350.         if (null === self::$cache) {
  351.             return require $path;
  352.         }
  354.         return self::$cache[$path] ??= require $path;
  355.     }
  356. }