vendor/symfony/routing/Router.php line 247

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\Component\Routing;
  11. use Psr\Log\LoggerInterface;
  12. use Symfony\Component\Config\ConfigCacheFactory;
  13. use Symfony\Component\Config\ConfigCacheFactoryInterface;
  14. use Symfony\Component\Config\ConfigCacheInterface;
  15. use Symfony\Component\Config\Loader\LoaderInterface;
  16. use Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface;
  17. use Symfony\Component\HttpFoundation\Request;
  18. use Symfony\Component\Routing\Generator\ConfigurableRequirementsInterface;
  19. use Symfony\Component\Routing\Generator\Dumper\GeneratorDumperInterface;
  20. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  21. use Symfony\Component\Routing\Matcher\Dumper\MatcherDumperInterface;
  22. use Symfony\Component\Routing\Matcher\RequestMatcherInterface;
  23. use Symfony\Component\Routing\Matcher\UrlMatcherInterface;
  24. // LG pour tests
  25. use \App\PaaBundle\Component\UrlGenerator2 ;
  26. /**
  27.  * The Router class is an example of the integration of all pieces of the
  28.  * routing system for easier use.
  29.  *
  30.  * @author Fabien Potencier <fabien@symfony.com>
  31.  */
  32. class Router implements RouterInterfaceRequestMatcherInterface {
  33.     /**
  34.      * @var UrlMatcherInterface|null
  35.      */
  36.     protected $matcher;
  37.     /**
  38.      * @var UrlGeneratorInterface|null
  39.      */
  40.     protected $generator;
  41.     /**
  42.      * @var RequestContext
  43.      */
  44.     protected $context;
  45.     /**
  46.      * @var LoaderInterface
  47.      */
  48.     protected $loader;
  49.     /**
  50.      * @var RouteCollection|null
  51.      */
  52.     protected $collection;
  53.     /**
  54.      * @var mixed
  55.      */
  56.     protected $resource;
  57.     /**
  58.      * @var array
  59.      */
  60.     protected $options = [];
  61.     /**
  62.      * @var LoggerInterface|null
  63.      */
  64.     protected $logger;
  65.     /**
  66.      * @var string|null
  67.      */
  68.     protected $defaultLocale;
  69.     /**
  70.      * @var ConfigCacheFactoryInterface|null
  71.      */
  72.     private $configCacheFactory;
  73.     /**
  74.      * @var ExpressionFunctionProviderInterface[]
  75.      */
  76.     private $expressionLanguageProviders = [];
  77.     /**
  78.      * @param LoaderInterface $loader   A LoaderInterface instance
  79.      * @param mixed           $resource The main resource to load
  80.      * @param array           $options  An array of options
  81.      * @param RequestContext  $context  The context
  82.      * @param LoggerInterface $logger   A logger instance
  83.      */
  84.     public function __construct(LoaderInterface $loader$resource, array $options = [], RequestContext $context nullLoggerInterface $logger nullstring $defaultLocale null) {
  85.         $this->loader $loader;
  86.         $this->resource $resource;
  87.         $this->logger $logger;
  88.         $this->context $context ?: new RequestContext();
  89.         $this->setOptions($options);
  90.         $this->defaultLocale $defaultLocale;
  91.     }
  92.     /**
  93.      * Sets options.
  94.      *
  95.      * Available options:
  96.      *
  97.      *   * cache_dir:              The cache directory (or null to disable caching)
  98.      *   * debug:                  Whether to enable debugging or not (false by default)
  99.      *   * generator_class:        The name of a UrlGeneratorInterface implementation
  100.      *   * generator_base_class:   The base class for the dumped generator class
  101.      *   * generator_cache_class:  The class name for the dumped generator class
  102.      *   * generator_dumper_class: The name of a GeneratorDumperInterface implementation
  103.      *   * matcher_class:          The name of a UrlMatcherInterface implementation
  104.      *   * matcher_base_class:     The base class for the dumped matcher class
  105.      *   * matcher_dumper_class:   The class name for the dumped matcher class
  106.      *   * matcher_cache_class:    The name of a MatcherDumperInterface implementation
  107.      *   * resource_type:          Type hint for the main resource (optional)
  108.      *   * strict_requirements:    Configure strict requirement checking for generators
  109.      *                             implementing ConfigurableRequirementsInterface (default is true)
  110.      *
  111.      * @param array $options An array of options
  112.      *
  113.      * @throws \InvalidArgumentException When unsupported option is provided
  114.      */
  115.     public function setOptions(array $options) {
  116.         $this->options = [
  117.             'cache_dir' => null,
  118.             'debug' => false,
  119.             'generator_class' => 'Symfony\\Component\\Routing\\Generator\\UrlGenerator',
  120.             'generator_base_class' => 'Symfony\\Component\\Routing\\Generator\\UrlGenerator',
  121.             'generator_dumper_class' => 'Symfony\\Component\\Routing\\Generator\\Dumper\\PhpGeneratorDumper',
  122.             'generator_cache_class' => 'ProjectUrlGenerator',
  123.             'matcher_class' => 'Symfony\\Component\\Routing\\Matcher\\UrlMatcher',
  124.             'matcher_base_class' => 'Symfony\\Component\\Routing\\Matcher\\UrlMatcher',
  125.             'matcher_dumper_class' => 'Symfony\\Component\\Routing\\Matcher\\Dumper\\PhpMatcherDumper',
  126.             'matcher_cache_class' => 'ProjectUrlMatcher',
  127.             'resource_type' => null,
  128.             'strict_requirements' => true,
  129.         ];
  130.         // check option names and live merge, if errors are encountered Exception will be thrown
  131.         $invalid = [];
  132.         foreach ($options as $key => $value) {
  133.             if (\array_key_exists($key$this->options)) {
  134.                 $this->options[$key] = $value;
  135.             } else {
  136.                 $invalid[] = $key;
  137.             }
  138.         }
  139.         if ($invalid) {
  140.             throw new \InvalidArgumentException(sprintf('The Router does not support the following options: "%s".'implode('", "'$invalid)));
  141.         }
  142.     }
  143.     /**
  144.      * Sets an option.
  145.      *
  146.      * @param string $key   The key
  147.      * @param mixed  $value The value
  148.      *
  149.      * @throws \InvalidArgumentException
  150.      */
  151.     public function setOption($key$value) {
  152.         if (!\array_key_exists($key$this->options)) {
  153.             throw new \InvalidArgumentException(sprintf('The Router does not support the "%s" option.'$key));
  154.         }
  155.         $this->options[$key] = $value;
  156.     }
  157.     /**
  158.      * Gets an option value.
  159.      *
  160.      * @param string $key The key
  161.      *
  162.      * @return mixed The value
  163.      *
  164.      * @throws \InvalidArgumentException
  165.      */
  166.     public function getOption($key) {
  167.         if (!\array_key_exists($key$this->options)) {
  168.             throw new \InvalidArgumentException(sprintf('The Router does not support the "%s" option.'$key));
  169.         }
  170.         return $this->options[$key];
  171.     }
  172.     /**
  173.      * {@inheritdoc}
  174.      */
  175.     public function getRouteCollection() {
  176.         if (null === $this->collection) {
  177.             $this->collection $this->loader->load($this->resource$this->options['resource_type']);
  178.         }
  179.         return $this->collection;
  180.     }
  181.     /**
  182.      * {@inheritdoc}
  183.      */
  184.     public function setContext(RequestContext $context) {
  185.         $this->context $context;
  186.         if (null !== $this->matcher) {
  187.             $this->getMatcher()->setContext($context);
  188.         }
  189.         if (null !== $this->generator) {
  190.             $this->getGenerator()->setContext($context);
  191.         }
  192.     }
  193.     /**
  194.      * {@inheritdoc}
  195.      */
  196.     public function getContext() {
  197.         return $this->context;
  198.     }
  199.     /**
  200.      * Sets the ConfigCache factory to use.
  201.      */
  202.     public function setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory) {
  203.         $this->configCacheFactory $configCacheFactory;
  204.     }
  205.     /**
  206.      * {@inheritdoc}
  207.      */
  208.     public function generate($name$parameters = [], $referenceType self::ABSOLUTE_PATH) {
  209.         return $this->getGenerator()->generate($name$parameters$referenceType);
  210.     }
  211.     /**
  212.      * {@inheritdoc}
  213.      */
  214.     public function match($pathinfo) {
  215.         return $this->getMatcher()->match($pathinfo);
  216.     }
  217.     /**
  218.      * {@inheritdoc}
  219.      */
  220.     public function matchRequest(Request $request) {
  221.         $matcher $this->getMatcher();
  222.         if (!$matcher instanceof RequestMatcherInterface) {
  223.             // fallback to the default UrlMatcherInterface
  224.             return $matcher->match($request->getPathInfo());
  225.         }
  226.         return $matcher->matchRequest($request);
  227.     }
  228.     /**
  229.      * Gets the UrlMatcher instance associated with this Router.
  230.      *
  231.      * @return UrlMatcherInterface A UrlMatcherInterface instance
  232.      */
  233.     public function getMatcher() {
  234.         if (null !== $this->matcher) {
  235.             return $this->matcher;
  236.         }
  237.         if (null === $this->options['cache_dir'] || null === $this->options['matcher_cache_class']) {
  238.             $this->matcher = new $this->options['matcher_class']($this->getRouteCollection(), $this->context);
  239.             if (method_exists($this->matcher'addExpressionLanguageProvider')) {
  240.                 foreach ($this->expressionLanguageProviders as $provider) {
  241.                     $this->matcher->addExpressionLanguageProvider($provider);
  242.                 }
  243.             }
  244.             return $this->matcher;
  245.         }
  246.         $cache $this->getConfigCacheFactory()->cache($this->options['cache_dir'] . '/' $this->options['matcher_cache_class'] . '.php', function (ConfigCacheInterface $cache) {
  247.             $dumper $this->getMatcherDumperInstance();
  248.             if (method_exists($dumper'addExpressionLanguageProvider')) {
  249.                 foreach ($this->expressionLanguageProviders as $provider) {
  250.                     $dumper->addExpressionLanguageProvider($provider);
  251.                 }
  252.             }
  253.             $options = [
  254.                 'class' => $this->options['matcher_cache_class'],
  255.                 'base_class' => $this->options['matcher_base_class'],
  256.             ];
  257.             $cache->write($dumper->dump($options), $this->getRouteCollection()->getResources());
  258.         }
  259.         );
  260.         if (!class_exists($this->options['matcher_cache_class'], false)) {
  261.             require_once $cache->getPath();
  262.         }
  263.         return $this->matcher = new $this->options['matcher_cache_class']($this->context);
  264.     }
  265.     /**
  266.      * Gets the UrlGenerator instance associated with this Router.
  267.      *
  268.      * @return UrlGeneratorInterface A UrlGeneratorInterface instance
  269.      */
  270.     public function getGenerator() {
  271.         if (null !== $this->generator) {
  272.             return $this->generator;
  273.         }
  274. // LG début pour tests
  275. //        return new \App\PaaBundle\Component\UrlGenerator2($this->getRouteCollection(), $this->context, $this->logger, $this->defaultLocale) ;
  276. // LG fin pour tests
  277.         
  278.         if (null === $this->options['cache_dir'] || null === $this->options['generator_cache_class']) {
  279.             $this->generator = new $this->options['generator_class']($this->getRouteCollection(), $this->context$this->logger$this->defaultLocale);
  280.         } else {
  281.             $cache $this->getConfigCacheFactory()->cache($this->options['cache_dir'] . '/' $this->options['generator_cache_class'] . '.php', function (ConfigCacheInterface $cache) {
  282.                 $dumper $this->getGeneratorDumperInstance();
  283.                 $options = [
  284.                     'class' => $this->options['generator_cache_class'],
  285.                     'base_class' => $this->options['generator_base_class'],
  286.                 ];
  287.                 $cache->write($dumper->dump($options), $this->getRouteCollection()->getResources());
  288.             }
  289.             );
  290.             if (!class_exists($this->options['generator_cache_class'], false)) {
  291.                 require_once $cache->getPath();
  292.             }
  293.             $this->generator = new $this->options['generator_cache_class']($this->context$this->logger$this->defaultLocale);
  294.         }
  295.         if ($this->generator instanceof ConfigurableRequirementsInterface) {
  296.             $this->generator->setStrictRequirements($this->options['strict_requirements']);
  297.         }
  298.         return $this->generator;
  299.     }
  300.     public function addExpressionLanguageProvider(ExpressionFunctionProviderInterface $provider) {
  301.         $this->expressionLanguageProviders[] = $provider;
  302.     }
  303.     /**
  304.      * @return GeneratorDumperInterface
  305.      */
  306.     protected function getGeneratorDumperInstance() {
  307.         return new $this->options['generator_dumper_class']($this->getRouteCollection());
  308.     }
  309.     /**
  310.      * @return MatcherDumperInterface
  311.      */
  312.     protected function getMatcherDumperInstance() {
  313.         return new $this->options['matcher_dumper_class']($this->getRouteCollection());
  314.     }
  315.     /**
  316.      * Provides the ConfigCache factory implementation, falling back to a
  317.      * default implementation if necessary.
  318.      *
  319.      * @return ConfigCacheFactoryInterface
  320.      */
  321.     private function getConfigCacheFactory() {
  322.         if (null === $this->configCacheFactory) {
  323.             $this->configCacheFactory = new ConfigCacheFactory($this->options['debug']);
  324.         }
  325.         return $this->configCacheFactory;
  326.     }
  327. }