vendor/symfony/dependency-injection/Loader/Configurator/ContainerConfigurator.php line 41

  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\Configurator;
  14. use Symfony\Component\Config\Loader\ParamConfigurator;
  15. use Symfony\Component\DependencyInjection\Argument\AbstractArgument;
  16. use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
  17. use Symfony\Component\DependencyInjection\Argument\ServiceLocatorArgument;
  18. use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
  19. use Symfony\Component\DependencyInjection\ContainerBuilder;
  20. use Symfony\Component\DependencyInjection\Definition;
  21. use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  22. use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
  23. use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
  24. use Symfony\Component\ExpressionLanguage\Expression;
  26. /**
  27.  * @author Nicolas Grekas <p@tchwork.com>
  28.  */
  29. class ContainerConfigurator extends AbstractConfigurator
  30. {
  31.     public const FACTORY = 'container';
  33.     private ContainerBuilder $container;
  34.     private PhpFileLoader $loader;
  35.     private array $instanceof;
  36.     private string $path;
  37.     private string $file;
  38.     private int $anonymousCount = 0;
  39.     private ?string $env;
  41.     public function __construct(ContainerBuilder $container, PhpFileLoader $loader, array &$instanceof, string $path, string $file, string $env = null)
  42.     {
  43.         $this->container = $container;
  44.         $this->loader = $loader;
  45.         $this->instanceof = &$instanceof;
  46.         $this->path = $path;
  47.         $this->file = $file;
  48.         $this->env = $env;
  49.     }
  51.     final public function extension(string $namespace, array $config)
  52.     {
  53.         if (!$this->container->hasExtension($namespace)) {
  54.             $extensions = array_filter(array_map(function (ExtensionInterface $ext) { return $ext->getAlias(); }, $this->container->getExtensions()));
  55.             throw new InvalidArgumentException(sprintf('There is no extension able to load the configuration for "%s" (in "%s"). Looked for namespace "%s", found "%s".', $namespace, $this->file, $namespace, $extensions ? implode('", "', $extensions) : 'none'));
  56.         }
  58.         $this->container->loadFromExtension($namespace, static::processValue($config));
  59.     }
  61.     final public function import(string $resource, string $type = null, bool|string $ignoreErrors = false)
  62.     {
  63.         $this->loader->setCurrentDir(\dirname($this->path));
  64.         $this->loader->import($resource, $type, $ignoreErrors, $this->file);
  65.     }
  67.     final public function parameters(): ParametersConfigurator
  68.     {
  69.         return new ParametersConfigurator($this->container);
  70.     }
  72.     final public function services(): ServicesConfigurator
  73.     {
  74.         return new ServicesConfigurator($this->container, $this->loader, $this->instanceof, $this->path, $this->anonymousCount);
  75.     }
  77.     /**
  78.      * Get the current environment to be able to write conditional configuration.
  79.      */
  80.     final public function env(): ?string
  81.     {
  82.         return $this->env;
  83.     }
  85.     final public function withPath(string $path): static
  86.     {
  87.         $clone = clone $this;
  88.         $clone->path = $clone->file = $path;
  89.         $clone->loader->setCurrentDir(\dirname($path));
  91.         return $clone;
  92.     }
  93. }
  95. /**
  96.  * Creates a parameter.
  97.  */
  98. function param(string $name): ParamConfigurator
  99. {
  100.     return new ParamConfigurator($name);
  101. }
  103. /**
  104.  * Creates a reference to a service.
  105.  */
  106. function service(string $serviceId): ReferenceConfigurator
  107. {
  108.     return new ReferenceConfigurator($serviceId);
  109. }
  111. /**
  112.  * Creates an inline service.
  113.  */
  114. function inline_service(string $class = null): InlineServiceConfigurator
  115. {
  116.     return new InlineServiceConfigurator(new Definition($class));
  117. }
  119. /**
  120.  * Creates a service locator.
  121.  *
  122.  * @param ReferenceConfigurator[] $values
  123.  */
  124. function service_locator(array $values): ServiceLocatorArgument
  125. {
  126.     return new ServiceLocatorArgument(AbstractConfigurator::processValue($values, true));
  127. }
  129. /**
  130.  * Creates a lazy iterator.
  131.  *
  132.  * @param ReferenceConfigurator[] $values
  133.  */
  134. function iterator(array $values): IteratorArgument
  135. {
  136.     return new IteratorArgument(AbstractConfigurator::processValue($values, true));
  137. }
  139. /**
  140.  * Creates a lazy iterator by tag name.
  141.  */
  142. function tagged_iterator(string $tag, string $indexAttribute = null, string $defaultIndexMethod = null, string $defaultPriorityMethod = null, string|array $exclude = []): TaggedIteratorArgument
  143. {
  144.     return new TaggedIteratorArgument($tag, $indexAttribute, $defaultIndexMethod, false, $defaultPriorityMethod, (array) $exclude);
  145. }
  147. /**
  148.  * Creates a service locator by tag name.
  149.  */
  150. function tagged_locator(string $tag, string $indexAttribute = null, string $defaultIndexMethod = null, string $defaultPriorityMethod = null, string|array $exclude = []): ServiceLocatorArgument
  151. {
  152.     return new ServiceLocatorArgument(new TaggedIteratorArgument($tag, $indexAttribute, $defaultIndexMethod, true, $defaultPriorityMethod, (array) $exclude));
  153. }
  155. /**
  156.  * Creates an expression.
  157.  */
  158. function expr(string $expression): Expression
  159. {
  160.     return new Expression($expression);
  161. }
  163. /**
  164.  * Creates an abstract argument.
  165.  */
  166. function abstract_arg(string $description): AbstractArgument
  167. {
  168.     return new AbstractArgument($description);
  169. }
  171. /**
  172.  * Creates an environment variable reference.
  173.  */
  174. function env(string $name): EnvConfigurator
  175. {
  176.     return new EnvConfigurator($name);
  177. }
  179. /**
  180.  * Creates a closure service reference.
  181.  */
  182. function service_closure(string $serviceId): ClosureReferenceConfigurator
  183. {
  184.     return new ClosureReferenceConfigurator($serviceId);
  185. }
  187. /**
  188.  * Creates a closure.
  189.  */
  190. function closure(string|array|ReferenceConfigurator|Expression $callable): InlineServiceConfigurator
  191. {
  192.     return (new InlineServiceConfigurator(new Definition('Closure')))
  193.         ->factory(['Closure', 'fromCallable'])
  194.         ->args([$callable]);
  195. }