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

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