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

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