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

  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\ParameterBagInterface;
  26. use Symfony\Contracts\Service\ResetInterface;
  28. // Help opcache.preload discover always-needed symbols
  29. class_exists(RewindableGenerator::class);
  30. class_exists(ArgumentServiceLocator::class);
  32. /**
  33.  * Container is a dependency injection container.
  34.  *
  35.  * It gives access to object instances (services).
  36.  * Services and parameters are simple key/pair stores.
  37.  * The container can have four possible behaviors when a service
  38.  * does not exist (or is not initialized for the last case):
  39.  *
  40.  *  * EXCEPTION_ON_INVALID_REFERENCE: Throws an exception (the default)
  41.  *  * NULL_ON_INVALID_REFERENCE:      Returns null
  42.  *  * IGNORE_ON_INVALID_REFERENCE:    Ignores the wrapping command asking for the reference
  43.  *                                    (for instance, ignore a setter if the service does not exist)
  44.  *  * IGNORE_ON_UNINITIALIZED_REFERENCE: Ignores/returns null for uninitialized services or invalid references
  45.  *
  46.  * @author Fabien Potencier <fabien@symfony.com>
  47.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  48.  */
  49. class Container implements ContainerInterface, ResetInterface
  50. {
  51.     protected $parameterBag;
  52.     protected $services = [];
  53.     protected $privates = [];
  54.     protected $fileMap = [];
  55.     protected $methodMap = [];
  56.     protected $factories = [];
  57.     protected $aliases = [];
  58.     protected $loading = [];
  59.     protected $resolving = [];
  60.     protected $syntheticIds = [];
  62.     private array $envCache = [];
  63.     private bool $compiled = false;
  64.     private \Closure $getEnv;
  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.     public function compile()
  80.     {
  81.         $this->parameterBag->resolve();
  83.         $this->parameterBag = new FrozenParameterBag($this->parameterBag->all());
  85.         $this->compiled = true;
  86.     }
  88.     /**
  89.      * Returns true if the container is compiled.
  90.      */
  91.     public function isCompiled(): bool
  92.     {
  93.         return $this->compiled;
  94.     }
  96.     /**
  97.      * Gets the service container parameter bag.
  98.      */
  99.     public function getParameterBag(): ParameterBagInterface
  100.     {
  101.         return $this->parameterBag;
  102.     }
  104.     /**
  105.      * Gets a parameter.
  106.      *
  107.      * @return array|bool|string|int|float|\UnitEnum|null
  108.      *
  109.      * @throws ParameterNotFoundException if the parameter is not defined
  110.      */
  111.     public function getParameter(string $name)
  112.     {
  113.         return $this->parameterBag->get($name);
  114.     }
  116.     public function hasParameter(string $name): bool
  117.     {
  118.         return $this->parameterBag->has($name);
  119.     }
  121.     public function setParameter(string $name, array|bool|string|int|float|\UnitEnum|null $value)
  122.     {
  123.         $this->parameterBag->set($name, $value);
  124.     }
  126.     /**
  127.      * Sets a service.
  128.      *
  129.      * Setting a synthetic service to null resets it: has() returns false and get()
  130.      * behaves in the same way as if the service was never created.
  131.      */
  132.     public function set(string $id, ?object $service)
  133.     {
  134.         // Runs the internal initializer; used by the dumped container to include always-needed files
  135.         if (isset($this->privates['service_container']) && $this->privates['service_container'] instanceof \Closure) {
  136.             $initialize = $this->privates['service_container'];
  137.             unset($this->privates['service_container']);
  138.             $initialize();
  139.         }
  141.         if ('service_container' === $id) {
  142.             throw new InvalidArgumentException('You cannot set service "service_container".');
  143.         }
  145.         if (!(isset($this->fileMap[$id]) || isset($this->methodMap[$id]))) {
  146.             if (isset($this->syntheticIds[$id]) || !isset($this->getRemovedIds()[$id])) {
  147.                 // no-op
  148.             } elseif (null === $service) {
  149.                 throw new InvalidArgumentException(sprintf('The "%s" service is private, you cannot unset it.', $id));
  150.             } else {
  151.                 throw new InvalidArgumentException(sprintf('The "%s" service is private, you cannot replace it.', $id));
  152.             }
  153.         } elseif (isset($this->services[$id])) {
  154.             throw new InvalidArgumentException(sprintf('The "%s" service is already initialized, you cannot replace it.', $id));
  155.         }
  157.         if (isset($this->aliases[$id])) {
  158.             unset($this->aliases[$id]);
  159.         }
  161.         if (null === $service) {
  162.             unset($this->services[$id]);
  164.             return;
  165.         }
  167.         $this->services[$id] = $service;
  168.     }
  170.     public function has(string $id): bool
  171.     {
  172.         if (isset($this->aliases[$id])) {
  173.             $id = $this->aliases[$id];
  174.         }
  175.         if (isset($this->services[$id])) {
  176.             return true;
  177.         }
  178.         if ('service_container' === $id) {
  179.             return true;
  180.         }
  182.         return isset($this->fileMap[$id]) || isset($this->methodMap[$id]);
  183.     }
  185.     /**
  186.      * Gets a service.
  187.      *
  188.      * @throws ServiceCircularReferenceException When a circular reference is detected
  189.      * @throws ServiceNotFoundException          When the service is not defined
  190.      * @throws \Exception                        if an exception has been thrown when the service has been resolved
  191.      *
  192.      * @see Reference
  193.      */
  194.     public function get(string $id, int $invalidBehavior = self::EXCEPTION_ON_INVALID_REFERENCE): ?object
  195.     {
  196.         return $this->services[$id]
  197.             ?? $this->services[$id = $this->aliases[$id] ?? $id]
  198.             ?? ('service_container' === $id ? $this : ($this->factories[$id] ?? $this->make(...))($id, $invalidBehavior));
  199.     }
  201.     /**
  202.      * Creates a service.
  203.      *
  204.      * As a separate method to allow "get()" to use the really fast `??` operator.
  205.      */
  206.     private function make(string $id, int $invalidBehavior)
  207.     {
  208.         if (isset($this->loading[$id])) {
  209.             throw new ServiceCircularReferenceException($id, array_merge(array_keys($this->loading), [$id]));
  210.         }
  212.         $this->loading[$id] = true;
  214.         try {
  215.             if (isset($this->fileMap[$id])) {
  216.                 return /* self::IGNORE_ON_UNINITIALIZED_REFERENCE */ 4 === $invalidBehavior ? null : $this->load($this->fileMap[$id]);
  217.             } elseif (isset($this->methodMap[$id])) {
  218.                 return /* self::IGNORE_ON_UNINITIALIZED_REFERENCE */ 4 === $invalidBehavior ? null : $this->{$this->methodMap[$id]}();
  219.             }
  220.         } catch (\Exception $e) {
  221.             unset($this->services[$id]);
  223.             throw $e;
  224.         } finally {
  225.             unset($this->loading[$id]);
  226.         }
  228.         if (self::EXCEPTION_ON_INVALID_REFERENCE === $invalidBehavior) {
  229.             if (!$id) {
  230.                 throw new ServiceNotFoundException($id);
  231.             }
  232.             if (isset($this->syntheticIds[$id])) {
  233.                 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));
  234.             }
  235.             if (isset($this->getRemovedIds()[$id])) {
  236.                 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));
  237.             }
  239.             $alternatives = [];
  240.             foreach ($this->getServiceIds() as $knownId) {
  241.                 if ('' === $knownId || '.' === $knownId[0]) {
  242.                     continue;
  243.                 }
  244.                 $lev = levenshtein($id, $knownId);
  245.                 if ($lev <= \strlen($id) / 3 || str_contains($knownId, $id)) {
  246.                     $alternatives[] = $knownId;
  247.                 }
  248.             }
  250.             throw new ServiceNotFoundException($id, null, null, $alternatives);
  251.         }
  253.         return null;
  254.     }
  256.     /**
  257.      * Returns true if the given service has actually been initialized.
  258.      */
  259.     public function initialized(string $id): bool
  260.     {
  261.         if (isset($this->aliases[$id])) {
  262.             $id = $this->aliases[$id];
  263.         }
  265.         if ('service_container' === $id) {
  266.             return false;
  267.         }
  269.         return isset($this->services[$id]);
  270.     }
  272.     public function reset()
  273.     {
  274.         $services = $this->services + $this->privates;
  275.         $this->services = $this->factories = $this->privates = [];
  277.         foreach ($services as $service) {
  278.             try {
  279.                 if ($service instanceof ResetInterface) {
  280.                     $service->reset();
  281.                 }
  282.             } catch (\Throwable) {
  283.                 continue;
  284.             }
  285.         }
  286.     }
  288.     /**
  289.      * Gets all service ids.
  290.      *
  291.      * @return string[]
  292.      */
  293.     public function getServiceIds(): array
  294.     {
  295.         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))));
  296.     }
  298.     /**
  299.      * Gets service ids that existed at compile time.
  300.      */
  301.     public function getRemovedIds(): array
  302.     {
  303.         return [];
  304.     }
  306.     /**
  307.      * Camelizes a string.
  308.      */
  309.     public static function camelize(string $id): string
  310.     {
  311.         return strtr(ucwords(strtr($id, ['_' => ' ', '.' => '_ ', '\\' => '_ '])), [' ' => '']);
  312.     }
  314.     /**
  315.      * A string to underscore.
  316.      */
  317.     public static function underscore(string $id): string
  318.     {
  319.         return strtolower(preg_replace(['/([A-Z]+)([A-Z][a-z])/', '/([a-z\d])([A-Z])/'], ['\\1_\\2', '\\1_\\2'], str_replace('_', '.', $id)));
  320.     }
  322.     /**
  323.      * Creates a service by requiring its factory file.
  324.      */
  325.     protected function load(string $file)
  326.     {
  327.         return require $file;
  328.     }
  330.     /**
  331.      * Fetches a variable from the environment.
  332.      *
  333.      * @throws EnvNotFoundException When the environment variable is not found and has no default value
  334.      */
  335.     protected function getEnv(string $name): mixed
  336.     {
  337.         if (isset($this->resolving[$envName = "env($name)"])) {
  338.             throw new ParameterCircularReferenceException(array_keys($this->resolving));
  339.         }
  340.         if (isset($this->envCache[$name]) || \array_key_exists($name, $this->envCache)) {
  341.             return $this->envCache[$name];
  342.         }
  343.         if (!$this->has($id = 'container.env_var_processors_locator')) {
  344.             $this->set($id, new ServiceLocator([]));
  345.         }
  346.         $this->getEnv ??= $this->getEnv(...);
  347.         $processors = $this->get($id);
  349.         if (false !== $i = strpos($name, ':')) {
  350.             $prefix = substr($name, 0, $i);
  351.             $localName = substr($name, 1 + $i);
  352.         } else {
  353.             $prefix = 'string';
  354.             $localName = $name;
  355.         }
  356.         $processor = $processors->has($prefix) ? $processors->get($prefix) : new EnvVarProcessor($this);
  358.         $this->resolving[$envName] = true;
  359.         try {
  360.             return $this->envCache[$name] = $processor->getEnv($prefix, $localName, $this->getEnv);
  361.         } finally {
  362.             unset($this->resolving[$envName]);
  363.         }
  364.     }
  366.     /**
  367.      * @internal
  368.      */
  369.     final protected function getService(string|false $registry, string $id, ?string $method, string|bool $load): mixed
  370.     {
  371.         if ('service_container' === $id) {
  372.             return $this;
  373.         }
  374.         if (\is_string($load)) {
  375.             throw new RuntimeException($load);
  376.         }
  377.         if (null === $method) {
  378.             return false !== $registry ? $this->{$registry}[$id] ?? null : null;
  379.         }
  380.         if (false !== $registry) {
  381.             return $this->{$registry}[$id] ??= $load ? $this->load($method) : $this->{$method}();
  382.         }
  383.         if (!$load) {
  384.             return $this->{$method}();
  385.         }
  387.         return ($factory = $this->factories[$id] ?? $this->factories['service_container'][$id] ?? null) ? $factory() : $this->load($method);
  388.     }
  390.     private function __clone()
  391.     {
  392.     }
  393. }