vendor/symfony/dependency-injection/Loader/YamlFileLoader.php line 508

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\DependencyInjection\Loader;
  14. use Symfony\Component\DependencyInjection\Alias;
  15. use Symfony\Component\DependencyInjection\Argument\AbstractArgument;
  16. use Symfony\Component\DependencyInjection\Argument\BoundArgument;
  17. use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
  18. use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
  19. use Symfony\Component\DependencyInjection\Argument\ServiceLocatorArgument;
  20. use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
  21. use Symfony\Component\DependencyInjection\ChildDefinition;
  22. use Symfony\Component\DependencyInjection\ContainerBuilder;
  23. use Symfony\Component\DependencyInjection\ContainerInterface;
  24. use Symfony\Component\DependencyInjection\Definition;
  25. use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  26. use Symfony\Component\DependencyInjection\Exception\RuntimeException;
  27. use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
  28. use Symfony\Component\DependencyInjection\Reference;
  29. use Symfony\Component\ExpressionLanguage\Expression;
  30. use Symfony\Component\Yaml\Exception\ParseException;
  31. use Symfony\Component\Yaml\Parser as YamlParser;
  32. use Symfony\Component\Yaml\Tag\TaggedValue;
  33. use Symfony\Component\Yaml\Yaml;
  35. /**
  36.  * YamlFileLoader loads YAML files service definitions.
  37.  *
  38.  * @author Fabien Potencier <fabien@symfony.com>
  39.  */
  40. class YamlFileLoader extends FileLoader
  41. {
  42.     private const SERVICE_KEYWORDS = [
  43.         'alias' => 'alias',
  44.         'parent' => 'parent',
  45.         'class' => 'class',
  46.         'shared' => 'shared',
  47.         'synthetic' => 'synthetic',
  48.         'lazy' => 'lazy',
  49.         'public' => 'public',
  50.         'abstract' => 'abstract',
  51.         'deprecated' => 'deprecated',
  52.         'factory' => 'factory',
  53.         'file' => 'file',
  54.         'arguments' => 'arguments',
  55.         'properties' => 'properties',
  56.         'configurator' => 'configurator',
  57.         'calls' => 'calls',
  58.         'tags' => 'tags',
  59.         'decorates' => 'decorates',
  60.         'decoration_inner_name' => 'decoration_inner_name',
  61.         'decoration_priority' => 'decoration_priority',
  62.         'decoration_on_invalid' => 'decoration_on_invalid',
  63.         'autowire' => 'autowire',
  64.         'autoconfigure' => 'autoconfigure',
  65.         'bind' => 'bind',
  66.     ];
  68.     private const PROTOTYPE_KEYWORDS = [
  69.         'resource' => 'resource',
  70.         'namespace' => 'namespace',
  71.         'exclude' => 'exclude',
  72.         'parent' => 'parent',
  73.         'shared' => 'shared',
  74.         'lazy' => 'lazy',
  75.         'public' => 'public',
  76.         'abstract' => 'abstract',
  77.         'deprecated' => 'deprecated',
  78.         'factory' => 'factory',
  79.         'arguments' => 'arguments',
  80.         'properties' => 'properties',
  81.         'configurator' => 'configurator',
  82.         'calls' => 'calls',
  83.         'tags' => 'tags',
  84.         'autowire' => 'autowire',
  85.         'autoconfigure' => 'autoconfigure',
  86.         'bind' => 'bind',
  87.     ];
  89.     private const INSTANCEOF_KEYWORDS = [
  90.         'shared' => 'shared',
  91.         'lazy' => 'lazy',
  92.         'public' => 'public',
  93.         'properties' => 'properties',
  94.         'configurator' => 'configurator',
  95.         'calls' => 'calls',
  96.         'tags' => 'tags',
  97.         'autowire' => 'autowire',
  98.         'bind' => 'bind',
  99.     ];
  101.     private const DEFAULTS_KEYWORDS = [
  102.         'public' => 'public',
  103.         'tags' => 'tags',
  104.         'autowire' => 'autowire',
  105.         'autoconfigure' => 'autoconfigure',
  106.         'bind' => 'bind',
  107.     ];
  109.     private $yamlParser;
  111.     private $anonymousServicesCount;
  112.     private $anonymousServicesSuffix;
  114.     protected $autoRegisterAliasesForSinglyImplementedInterfaces = false;
  116.     /**
  117.      * {@inheritdoc}
  118.      */
  119.     public function load($resource, string $type = null)
  120.     {
  121.         $path = $this->locator->locate($resource);
  123.         $content = $this->loadFile($path);
  125.         $this->container->fileExists($path);
  127.         // empty file
  128.         if (null === $content) {
  129.             return null;
  130.         }
  132.         $this->loadContent($content, $path);
  134.         // per-env configuration
  135.         if ($this->env && isset($content['when@'.$this->env])) {
  136.             if (!\is_array($content['when@'.$this->env])) {
  137.                 throw new InvalidArgumentException(sprintf('The "when@%s" key should contain an array in "%s". Check your YAML syntax.', $this->env, $path));
  138.             }
  140.             $env = $this->env;
  141.             $this->env = null;
  142.             try {
  143.                 $this->loadContent($content['when@'.$env], $path);
  144.             } finally {
  145.                 $this->env = $env;
  146.             }
  147.         }
  149.         return null;
  150.     }
  152.     private function loadContent(array $content, string $path)
  153.     {
  154.         // imports
  155.         $this->parseImports($content, $path);
  157.         // parameters
  158.         if (isset($content['parameters'])) {
  159.             if (!\is_array($content['parameters'])) {
  160.                 throw new InvalidArgumentException(sprintf('The "parameters" key should contain an array in "%s". Check your YAML syntax.', $path));
  161.             }
  163.             foreach ($content['parameters'] as $key => $value) {
  164.                 $this->container->setParameter($key, $this->resolveServices($value, $path, true));
  165.             }
  166.         }
  168.         // extensions
  169.         $this->loadFromExtensions($content);
  171.         // services
  172.         $this->anonymousServicesCount = 0;
  173.         $this->anonymousServicesSuffix = '~'.ContainerBuilder::hash($path);
  174.         $this->setCurrentDir(\dirname($path));
  175.         try {
  176.             $this->parseDefinitions($content, $path);
  177.         } finally {
  178.             $this->instanceof = [];
  179.             $this->registerAliasesForSinglyImplementedInterfaces();
  180.         }
  181.     }
  183.     /**
  184.      * {@inheritdoc}
  185.      */
  186.     public function supports($resource, string $type = null)
  187.     {
  188.         if (!\is_string($resource)) {
  189.             return false;
  190.         }
  192.         if (null === $type && \in_array(pathinfo($resource, \PATHINFO_EXTENSION), ['yaml', 'yml'], true)) {
  193.             return true;
  194.         }
  196.         return \in_array($type, ['yaml', 'yml'], true);
  197.     }
  199.     private function parseImports(array $content, string $file)
  200.     {
  201.         if (!isset($content['imports'])) {
  202.             return;
  203.         }
  205.         if (!\is_array($content['imports'])) {
  206.             throw new InvalidArgumentException(sprintf('The "imports" key should contain an array in "%s". Check your YAML syntax.', $file));
  207.         }
  209.         $defaultDirectory = \dirname($file);
  210.         foreach ($content['imports'] as $import) {
  211.             if (!\is_array($import)) {
  212.                 $import = ['resource' => $import];
  213.             }
  214.             if (!isset($import['resource'])) {
  215.                 throw new InvalidArgumentException(sprintf('An import should provide a resource in "%s". Check your YAML syntax.', $file));
  216.             }
  218.             $this->setCurrentDir($defaultDirectory);
  219.             $this->import($import['resource'], $import['type'] ?? null, $import['ignore_errors'] ?? false, $file);
  220.         }
  221.     }
  223.     private function parseDefinitions(array $content, string $file, bool $trackBindings = true)
  224.     {
  225.         if (!isset($content['services'])) {
  226.             return;
  227.         }
  229.         if (!\is_array($content['services'])) {
  230.             throw new InvalidArgumentException(sprintf('The "services" key should contain an array in "%s". Check your YAML syntax.', $file));
  231.         }
  233.         if (\array_key_exists('_instanceof', $content['services'])) {
  234.             $instanceof = $content['services']['_instanceof'];
  235.             unset($content['services']['_instanceof']);
  237.             if (!\is_array($instanceof)) {
  238.                 throw new InvalidArgumentException(sprintf('Service "_instanceof" key must be an array, "%s" given in "%s".', get_debug_type($instanceof), $file));
  239.             }
  240.             $this->instanceof = [];
  241.             $this->isLoadingInstanceof = true;
  242.             foreach ($instanceof as $id => $service) {
  243.                 if (!$service || !\is_array($service)) {
  244.                     throw new InvalidArgumentException(sprintf('Type definition "%s" must be a non-empty array within "_instanceof" in "%s". Check your YAML syntax.', $id, $file));
  245.                 }
  246.                 if (\is_string($service) && str_starts_with($service, '@')) {
  247.                     throw new InvalidArgumentException(sprintf('Type definition "%s" cannot be an alias within "_instanceof" in "%s". Check your YAML syntax.', $id, $file));
  248.                 }
  249.                 $this->parseDefinition($id, $service, $file, [], false, $trackBindings);
  250.             }
  251.         }
  253.         $this->isLoadingInstanceof = false;
  254.         $defaults = $this->parseDefaults($content, $file);
  255.         foreach ($content['services'] as $id => $service) {
  256.             $this->parseDefinition($id, $service, $file, $defaults, false, $trackBindings);
  257.         }
  258.     }
  260.     /**
  261.      * @throws InvalidArgumentException
  262.      */
  263.     private function parseDefaults(array &$content, string $file): array
  264.     {
  265.         if (!\array_key_exists('_defaults', $content['services'])) {
  266.             return [];
  267.         }
  268.         $defaults = $content['services']['_defaults'];
  269.         unset($content['services']['_defaults']);
  271.         if (!\is_array($defaults)) {
  272.             throw new InvalidArgumentException(sprintf('Service "_defaults" key must be an array, "%s" given in "%s".', get_debug_type($defaults), $file));
  273.         }
  275.         foreach ($defaults as $key => $default) {
  276.             if (!isset(self::DEFAULTS_KEYWORDS[$key])) {
  277.                 throw new InvalidArgumentException(sprintf('The configuration key "%s" cannot be used to define a default value in "%s". Allowed keys are "%s".', $key, $file, implode('", "', self::DEFAULTS_KEYWORDS)));
  278.             }
  279.         }
  281.         if (isset($defaults['tags'])) {
  282.             if (!\is_array($tags = $defaults['tags'])) {
  283.                 throw new InvalidArgumentException(sprintf('Parameter "tags" in "_defaults" must be an array in "%s". Check your YAML syntax.', $file));
  284.             }
  286.             foreach ($tags as $tag) {
  287.                 if (!\is_array($tag)) {
  288.                     $tag = ['name' => $tag];
  289.                 }
  291.                 if (1 === \count($tag) && \is_array(current($tag))) {
  292.                     $name = key($tag);
  293.                     $tag = current($tag);
  294.                 } else {
  295.                     if (!isset($tag['name'])) {
  296.                         throw new InvalidArgumentException(sprintf('A "tags" entry in "_defaults" is missing a "name" key in "%s".', $file));
  297.                     }
  298.                     $name = $tag['name'];
  299.                     unset($tag['name']);
  300.                 }
  302.                 if (!\is_string($name) || '' === $name) {
  303.                     throw new InvalidArgumentException(sprintf('The tag name in "_defaults" must be a non-empty string in "%s".', $file));
  304.                 }
  306.                 foreach ($tag as $attribute => $value) {
  307.                     if (!\is_scalar($value) && null !== $value) {
  308.                         throw new InvalidArgumentException(sprintf('Tag "%s", attribute "%s" in "_defaults" must be of a scalar-type in "%s". Check your YAML syntax.', $name, $attribute, $file));
  309.                     }
  310.                 }
  311.             }
  312.         }
  314.         if (isset($defaults['bind'])) {
  315.             if (!\is_array($defaults['bind'])) {
  316.                 throw new InvalidArgumentException(sprintf('Parameter "bind" in "_defaults" must be an array in "%s". Check your YAML syntax.', $file));
  317.             }
  319.             foreach ($this->resolveServices($defaults['bind'], $file) as $argument => $value) {
  320.                 $defaults['bind'][$argument] = new BoundArgument($value, true, BoundArgument::DEFAULTS_BINDING, $file);
  321.             }
  322.         }
  324.         return $defaults;
  325.     }
  327.     private function isUsingShortSyntax(array $service): bool
  328.     {
  329.         foreach ($service as $key => $value) {
  330.             if (\is_string($key) && ('' === $key || ('$' !== $key[0] && !str_contains($key, '\\')))) {
  331.                 return false;
  332.             }
  333.         }
  335.         return true;
  336.     }
  338.     /**
  339.      * Parses a definition.
  340.      *
  341.      * @param array|string|null $service
  342.      *
  343.      * @throws InvalidArgumentException When tags are invalid
  344.      */
  345.     private function parseDefinition(string $id, $service, string $file, array $defaults, bool $return = false, bool $trackBindings = true)
  346.     {
  347.         if (preg_match('/^_[a-zA-Z0-9_]*$/', $id)) {
  348.             throw new InvalidArgumentException(sprintf('Service names that start with an underscore are reserved. Rename the "%s" service or define it in XML instead.', $id));
  349.         }
  351.         if (\is_string($service) && str_starts_with($service, '@')) {
  352.             $alias = new Alias(substr($service, 1));
  354.             if (isset($defaults['public'])) {
  355.                 $alias->setPublic($defaults['public']);
  356.             }
  358.             return $return ? $alias : $this->container->setAlias($id, $alias);
  359.         }
  361.         if (\is_array($service) && $this->isUsingShortSyntax($service)) {
  362.             $service = ['arguments' => $service];
  363.         }
  365.         if (null === $service) {
  366.             $service = [];
  367.         }
  369.         if (!\is_array($service)) {
  370.             throw new InvalidArgumentException(sprintf('A service definition must be an array or a string starting with "@" but "%s" found for service "%s" in "%s". Check your YAML syntax.', get_debug_type($service), $id, $file));
  371.         }
  373.         if (isset($service['stack'])) {
  374.             if (!\is_array($service['stack'])) {
  375.                 throw new InvalidArgumentException(sprintf('A stack must be an array of definitions, "%s" given for service "%s" in "%s". Check your YAML syntax.', get_debug_type($service), $id, $file));
  376.             }
  378.             $stack = [];
  380.             foreach ($service['stack'] as $k => $frame) {
  381.                 if (\is_array($frame) && 1 === \count($frame) && !isset(self::SERVICE_KEYWORDS[key($frame)])) {
  382.                     $frame = [
  383.                         'class' => key($frame),
  384.                         'arguments' => current($frame),
  385.                     ];
  386.                 }
  388.                 if (\is_array($frame) && isset($frame['stack'])) {
  389.                     throw new InvalidArgumentException(sprintf('Service stack "%s" cannot contain another stack in "%s".', $id, $file));
  390.                 }
  392.                 $definition = $this->parseDefinition($id.'" at index "'.$k, $frame, $file, $defaults, true);
  394.                 if ($definition instanceof Definition) {
  395.                     $definition->setInstanceofConditionals($this->instanceof);
  396.                 }
  398.                 $stack[$k] = $definition;
  399.             }
  401.             if ($diff = array_diff(array_keys($service), ['stack', 'public', 'deprecated'])) {
  402.                 throw new InvalidArgumentException(sprintf('Invalid attribute "%s"; supported ones are "public" and "deprecated" for service "%s" in "%s". Check your YAML syntax.', implode('", "', $diff), $id, $file));
  403.             }
  405.             $service = [
  406.                 'parent' => '',
  407.                 'arguments' => $stack,
  408.                 'tags' => ['container.stack'],
  409.                 'public' => $service['public'] ?? null,
  410.                 'deprecated' => $service['deprecated'] ?? null,
  411.             ];
  412.         }
  414.         $definition = isset($service[0]) && $service[0] instanceof Definition ? array_shift($service) : null;
  415.         $return = null === $definition ? $return : true;
  417.         $this->checkDefinition($id, $service, $file);
  419.         if (isset($service['alias'])) {
  420.             $alias = new Alias($service['alias']);
  422.             if (isset($service['public'])) {
  423.                 $alias->setPublic($service['public']);
  424.             } elseif (isset($defaults['public'])) {
  425.                 $alias->setPublic($defaults['public']);
  426.             }
  428.             foreach ($service as $key => $value) {
  429.                 if (!\in_array($key, ['alias', 'public', 'deprecated'])) {
  430.                     throw new InvalidArgumentException(sprintf('The configuration key "%s" is unsupported for the service "%s" which is defined as an alias in "%s". Allowed configuration keys for service aliases are "alias", "public" and "deprecated".', $key, $id, $file));
  431.                 }
  433.                 if ('deprecated' === $key) {
  434.                     $deprecation = \is_array($value) ? $value : ['message' => $value];
  436.                     if (!isset($deprecation['package'])) {
  437.                         trigger_deprecation('symfony/dependency-injection', '5.1', 'Not setting the attribute "package" of the "deprecated" option in "%s" is deprecated.', $file);
  438.                     }
  440.                     if (!isset($deprecation['version'])) {
  441.                         trigger_deprecation('symfony/dependency-injection', '5.1', 'Not setting the attribute "version" of the "deprecated" option in "%s" is deprecated.', $file);
  442.                     }
  444.                     $alias->setDeprecated($deprecation['package'] ?? '', $deprecation['version'] ?? '', $deprecation['message'] ?? '');
  445.                 }
  446.             }
  448.             return $return ? $alias : $this->container->setAlias($id, $alias);
  449.         }
  451.         if (null !== $definition) {
  452.             // no-op
  453.         } elseif ($this->isLoadingInstanceof) {
  454.             $definition = new ChildDefinition('');
  455.         } elseif (isset($service['parent'])) {
  456.             if ('' !== $service['parent'] && '@' === $service['parent'][0]) {
  457.                 throw new InvalidArgumentException(sprintf('The value of the "parent" option for the "%s" service must be the id of the service without the "@" prefix (replace "%s" with "%s").', $id, $service['parent'], substr($service['parent'], 1)));
  458.             }
  460.             $definition = new ChildDefinition($service['parent']);
  461.         } else {
  462.             $definition = new Definition();
  463.         }
  465.         if (isset($defaults['public'])) {
  466.             $definition->setPublic($defaults['public']);
  467.         }
  468.         if (isset($defaults['autowire'])) {
  469.             $definition->setAutowired($defaults['autowire']);
  470.         }
  471.         if (isset($defaults['autoconfigure'])) {
  472.             $definition->setAutoconfigured($defaults['autoconfigure']);
  473.         }
  475.         $definition->setChanges([]);
  477.         if (isset($service['class'])) {
  478.             $definition->setClass($service['class']);
  479.         }
  481.         if (isset($service['shared'])) {
  482.             $definition->setShared($service['shared']);
  483.         }
  485.         if (isset($service['synthetic'])) {
  486.             $definition->setSynthetic($service['synthetic']);
  487.         }
  489.         if (isset($service['lazy'])) {
  490.             $definition->setLazy((bool) $service['lazy']);
  491.             if (\is_string($service['lazy'])) {
  492.                 $definition->addTag('proxy', ['interface' => $service['lazy']]);
  493.             }
  494.         }
  496.         if (isset($service['public'])) {
  497.             $definition->setPublic($service['public']);
  498.         }
  500.         if (isset($service['abstract'])) {
  501.             $definition->setAbstract($service['abstract']);
  502.         }
  504.         if (isset($service['deprecated'])) {
  505.             $deprecation = \is_array($service['deprecated']) ? $service['deprecated'] : ['message' => $service['deprecated']];
  507.             if (!isset($deprecation['package'])) {
  508.                 trigger_deprecation('symfony/dependency-injection', '5.1', 'Not setting the attribute "package" of the "deprecated" option in "%s" is deprecated.', $file);
  509.             }
  511.             if (!isset($deprecation['version'])) {
  512.                 trigger_deprecation('symfony/dependency-injection', '5.1', 'Not setting the attribute "version" of the "deprecated" option in "%s" is deprecated.', $file);
  513.             }
  515.             $definition->setDeprecated($deprecation['package'] ?? '', $deprecation['version'] ?? '', $deprecation['message'] ?? '');
  516.         }
  518.         if (isset($service['factory'])) {
  519.             $definition->setFactory($this->parseCallable($service['factory'], 'factory', $id, $file));
  520.         }
  522.         if (isset($service['file'])) {
  523.             $definition->setFile($service['file']);
  524.         }
  526.         if (isset($service['arguments'])) {
  527.             $definition->setArguments($this->resolveServices($service['arguments'], $file));
  528.         }
  530.         if (isset($service['properties'])) {
  531.             $definition->setProperties($this->resolveServices($service['properties'], $file));
  532.         }
  534.         if (isset($service['configurator'])) {
  535.             $definition->setConfigurator($this->parseCallable($service['configurator'], 'configurator', $id, $file));
  536.         }
  538.         if (isset($service['calls'])) {
  539.             if (!\is_array($service['calls'])) {
  540.                 throw new InvalidArgumentException(sprintf('Parameter "calls" must be an array for service "%s" in "%s". Check your YAML syntax.', $id, $file));
  541.             }
  543.             foreach ($service['calls'] as $k => $call) {
  544.                 if (!\is_array($call) && (!\is_string($k) || !$call instanceof TaggedValue)) {
  545.                     throw new InvalidArgumentException(sprintf('Invalid method call for service "%s": expected map or array, "%s" given in "%s".', $id, $call instanceof TaggedValue ? '!'.$call->getTag() : get_debug_type($call), $file));
  546.                 }
  548.                 if (\is_string($k)) {
  549.                     throw new InvalidArgumentException(sprintf('Invalid method call for service "%s", did you forgot a leading dash before "%s: ..." in "%s"?', $id, $k, $file));
  550.                 }
  552.                 if (isset($call['method']) && \is_string($call['method'])) {
  553.                     $method = $call['method'];
  554.                     $args = $call['arguments'] ?? [];
  555.                     $returnsClone = $call['returns_clone'] ?? false;
  556.                 } else {
  557.                     if (1 === \count($call) && \is_string(key($call))) {
  558.                         $method = key($call);
  559.                         $args = $call[$method];
  561.                         if ($args instanceof TaggedValue) {
  562.                             if ('returns_clone' !== $args->getTag()) {
  563.                                 throw new InvalidArgumentException(sprintf('Unsupported tag "!%s", did you mean "!returns_clone" for service "%s" in "%s"?', $args->getTag(), $id, $file));
  564.                             }
  566.                             $returnsClone = true;
  567.                             $args = $args->getValue();
  568.                         } else {
  569.                             $returnsClone = false;
  570.                         }
  571.                     } elseif (empty($call[0])) {
  572.                         throw new InvalidArgumentException(sprintf('Invalid call for service "%s": the method must be defined as the first index of an array or as the only key of a map in "%s".', $id, $file));
  573.                     } else {
  574.                         $method = $call[0];
  575.                         $args = $call[1] ?? [];
  576.                         $returnsClone = $call[2] ?? false;
  577.                     }
  578.                 }
  580.                 if (!\is_array($args)) {
  581.                     throw new InvalidArgumentException(sprintf('The second parameter for function call "%s" must be an array of its arguments for service "%s" in "%s". Check your YAML syntax.', $method, $id, $file));
  582.                 }
  584.                 $args = $this->resolveServices($args, $file);
  585.                 $definition->addMethodCall($method, $args, $returnsClone);
  586.             }
  587.         }
  589.         $tags = $service['tags'] ?? [];
  590.         if (!\is_array($tags)) {
  591.             throw new InvalidArgumentException(sprintf('Parameter "tags" must be an array for service "%s" in "%s". Check your YAML syntax.', $id, $file));
  592.         }
  594.         if (isset($defaults['tags'])) {
  595.             $tags = array_merge($tags, $defaults['tags']);
  596.         }
  598.         foreach ($tags as $tag) {
  599.             if (!\is_array($tag)) {
  600.                 $tag = ['name' => $tag];
  601.             }
  603.             if (1 === \count($tag) && \is_array(current($tag))) {
  604.                 $name = key($tag);
  605.                 $tag = current($tag);
  606.             } else {
  607.                 if (!isset($tag['name'])) {
  608.                     throw new InvalidArgumentException(sprintf('A "tags" entry is missing a "name" key for service "%s" in "%s".', $id, $file));
  609.                 }
  610.                 $name = $tag['name'];
  611.                 unset($tag['name']);
  612.             }
  614.             if (!\is_string($name) || '' === $name) {
  615.                 throw new InvalidArgumentException(sprintf('The tag name for service "%s" in "%s" must be a non-empty string.', $id, $file));
  616.             }
  618.             foreach ($tag as $attribute => $value) {
  619.                 if (!\is_scalar($value) && null !== $value) {
  620.                     throw new InvalidArgumentException(sprintf('A "tags" attribute must be of a scalar-type for service "%s", tag "%s", attribute "%s" in "%s". Check your YAML syntax.', $id, $name, $attribute, $file));
  621.                 }
  622.             }
  624.             $definition->addTag($name, $tag);
  625.         }
  627.         if (null !== $decorates = $service['decorates'] ?? null) {
  628.             if ('' !== $decorates && '@' === $decorates[0]) {
  629.                 throw new InvalidArgumentException(sprintf('The value of the "decorates" option for the "%s" service must be the id of the service without the "@" prefix (replace "%s" with "%s").', $id, $service['decorates'], substr($decorates, 1)));
  630.             }
  632.             $decorationOnInvalid = \array_key_exists('decoration_on_invalid', $service) ? $service['decoration_on_invalid'] : 'exception';
  633.             if ('exception' === $decorationOnInvalid) {
  634.                 $invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;
  635.             } elseif ('ignore' === $decorationOnInvalid) {
  636.                 $invalidBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
  637.             } elseif (null === $decorationOnInvalid) {
  638.                 $invalidBehavior = ContainerInterface::NULL_ON_INVALID_REFERENCE;
  639.             } elseif ('null' === $decorationOnInvalid) {
  640.                 throw new InvalidArgumentException(sprintf('Invalid value "%s" for attribute "decoration_on_invalid" on service "%s". Did you mean null (without quotes) in "%s"?', $decorationOnInvalid, $id, $file));
  641.             } else {
  642.                 throw new InvalidArgumentException(sprintf('Invalid value "%s" for attribute "decoration_on_invalid" on service "%s". Did you mean "exception", "ignore" or null in "%s"?', $decorationOnInvalid, $id, $file));
  643.             }
  645.             $renameId = $service['decoration_inner_name'] ?? null;
  646.             $priority = $service['decoration_priority'] ?? 0;
  648.             $definition->setDecoratedService($decorates, $renameId, $priority, $invalidBehavior);
  649.         }
  651.         if (isset($service['autowire'])) {
  652.             $definition->setAutowired($service['autowire']);
  653.         }
  655.         if (isset($defaults['bind']) || isset($service['bind'])) {
  656.             // deep clone, to avoid multiple process of the same instance in the passes
  657.             $bindings = $definition->getBindings();
  658.             $bindings += isset($defaults['bind']) ? unserialize(serialize($defaults['bind'])) : [];
  660.             if (isset($service['bind'])) {
  661.                 if (!\is_array($service['bind'])) {
  662.                     throw new InvalidArgumentException(sprintf('Parameter "bind" must be an array for service "%s" in "%s". Check your YAML syntax.', $id, $file));
  663.                 }
  665.                 $bindings = array_merge($bindings, $this->resolveServices($service['bind'], $file));
  666.                 $bindingType = $this->isLoadingInstanceof ? BoundArgument::INSTANCEOF_BINDING : BoundArgument::SERVICE_BINDING;
  667.                 foreach ($bindings as $argument => $value) {
  668.                     if (!$value instanceof BoundArgument) {
  669.                         $bindings[$argument] = new BoundArgument($value, $trackBindings, $bindingType, $file);
  670.                     }
  671.                 }
  672.             }
  674.             $definition->setBindings($bindings);
  675.         }
  677.         if (isset($service['autoconfigure'])) {
  678.             $definition->setAutoconfigured($service['autoconfigure']);
  679.         }
  681.         if (\array_key_exists('namespace', $service) && !\array_key_exists('resource', $service)) {
  682.             throw new InvalidArgumentException(sprintf('A "resource" attribute must be set when the "namespace" attribute is set for service "%s" in "%s". Check your YAML syntax.', $id, $file));
  683.         }
  685.         if ($return) {
  686.             if (\array_key_exists('resource', $service)) {
  687.                 throw new InvalidArgumentException(sprintf('Invalid "resource" attribute found for service "%s" in "%s". Check your YAML syntax.', $id, $file));
  688.             }
  690.             return $definition;
  691.         }
  693.         if (\array_key_exists('resource', $service)) {
  694.             if (!\is_string($service['resource'])) {
  695.                 throw new InvalidArgumentException(sprintf('A "resource" attribute must be of type string for service "%s" in "%s". Check your YAML syntax.', $id, $file));
  696.             }
  697.             $exclude = $service['exclude'] ?? null;
  698.             $namespace = $service['namespace'] ?? $id;
  699.             $this->registerClasses($definition, $namespace, $service['resource'], $exclude);
  700.         } else {
  701.             $this->setDefinition($id, $definition);
  702.         }
  703.     }
  705.     /**
  706.      * Parses a callable.
  707.      *
  708.      * @param string|array $callable A callable reference
  709.      *
  710.      * @throws InvalidArgumentException When errors occur
  711.      *
  712.      * @return string|array|Reference
  713.      */
  714.     private function parseCallable($callable, string $parameter, string $id, string $file)
  715.     {
  716.         if (\is_string($callable)) {
  717.             if ('' !== $callable && '@' === $callable[0]) {
  718.                 if (!str_contains($callable, ':')) {
  719.                     return [$this->resolveServices($callable, $file), '__invoke'];
  720.                 }
  722.                 throw new InvalidArgumentException(sprintf('The value of the "%s" option for the "%s" service must be the id of the service without the "@" prefix (replace "%s" with "%s" in "%s").', $parameter, $id, $callable, substr($callable, 1), $file));
  723.             }
  725.             return $callable;
  726.         }
  728.         if (\is_array($callable)) {
  729.             if (isset($callable[0]) && isset($callable[1])) {
  730.                 return [$this->resolveServices($callable[0], $file), $callable[1]];
  731.             }
  733.             if ('factory' === $parameter && isset($callable[1]) && null === $callable[0]) {
  734.                 return $callable;
  735.             }
  737.             throw new InvalidArgumentException(sprintf('Parameter "%s" must contain an array with two elements for service "%s" in "%s". Check your YAML syntax.', $parameter, $id, $file));
  738.         }
  740.         throw new InvalidArgumentException(sprintf('Parameter "%s" must be a string or an array for service "%s" in "%s". Check your YAML syntax.', $parameter, $id, $file));
  741.     }
  743.     /**
  744.      * Loads a YAML file.
  745.      *
  746.      * @return array|null
  747.      *
  748.      * @throws InvalidArgumentException when the given file is not a local file or when it does not exist
  749.      */
  750.     protected function loadFile(string $file)
  751.     {
  752.         if (!class_exists(\Symfony\Component\Yaml\Parser::class)) {
  753.             throw new RuntimeException('Unable to load YAML config files as the Symfony Yaml Component is not installed.');
  754.         }
  756.         if (!stream_is_local($file)) {
  757.             throw new InvalidArgumentException(sprintf('This is not a local file "%s".', $file));
  758.         }
  760.         if (!is_file($file)) {
  761.             throw new InvalidArgumentException(sprintf('The file "%s" does not exist.', $file));
  762.         }
  764.         if (null === $this->yamlParser) {
  765.             $this->yamlParser = new YamlParser();
  766.         }
  768.         try {
  769.             $configuration = $this->yamlParser->parseFile($file, Yaml::PARSE_CONSTANT | Yaml::PARSE_CUSTOM_TAGS);
  770.         } catch (ParseException $e) {
  771.             throw new InvalidArgumentException(sprintf('The file "%s" does not contain valid YAML: ', $file).$e->getMessage(), 0, $e);
  772.         }
  774.         return $this->validate($configuration, $file);
  775.     }
  777.     /**
  778.      * Validates a YAML file.
  779.      *
  780.      * @throws InvalidArgumentException When service file is not valid
  781.      */
  782.     private function validate($content, string $file): ?array
  783.     {
  784.         if (null === $content) {
  785.             return $content;
  786.         }
  788.         if (!\is_array($content)) {
  789.             throw new InvalidArgumentException(sprintf('The service file "%s" is not valid. It should contain an array. Check your YAML syntax.', $file));
  790.         }
  792.         foreach ($content as $namespace => $data) {
  793.             if (\in_array($namespace, ['imports', 'parameters', 'services']) || 0 === strpos($namespace, 'when@')) {
  794.                 continue;
  795.             }
  797.             if (!$this->container->hasExtension($namespace)) {
  798.                 $extensionNamespaces = array_filter(array_map(function (ExtensionInterface $ext) { return $ext->getAlias(); }, $this->container->getExtensions()));
  799.                 throw new InvalidArgumentException(sprintf('There is no extension able to load the configuration for "%s" (in "%s"). Looked for namespace "%s", found "%s".', $namespace, $file, $namespace, $extensionNamespaces ? sprintf('"%s"', implode('", "', $extensionNamespaces)) : 'none'));
  800.             }
  801.         }
  803.         return $content;
  804.     }
  806.     /**
  807.      * @return mixed
  808.      */
  809.     private function resolveServices($value, string $file, bool $isParameter = false)
  810.     {
  811.         if ($value instanceof TaggedValue) {
  812.             $argument = $value->getValue();
  813.             if ('iterator' === $value->getTag()) {
  814.                 if (!\is_array($argument)) {
  815.                     throw new InvalidArgumentException(sprintf('"!iterator" tag only accepts sequences in "%s".', $file));
  816.                 }
  817.                 $argument = $this->resolveServices($argument, $file, $isParameter);
  818.                 try {
  819.                     return new IteratorArgument($argument);
  820.                 } catch (InvalidArgumentException $e) {
  821.                     throw new InvalidArgumentException(sprintf('"!iterator" tag only accepts arrays of "@service" references in "%s".', $file));
  822.                 }
  823.             }
  824.             if ('service_closure' === $value->getTag()) {
  825.                 $argument = $this->resolveServices($argument, $file, $isParameter);
  827.                 if (!$argument instanceof Reference) {
  828.                     throw new InvalidArgumentException(sprintf('"!service_closure" tag only accepts service references in "%s".', $file));
  829.                 }
  831.                 return new ServiceClosureArgument($argument);
  832.             }
  833.             if ('service_locator' === $value->getTag()) {
  834.                 if (!\is_array($argument)) {
  835.                     throw new InvalidArgumentException(sprintf('"!service_locator" tag only accepts maps in "%s".', $file));
  836.                 }
  838.                 $argument = $this->resolveServices($argument, $file, $isParameter);
  840.                 try {
  841.                     return new ServiceLocatorArgument($argument);
  842.                 } catch (InvalidArgumentException $e) {
  843.                     throw new InvalidArgumentException(sprintf('"!service_locator" tag only accepts maps of "@service" references in "%s".', $file));
  844.                 }
  845.             }
  846.             if (\in_array($value->getTag(), ['tagged', 'tagged_iterator', 'tagged_locator'], true)) {
  847.                 $forLocator = 'tagged_locator' === $value->getTag();
  849.                 if (\is_array($argument) && isset($argument['tag']) && $argument['tag']) {
  850.                     if ($diff = array_diff(array_keys($argument), ['tag', 'index_by', 'default_index_method', 'default_priority_method'])) {
  851.                         throw new InvalidArgumentException(sprintf('"!%s" tag contains unsupported key "%s"; supported ones are "tag", "index_by", "default_index_method", and "default_priority_method".', $value->getTag(), implode('", "', $diff)));
  852.                     }
  854.                     $argument = new TaggedIteratorArgument($argument['tag'], $argument['index_by'] ?? null, $argument['default_index_method'] ?? null, $forLocator, $argument['default_priority_method'] ?? null);
  855.                 } elseif (\is_string($argument) && $argument) {
  856.                     $argument = new TaggedIteratorArgument($argument, null, null, $forLocator);
  857.                 } else {
  858.                     throw new InvalidArgumentException(sprintf('"!%s" tags only accept a non empty string or an array with a key "tag" in "%s".', $value->getTag(), $file));
  859.                 }
  861.                 if ($forLocator) {
  862.                     $argument = new ServiceLocatorArgument($argument);
  863.                 }
  865.                 return $argument;
  866.             }
  867.             if ('service' === $value->getTag()) {
  868.                 if ($isParameter) {
  869.                     throw new InvalidArgumentException(sprintf('Using an anonymous service in a parameter is not allowed in "%s".', $file));
  870.                 }
  872.                 $isLoadingInstanceof = $this->isLoadingInstanceof;
  873.                 $this->isLoadingInstanceof = false;
  874.                 $instanceof = $this->instanceof;
  875.                 $this->instanceof = [];
  877.                 $id = sprintf('.%d_%s', ++$this->anonymousServicesCount, preg_replace('/^.*\\\\/', '', $argument['class'] ?? '').$this->anonymousServicesSuffix);
  878.                 $this->parseDefinition($id, $argument, $file, []);
  880.                 if (!$this->container->hasDefinition($id)) {
  881.                     throw new InvalidArgumentException(sprintf('Creating an alias using the tag "!service" is not allowed in "%s".', $file));
  882.                 }
  884.                 $this->container->getDefinition($id);
  886.                 $this->isLoadingInstanceof = $isLoadingInstanceof;
  887.                 $this->instanceof = $instanceof;
  889.                 return new Reference($id);
  890.             }
  891.             if ('abstract' === $value->getTag()) {
  892.                 return new AbstractArgument($value->getValue());
  893.             }
  895.             throw new InvalidArgumentException(sprintf('Unsupported tag "!%s".', $value->getTag()));
  896.         }
  898.         if (\is_array($value)) {
  899.             foreach ($value as $k => $v) {
  900.                 $value[$k] = $this->resolveServices($v, $file, $isParameter);
  901.             }
  902.         } elseif (\is_string($value) && str_starts_with($value, '@=')) {
  903.             if ($isParameter) {
  904.                 throw new InvalidArgumentException(sprintf('Using expressions in parameters is not allowed in "%s".', $file));
  905.             }
  907.             if (!class_exists(Expression::class)) {
  908.                 throw new \LogicException('The "@=" expression syntax cannot be used without the ExpressionLanguage component. Try running "composer require symfony/expression-language".');
  909.             }
  911.             return new Expression(substr($value, 2));
  912.         } elseif (\is_string($value) && str_starts_with($value, '@')) {
  913.             if (str_starts_with($value, '@@')) {
  914.                 $value = substr($value, 1);
  915.                 $invalidBehavior = null;
  916.             } elseif (str_starts_with($value, '@!')) {
  917.                 $value = substr($value, 2);
  918.                 $invalidBehavior = ContainerInterface::IGNORE_ON_UNINITIALIZED_REFERENCE;
  919.             } elseif (str_starts_with($value, '@?')) {
  920.                 $value = substr($value, 2);
  921.                 $invalidBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
  922.             } else {
  923.                 $value = substr($value, 1);
  924.                 $invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;
  925.             }
  927.             if (null !== $invalidBehavior) {
  928.                 $value = new Reference($value, $invalidBehavior);
  929.             }
  930.         }
  932.         return $value;
  933.     }
  935.     private function loadFromExtensions(array $content)
  936.     {
  937.         foreach ($content as $namespace => $values) {
  938.             if (\in_array($namespace, ['imports', 'parameters', 'services']) || 0 === strpos($namespace, 'when@')) {
  939.                 continue;
  940.             }
  942.             if (!\is_array($values) && null !== $values) {
  943.                 $values = [];
  944.             }
  946.             $this->container->loadFromExtension($namespace, $values);
  947.         }
  948.     }
  950.     private function checkDefinition(string $id, array $definition, string $file)
  951.     {
  952.         if ($this->isLoadingInstanceof) {
  953.             $keywords = self::INSTANCEOF_KEYWORDS;
  954.         } elseif (isset($definition['resource']) || isset($definition['namespace'])) {
  955.             $keywords = self::PROTOTYPE_KEYWORDS;
  956.         } else {
  957.             $keywords = self::SERVICE_KEYWORDS;
  958.         }
  960.         foreach ($definition as $key => $value) {
  961.             if (!isset($keywords[$key])) {
  962.                 throw new InvalidArgumentException(sprintf('The configuration key "%s" is unsupported for definition "%s" in "%s". Allowed configuration keys are "%s".', $key, $id, $file, implode('", "', $keywords)));
  963.             }
  964.         }
  965.     }
  966. }