vendor/symfony/dependency-injection/Container.php line 410

  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;
  14. use Symfony\Component\DependencyInjection\Argument\RewindableGenerator;
  15. use Symfony\Component\DependencyInjection\Argument\ServiceLocator as ArgumentServiceLocator;
  16. use Symfony\Component\DependencyInjection\Exception\EnvNotFoundException;
  17. use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  18. use Symfony\Component\DependencyInjection\Exception\ParameterCircularReferenceException;
  19. use Symfony\Component\DependencyInjection\Exception\ParameterNotFoundException;
  20. use Symfony\Component\DependencyInjection\Exception\RuntimeException;
  21. use Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException;
  22. use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
  23. use Symfony\Component\DependencyInjection\ParameterBag\EnvPlaceholderParameterBag;
  24. use Symfony\Component\DependencyInjection\ParameterBag\FrozenParameterBag;
  25. use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
  26. use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
  27. use Symfony\Contracts\Service\ResetInterface;
  29. // Help opcache.preload discover always-needed symbols
  30. class_exists(RewindableGenerator::class);
  31. class_exists(ArgumentServiceLocator::class);
  33. /**
  34.  * Container is a dependency injection container.
  35.  *
  36.  * It gives access to object instances (services).
  37.  * Services and parameters are simple key/pair stores.
  38.  * The container can have four possible behaviors when a service
  39.  * does not exist (or is not initialized for the last case):
  40.  *
  41.  *  * EXCEPTION_ON_INVALID_REFERENCE: Throws an exception at compilation time (the default)
  42.  *  * NULL_ON_INVALID_REFERENCE:      Returns null
  43.  *  * IGNORE_ON_INVALID_REFERENCE:    Ignores the wrapping command asking for the reference
  44.  *                                    (for instance, ignore a setter if the service does not exist)
  45.  *  * IGNORE_ON_UNINITIALIZED_REFERENCE: Ignores/returns null for uninitialized services or invalid references
  46.  *  * RUNTIME_EXCEPTION_ON_INVALID_REFERENCE: Throws an exception at runtime
  47.  *
  48.  * @author Fabien Potencier <fabien@symfony.com>
  49.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  50.  */
  51. class Container implements ContainerInterface, ResetInterface
  52. {
  53.     protected $parameterBag;
  54.     protected $services = [];
  55.     protected $privates = [];
  56.     protected $fileMap = [];
  57.     protected $methodMap = [];
  58.     protected $factories = [];
  59.     protected $aliases = [];
  60.     protected $loading = [];
  61.     protected $resolving = [];
  62.     protected $syntheticIds = [];
  64.     private array $envCache = [];
  65.     private bool $compiled = false;
  66.     private \Closure $getEnv;
  68.     private static $make;
  70.     public function __construct(ParameterBagInterface $parameterBag = null)
  71.     {
  72.         $this->parameterBag = $parameterBag ?? new EnvPlaceholderParameterBag();
  73.     }
  75.     /**
  76.      * Compiles the container.
  77.      *
  78.      * This method does two things:
  79.      *
  80.      *  * Parameter values are resolved;
  81.      *  * The parameter bag is frozen.
  82.      *
  83.      * @return void
  84.      */
  85.     public function compile()
  86.     {
  87.         $this->parameterBag->resolve();
  89.         $this->parameterBag = new FrozenParameterBag(
  90.             $this->parameterBag->all(),
  91.             $this->parameterBag instanceof ParameterBag ? $this->parameterBag->allDeprecated() : []
  92.         );
  94.         $this->compiled = true;
  95.     }
  97.     /**
  98.      * Returns true if the container is compiled.
  99.      */
  100.     public function isCompiled(): bool
  101.     {
  102.         return $this->compiled;
  103.     }
  105.     /**
  106.      * Gets the service container parameter bag.
  107.      */
  108.     public function getParameterBag(): ParameterBagInterface
  109.     {
  110.         return $this->parameterBag;
  111.     }
  113.     /**
  114.      * Gets a parameter.
  115.      *
  116.      * @return array|bool|string|int|float|\UnitEnum|null
  117.      *
  118.      * @throws ParameterNotFoundException if the parameter is not defined
  119.      */
  120.     public function getParameter(string $name)
  121.     {
  122.         return $this->parameterBag->get($name);
  123.     }
  125.     public function hasParameter(string $name): bool
  126.     {
  127.         return $this->parameterBag->has($name);
  128.     }
  130.     /**
  131.      * @return void
  132.      */
  133.     public function setParameter(string $name, array|bool|string|int|float|\UnitEnum|null $value)
  134.     {
  135.         $this->parameterBag->set($name, $value);
  136.     }
  138.     /**
  139.      * Sets a service.
  140.      *
  141.      * Setting a synthetic service to null resets it: has() returns false and get()
  142.      * behaves in the same way as if the service was never created.
  143.      *
  144.      * @return void
  145.      */
  146.     public function set(string $id, ?object $service)
  147.     {
  148.         // Runs the internal initializer; used by the dumped container to include always-needed files
  149.         if (isset($this->privates['service_container']) && $this->privates['service_container'] instanceof \Closure) {
  150.             $initialize = $this->privates['service_container'];
  151.             unset($this->privates['service_container']);
  152.             $initialize($this);
  153.         }
  155.         if ('service_container' === $id) {
  156.             throw new InvalidArgumentException('You cannot set service "service_container".');
  157.         }
  159.         if (!(isset($this->fileMap[$id]) || isset($this->methodMap[$id]))) {
  160.             if (isset($this->syntheticIds[$id]) || !isset($this->getRemovedIds()[$id])) {
  161.                 // no-op
  162.             } elseif (null === $service) {
  163.                 throw new InvalidArgumentException(sprintf('The "%s" service is private, you cannot unset it.', $id));
  164.             } else {
  165.                 throw new InvalidArgumentException(sprintf('The "%s" service is private, you cannot replace it.', $id));
  166.             }
  167.         } elseif (isset($this->services[$id])) {
  168.             throw new InvalidArgumentException(sprintf('The "%s" service is already initialized, you cannot replace it.', $id));
  169.         }
  171.         if (isset($this->aliases[$id])) {
  172.             unset($this->aliases[$id]);
  173.         }
  175.         if (null === $service) {
  176.             unset($this->services[$id]);
  178.             return;
  179.         }
  181.         $this->services[$id] = $service;
  182.     }
  184.     public function has(string $id): bool
  185.     {
  186.         if (isset($this->aliases[$id])) {
  187.             $id = $this->aliases[$id];
  188.         }
  189.         if (isset($this->services[$id])) {
  190.             return true;
  191.         }
  192.         if ('service_container' === $id) {
  193.             return true;
  194.         }
  196.         return isset($this->fileMap[$id]) || isset($this->methodMap[$id]);
  197.     }
  199.     /**
  200.      * Gets a service.
  201.      *
  202.      * @throws ServiceCircularReferenceException When a circular reference is detected
  203.      * @throws ServiceNotFoundException          When the service is not defined
  204.      * @throws \Exception                        if an exception has been thrown when the service has been resolved
  205.      *
  206.      * @see Reference
  207.      */
  208.     public function get(string $id, int $invalidBehavior = self::EXCEPTION_ON_INVALID_REFERENCE): ?object
  209.     {
  210.         return $this->services[$id]
  211.             ?? $this->services[$id = $this->aliases[$id] ?? $id]
  212.             ?? ('service_container' === $id ? $this : ($this->factories[$id] ?? self::$make ??= self::make(...))($this, $id, $invalidBehavior));
  213.     }
  215.     /**
  216.      * Creates a service.
  217.      *
  218.      * As a separate method to allow "get()" to use the really fast `??` operator.
  219.      */
  220.     private static function make(self $container, string $id, int $invalidBehavior): ?object
  221.     {
  222.         if (isset($container->loading[$id])) {
  223.             throw new ServiceCircularReferenceException($id, array_merge(array_keys($container->loading), [$id]));
  224.         }
  226.         $container->loading[$id] = true;
  228.         try {
  229.             if (isset($container->fileMap[$id])) {
  230.                 return /* self::IGNORE_ON_UNINITIALIZED_REFERENCE */ 4 === $invalidBehavior ? null : $container->load($container->fileMap[$id]);
  231.             } elseif (isset($container->methodMap[$id])) {
  232.                 return /* self::IGNORE_ON_UNINITIALIZED_REFERENCE */ 4 === $invalidBehavior ? null : $container->{$container->methodMap[$id]}($container);
  233.             }
  234.         } catch (\Exception $e) {
  235.             unset($container->services[$id]);
  237.             throw $e;
  238.         } finally {
  239.             unset($container->loading[$id]);
  240.         }
  242.         if (self::EXCEPTION_ON_INVALID_REFERENCE === $invalidBehavior) {
  243.             if (!$id) {
  244.                 throw new ServiceNotFoundException($id);
  245.             }
  246.             if (isset($container->syntheticIds[$id])) {
  247.                 throw new ServiceNotFoundException($id, null, null, [], sprintf('The "%s" service is synthetic, it needs to be set at boot time before it can be used.', $id));
  248.             }
  249.             if (isset($container->getRemovedIds()[$id])) {
  250.                 throw new ServiceNotFoundException($id, null, null, [], sprintf('The "%s" service or alias has been removed or inlined when the container was compiled. You should either make it public, or stop using the container directly and use dependency injection instead.', $id));
  251.             }
  253.             $alternatives = [];
  254.             foreach ($container->getServiceIds() as $knownId) {
  255.                 if ('' === $knownId || '.' === $knownId[0]) {
  256.                     continue;
  257.                 }
  258.                 $lev = levenshtein($id, $knownId);
  259.                 if ($lev <= \strlen($id) / 3 || str_contains($knownId, $id)) {
  260.                     $alternatives[] = $knownId;
  261.                 }
  262.             }
  264.             throw new ServiceNotFoundException($id, null, null, $alternatives);
  265.         }
  267.         return null;
  268.     }
  270.     /**
  271.      * Returns true if the given service has actually been initialized.
  272.      */
  273.     public function initialized(string $id): bool
  274.     {
  275.         if (isset($this->aliases[$id])) {
  276.             $id = $this->aliases[$id];
  277.         }
  279.         if ('service_container' === $id) {
  280.             return false;
  281.         }
  283.         return isset($this->services[$id]);
  284.     }
  286.     /**
  287.      * @return void
  288.      */
  289.     public function reset()
  290.     {
  291.         $services = $this->services + $this->privates;
  292.         $this->services = $this->factories = $this->privates = [];
  294.         foreach ($services as $service) {
  295.             try {
  296.                 if ($service instanceof ResetInterface) {
  297.                     $service->reset();
  298.                 }
  299.             } catch (\Throwable) {
  300.                 continue;
  301.             }
  302.         }
  303.     }
  305.     /**
  306.      * Gets all service ids.
  307.      *
  308.      * @return string[]
  309.      */
  310.     public function getServiceIds(): array
  311.     {
  312.         return array_map('strval', array_unique(array_merge(['service_container'], array_keys($this->fileMap), array_keys($this->methodMap), array_keys($this->aliases), array_keys($this->services))));
  313.     }
  315.     /**
  316.      * Gets service ids that existed at compile time.
  317.      */
  318.     public function getRemovedIds(): array
  319.     {
  320.         return [];
  321.     }
  323.     /**
  324.      * Camelizes a string.
  325.      */
  326.     public static function camelize(string $id): string
  327.     {
  328.         return strtr(ucwords(strtr($id, ['_' => ' ', '.' => '_ ', '\\' => '_ '])), [' ' => '']);
  329.     }
  331.     /**
  332.      * A string to underscore.
  333.      */
  334.     public static function underscore(string $id): string
  335.     {
  336.         return strtolower(preg_replace(['/([A-Z]+)([A-Z][a-z])/', '/([a-z\d])([A-Z])/'], ['\\1_\\2', '\\1_\\2'], str_replace('_', '.', $id)));
  337.     }
  339.     /**
  340.      * Creates a service by requiring its factory file.
  341.      *
  342.      * @return mixed
  343.      */
  344.     protected function load(string $file)
  345.     {
  346.         return require $file;
  347.     }
  349.     /**
  350.      * Fetches a variable from the environment.
  351.      *
  352.      * @throws EnvNotFoundException When the environment variable is not found and has no default value
  353.      */
  354.     protected function getEnv(string $name): mixed
  355.     {
  356.         if (isset($this->resolving[$envName = "env($name)"])) {
  357.             throw new ParameterCircularReferenceException(array_keys($this->resolving));
  358.         }
  359.         if (isset($this->envCache[$name]) || \array_key_exists($name, $this->envCache)) {
  360.             return $this->envCache[$name];
  361.         }
  362.         if (!$this->has($id = 'container.env_var_processors_locator')) {
  363.             $this->set($id, new ServiceLocator([]));
  364.         }
  365.         $this->getEnv ??= $this->getEnv(...);
  366.         $processors = $this->get($id);
  368.         if (false !== $i = strpos($name, ':')) {
  369.             $prefix = substr($name, 0, $i);
  370.             $localName = substr($name, 1 + $i);
  371.         } else {
  372.             $prefix = 'string';
  373.             $localName = $name;
  374.         }
  376.         $processor = $processors->has($prefix) ? $processors->get($prefix) : new EnvVarProcessor($this);
  377.         if (false === $i) {
  378.             $prefix = '';
  379.         }
  381.         $this->resolving[$envName] = true;
  382.         try {
  383.             return $this->envCache[$name] = $processor->getEnv($prefix, $localName, $this->getEnv);
  384.         } finally {
  385.             unset($this->resolving[$envName]);
  386.         }
  387.     }
  389.     /**
  390.      * @internal
  391.      */
  392.     final protected function getService(string|false $registry, string $id, ?string $method, string|bool $load): mixed
  393.     {
  394.         if ('service_container' === $id) {
  395.             return $this;
  396.         }
  397.         if (\is_string($load)) {
  398.             throw new RuntimeException($load);
  399.         }
  400.         if (null === $method) {
  401.             return false !== $registry ? $this->{$registry}[$id] ?? null : null;
  402.         }
  403.         if (false !== $registry) {
  404.             return $this->{$registry}[$id] ??= $load ? $this->load($method) : $this->{$method}($this);
  405.         }
  406.         if (!$load) {
  407.             return $this->{$method}($this);
  408.         }
  410.         return ($factory = $this->factories[$id] ?? $this->factories['service_container'][$id] ?? null) ? $factory($this) : $this->load($method);
  411.     }
  413.     private function __clone()
  414.     {
  415.     }
  416. }