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

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