vendor/symfony/dependency-injection/Loader/Configurator/ServicesConfigurator.php line 130

  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\DependencyInjection\Alias;
  15. use Symfony\Component\DependencyInjection\ChildDefinition;
  16. use Symfony\Component\DependencyInjection\ContainerBuilder;
  17. use Symfony\Component\DependencyInjection\Definition;
  18. use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  19. use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
  20. use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
  22. /**
  23.  * @author Nicolas Grekas <p@tchwork.com>
  24.  */
  25. class ServicesConfigurator extends AbstractConfigurator
  26. {
  27.     public const FACTORY = 'services';
  29.     private Definition $defaults;
  30.     private ContainerBuilder $container;
  31.     private PhpFileLoader $loader;
  32.     private array $instanceof;
  33.     private ?string $path;
  34.     private string $anonymousHash;
  35.     private int $anonymousCount;
  37.     public function __construct(ContainerBuilder $container, PhpFileLoader $loader, array &$instanceof, string $path = null, int &$anonymousCount = 0)
  38.     {
  39.         $this->defaults = new Definition();
  40.         $this->container = $container;
  41.         $this->loader = $loader;
  42.         $this->instanceof = &$instanceof;
  43.         $this->path = $path;
  44.         $this->anonymousHash = ContainerBuilder::hash($path ?: mt_rand());
  45.         $this->anonymousCount = &$anonymousCount;
  46.         $instanceof = [];
  47.     }
  49.     /**
  50.      * Defines a set of defaults for following service definitions.
  51.      */
  52.     final public function defaults(): DefaultsConfigurator
  53.     {
  54.         return new DefaultsConfigurator($this, $this->defaults = new Definition(), $this->path);
  55.     }
  57.     /**
  58.      * Defines an instanceof-conditional to be applied to following service definitions.
  59.      */
  60.     final public function instanceof(string $fqcn): InstanceofConfigurator
  61.     {
  62.         $this->instanceof[$fqcn] = $definition = new ChildDefinition('');
  64.         return new InstanceofConfigurator($this, $definition, $fqcn, $this->path);
  65.     }
  67.     /**
  68.      * Registers a service.
  69.      *
  70.      * @param string|null $id    The service id, or null to create an anonymous service
  71.      * @param string|null $class The class of the service, or null when $id is also the class name
  72.      */
  73.     final public function set(?string $id, string $class = null): ServiceConfigurator
  74.     {
  75.         $defaults = $this->defaults;
  76.         $definition = new Definition();
  78.         if (null === $id) {
  79.             if (!$class) {
  80.                 throw new \LogicException('Anonymous services must have a class name.');
  81.             }
  83.             $id = sprintf('.%d_%s', ++$this->anonymousCount, preg_replace('/^.*\\\\/', '', $class).'~'.$this->anonymousHash);
  84.         } elseif (!$defaults->isPublic() || !$defaults->isPrivate()) {
  85.             $definition->setPublic($defaults->isPublic() && !$defaults->isPrivate());
  86.         }
  88.         $definition->setAutowired($defaults->isAutowired());
  89.         $definition->setAutoconfigured($defaults->isAutoconfigured());
  90.         // deep clone, to avoid multiple process of the same instance in the passes
  91.         $definition->setBindings(unserialize(serialize($defaults->getBindings())));
  92.         $definition->setChanges([]);
  94.         $configurator = new ServiceConfigurator($this->container, $this->instanceof, true, $this, $definition, $id, $defaults->getTags(), $this->path);
  96.         return null !== $class ? $configurator->class($class) : $configurator;
  97.     }
  99.     /**
  100.      * Removes an already defined service definition or alias.
  101.      *
  102.      * @return $this
  103.      */
  104.     final public function remove(string $id): static
  105.     {
  106.         $this->container->removeDefinition($id);
  107.         $this->container->removeAlias($id);
  109.         return $this;
  110.     }
  112.     /**
  113.      * Creates an alias.
  114.      */
  115.     final public function alias(string $id, string $referencedId): AliasConfigurator
  116.     {
  117.         $ref = static::processValue($referencedId, true);
  118.         $alias = new Alias((string) $ref);
  119.         if (!$this->defaults->isPublic() || !$this->defaults->isPrivate()) {
  120.             $alias->setPublic($this->defaults->isPublic());
  121.         }
  122.         $this->container->setAlias($id, $alias);
  124.         return new AliasConfigurator($this, $alias);
  125.     }
  127.     /**
  128.      * Registers a PSR-4 namespace using a glob pattern.
  129.      */
  130.     final public function load(string $namespace, string $resource): PrototypeConfigurator
  131.     {
  132.         return new PrototypeConfigurator($this, $this->loader, $this->defaults, $namespace, $resource, true, $this->path);
  133.     }
  135.     /**
  136.      * Gets an already defined service definition.
  137.      *
  138.      * @throws ServiceNotFoundException if the service definition does not exist
  139.      */
  140.     final public function get(string $id): ServiceConfigurator
  141.     {
  142.         $definition = $this->container->getDefinition($id);
  144.         return new ServiceConfigurator($this->container, $definition->getInstanceofConditionals(), true, $this, $definition, $id, []);
  145.     }
  147.     /**
  148.      * Registers a stack of decorator services.
  149.      *
  150.      * @param InlineServiceConfigurator[]|ReferenceConfigurator[] $services
  151.      */
  152.     final public function stack(string $id, array $services): AliasConfigurator
  153.     {
  154.         foreach ($services as $i => $service) {
  155.             if ($service instanceof InlineServiceConfigurator) {
  156.                 $definition = $service->definition->setInstanceofConditionals($this->instanceof);
  158.                 $changes = $definition->getChanges();
  159.                 $definition->setAutowired((isset($changes['autowired']) ? $definition : $this->defaults)->isAutowired());
  160.                 $definition->setAutoconfigured((isset($changes['autoconfigured']) ? $definition : $this->defaults)->isAutoconfigured());
  161.                 $definition->setBindings(array_merge($this->defaults->getBindings(), $definition->getBindings()));
  162.                 $definition->setChanges($changes);
  164.                 $services[$i] = $definition;
  165.             } elseif (!$service instanceof ReferenceConfigurator) {
  166.                 throw new InvalidArgumentException(sprintf('"%s()" expects a list of definitions as returned by "%s()" or "%s()", "%s" given at index "%s" for service "%s".', __METHOD__, InlineServiceConfigurator::FACTORY, ReferenceConfigurator::FACTORY, $service instanceof AbstractConfigurator ? $service::FACTORY.'()' : get_debug_type($service), $i, $id));
  167.             }
  168.         }
  170.         $alias = $this->alias($id, '');
  171.         $alias->definition = $this->set($id)
  172.             ->parent('')
  173.             ->args($services)
  174.             ->tag('container.stack')
  175.             ->definition;
  177.         return $alias;
  178.     }
  180.     /**
  181.      * Registers a service.
  182.      */
  183.     final public function __invoke(string $id, string $class = null): ServiceConfigurator
  184.     {
  185.         return $this->set($id, $class);
  186.     }
  188.     public function __destruct()
  189.     {
  190.         $this->loader->registerAliasesForSinglyImplementedInterfaces();
  191.     }
  192. }