vendor/symfony/routing/Loader/YamlFileLoader.php line 46

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\Component\Routing\Loader;
  14. use Symfony\Component\Config\Loader\FileLoader;
  15. use Symfony\Component\Config\Resource\FileResource;
  16. use Symfony\Component\Routing\Route;
  17. use Symfony\Component\Routing\RouteCollection;
  18. use Symfony\Component\Routing\RouteCompiler;
  19. use Symfony\Component\Yaml\Exception\ParseException;
  20. use Symfony\Component\Yaml\Parser as YamlParser;
  21. use Symfony\Component\Yaml\Yaml;
  23. /**
  24.  * YamlFileLoader loads Yaml routing files.
  25.  *
  26.  * @author Fabien Potencier <fabien@symfony.com>
  27.  * @author Tobias Schultze <http://tobion.de>
  28.  */
  29. class YamlFileLoader extends FileLoader
  30. {
  31.     private const AVAILABLE_KEYS = [
  32.         'resource', 'type', 'prefix', 'path', 'host', 'schemes', 'methods', 'defaults', 'requirements', 'options', 'condition', 'controller', 'name_prefix', 'trailing_slash_on_root', 'locale', 'format', 'utf8', 'exclude',
  33.     ];
  34.     private $yamlParser;
  36.     /**
  37.      * Loads a Yaml file.
  38.      *
  39.      * @param string      $file A Yaml file path
  40.      * @param string|null $type The resource type
  41.      *
  42.      * @return RouteCollection A RouteCollection instance
  43.      *
  44.      * @throws \InvalidArgumentException When a route can't be parsed because YAML is invalid
  45.      */
  46.     public function load($file, $type = null)
  47.     {
  48.         $path = $this->locator->locate($file);
  50.         if (!stream_is_local($path)) {
  51.             throw new \InvalidArgumentException(sprintf('This is not a local file "%s".', $path));
  52.         }
  54.         if (!file_exists($path)) {
  55.             throw new \InvalidArgumentException(sprintf('File "%s" not found.', $path));
  56.         }
  58.         if (null === $this->yamlParser) {
  59.             $this->yamlParser = new YamlParser();
  60.         }
  62.         try {
  63.             $parsedConfig = $this->yamlParser->parseFile($path, Yaml::PARSE_CONSTANT);
  64.         } catch (ParseException $e) {
  65.             throw new \InvalidArgumentException(sprintf('The file "%s" does not contain valid YAML: ', $path).$e->getMessage(), 0, $e);
  66.         }
  68.         $collection = new RouteCollection();
  69.         $collection->addResource(new FileResource($path));
  71.         // empty file
  72.         if (null === $parsedConfig) {
  73.             return $collection;
  74.         }
  76.         // not an array
  77.         if (!\is_array($parsedConfig)) {
  78.             throw new \InvalidArgumentException(sprintf('The file "%s" must contain a YAML array.', $path));
  79.         }
  81.         foreach ($parsedConfig as $name => $config) {
  82.             $this->validate($config, $name, $path);
  84.             if (isset($config['resource'])) {
  85.                 $this->parseImport($collection, $config, $path, $file);
  86.             } else {
  87.                 $this->parseRoute($collection, $name, $config, $path);
  88.             }
  89.         }
  91.         return $collection;
  92.     }
  94.     /**
  95.      * {@inheritdoc}
  96.      */
  97.     public function supports($resource, $type = null)
  98.     {
  99.         return \is_string($resource) && \in_array(pathinfo($resource, \PATHINFO_EXTENSION), ['yml', 'yaml'], true) && (!$type || 'yaml' === $type);
  100.     }
  102.     /**
  103.      * Parses a route and adds it to the RouteCollection.
  104.      *
  105.      * @param string $name   Route name
  106.      * @param array  $config Route definition
  107.      * @param string $path   Full path of the YAML file being processed
  108.      */
  109.     protected function parseRoute(RouteCollection $collection, $name, array $config, $path)
  110.     {
  111.         $defaults = $config['defaults'] ?? [];
  112.         $requirements = $config['requirements'] ?? [];
  113.         $options = $config['options'] ?? [];
  114.         $host = $config['host'] ?? '';
  115.         $schemes = $config['schemes'] ?? [];
  116.         $methods = $config['methods'] ?? [];
  117.         $condition = $config['condition'] ?? null;
  119.         foreach ($requirements as $placeholder => $requirement) {
  120.             if (\is_int($placeholder)) {
  121.                 @trigger_error(sprintf('A placeholder name must be a string (%d given). Did you forget to specify the placeholder key for the requirement "%s" of route "%s" in "%s"?', $placeholder, $requirement, $name, $path), \E_USER_DEPRECATED);
  122.             }
  123.         }
  125.         if (isset($config['controller'])) {
  126.             $defaults['_controller'] = $config['controller'];
  127.         }
  128.         if (isset($config['locale'])) {
  129.             $defaults['_locale'] = $config['locale'];
  130.         }
  131.         if (isset($config['format'])) {
  132.             $defaults['_format'] = $config['format'];
  133.         }
  134.         if (isset($config['utf8'])) {
  135.             $options['utf8'] = $config['utf8'];
  136.         }
  138.         if (\is_array($config['path'])) {
  139.             $route = new Route('', $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
  141.             foreach ($config['path'] as $locale => $path) {
  142.                 $localizedRoute = clone $route;
  143.                 $localizedRoute->setDefault('_locale', $locale);
  144.                 $localizedRoute->setRequirement('_locale', preg_quote($locale, RouteCompiler::REGEX_DELIMITER));
  145.                 $localizedRoute->setDefault('_canonical_route', $name);
  146.                 $localizedRoute->setPath($path);
  147.                 $collection->add($name.'.'.$locale, $localizedRoute);
  148.             }
  149.         } else {
  150.             $route = new Route($config['path'], $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
  151.             $collection->add($name, $route);
  152.         }
  153.     }
  155.     /**
  156.      * Parses an import and adds the routes in the resource to the RouteCollection.
  157.      *
  158.      * @param array  $config Route definition
  159.      * @param string $path   Full path of the YAML file being processed
  160.      * @param string $file   Loaded file name
  161.      */
  162.     protected function parseImport(RouteCollection $collection, array $config, $path, $file)
  163.     {
  164.         $type = $config['type'] ?? null;
  165.         $prefix = $config['prefix'] ?? '';
  166.         $defaults = $config['defaults'] ?? [];
  167.         $requirements = $config['requirements'] ?? [];
  168.         $options = $config['options'] ?? [];
  169.         $host = $config['host'] ?? null;
  170.         $condition = $config['condition'] ?? null;
  171.         $schemes = $config['schemes'] ?? null;
  172.         $methods = $config['methods'] ?? null;
  173.         $trailingSlashOnRoot = $config['trailing_slash_on_root'] ?? true;
  174.         $exclude = $config['exclude'] ?? null;
  176.         if (isset($config['controller'])) {
  177.             $defaults['_controller'] = $config['controller'];
  178.         }
  179.         if (isset($config['locale'])) {
  180.             $defaults['_locale'] = $config['locale'];
  181.         }
  182.         if (isset($config['format'])) {
  183.             $defaults['_format'] = $config['format'];
  184.         }
  185.         if (isset($config['utf8'])) {
  186.             $options['utf8'] = $config['utf8'];
  187.         }
  189.         $this->setCurrentDir(\dirname($path));
  191.         $imported = $this->import($config['resource'], $type, false, $file, $exclude) ?: [];
  193.         if (!\is_array($imported)) {
  194.             $imported = [$imported];
  195.         }
  197.         foreach ($imported as $subCollection) {
  198.             /* @var $subCollection RouteCollection */
  199.             if (!\is_array($prefix)) {
  200.                 $subCollection->addPrefix($prefix);
  201.                 if (!$trailingSlashOnRoot) {
  202.                     $rootPath = (new Route(trim(trim($prefix), '/').'/'))->getPath();
  203.                     foreach ($subCollection->all() as $route) {
  204.                         if ($route->getPath() === $rootPath) {
  205.                             $route->setPath(rtrim($rootPath, '/'));
  206.                         }
  207.                     }
  208.                 }
  209.             } else {
  210.                 foreach ($prefix as $locale => $localePrefix) {
  211.                     $prefix[$locale] = trim(trim($localePrefix), '/');
  212.                 }
  213.                 foreach ($subCollection->all() as $name => $route) {
  214.                     if (null === $locale = $route->getDefault('_locale')) {
  215.                         $subCollection->remove($name);
  216.                         foreach ($prefix as $locale => $localePrefix) {
  217.                             $localizedRoute = clone $route;
  218.                             $localizedRoute->setDefault('_locale', $locale);
  219.                             $localizedRoute->setRequirement('_locale', preg_quote($locale, RouteCompiler::REGEX_DELIMITER));
  220.                             $localizedRoute->setDefault('_canonical_route', $name);
  221.                             $localizedRoute->setPath($localePrefix.(!$trailingSlashOnRoot && '/' === $route->getPath() ? '' : $route->getPath()));
  222.                             $subCollection->add($name.'.'.$locale, $localizedRoute);
  223.                         }
  224.                     } elseif (!isset($prefix[$locale])) {
  225.                         throw new \InvalidArgumentException(sprintf('Route "%s" with locale "%s" is missing a corresponding prefix when imported in "%s".', $name, $locale, $file));
  226.                     } else {
  227.                         $route->setPath($prefix[$locale].(!$trailingSlashOnRoot && '/' === $route->getPath() ? '' : $route->getPath()));
  228.                         $subCollection->add($name, $route);
  229.                     }
  230.                 }
  231.             }
  233.             if (null !== $host) {
  234.                 $subCollection->setHost($host);
  235.             }
  236.             if (null !== $condition) {
  237.                 $subCollection->setCondition($condition);
  238.             }
  239.             if (null !== $schemes) {
  240.                 $subCollection->setSchemes($schemes);
  241.             }
  242.             if (null !== $methods) {
  243.                 $subCollection->setMethods($methods);
  244.             }
  245.             $subCollection->addDefaults($defaults);
  246.             $subCollection->addRequirements($requirements);
  247.             $subCollection->addOptions($options);
  249.             if (isset($config['name_prefix'])) {
  250.                 $subCollection->addNamePrefix($config['name_prefix']);
  251.             }
  253.             $collection->addCollection($subCollection);
  254.         }
  255.     }
  257.     /**
  258.      * Validates the route configuration.
  259.      *
  260.      * @param array  $config A resource config
  261.      * @param string $name   The config key
  262.      * @param string $path   The loaded file path
  263.      *
  264.      * @throws \InvalidArgumentException If one of the provided config keys is not supported,
  265.      *                                   something is missing or the combination is nonsense
  266.      */
  267.     protected function validate($config, $name, $path)
  268.     {
  269.         if (!\is_array($config)) {
  270.             throw new \InvalidArgumentException(sprintf('The definition of "%s" in "%s" must be a YAML array.', $name, $path));
  271.         }
  272.         if ($extraKeys = array_diff(array_keys($config), self::AVAILABLE_KEYS)) {
  273.             throw new \InvalidArgumentException(sprintf('The routing file "%s" contains unsupported keys for "%s": "%s". Expected one of: "%s".', $path, $name, implode('", "', $extraKeys), implode('", "', self::AVAILABLE_KEYS)));
  274.         }
  275.         if (isset($config['resource']) && isset($config['path'])) {
  276.             throw new \InvalidArgumentException(sprintf('The routing file "%s" must not specify both the "resource" key and the "path" key for "%s". Choose between an import and a route definition.', $path, $name));
  277.         }
  278.         if (!isset($config['resource']) && isset($config['type'])) {
  279.             throw new \InvalidArgumentException(sprintf('The "type" key for the route definition "%s" in "%s" is unsupported. It is only available for imports in combination with the "resource" key.', $name, $path));
  280.         }
  281.         if (!isset($config['resource']) && !isset($config['path'])) {
  282.             throw new \InvalidArgumentException(sprintf('You must define a "path" for the route "%s" in file "%s".', $name, $path));
  283.         }
  284.         if (isset($config['controller']) && isset($config['defaults']['_controller'])) {
  285.             throw new \InvalidArgumentException(sprintf('The routing file "%s" must not specify both the "controller" key and the defaults key "_controller" for "%s".', $path, $name));
  286.         }
  287.     }
  288. }