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

  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 at compilation time (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.  *  * RUNTIME_EXCEPTION_ON_INVALID_REFERENCE: Throws an exception at runtime
  46.  *
  47.  * @author Fabien Potencier <fabien@symfony.com>
  48.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  49.  */
  50. class Container implements ContainerInterface, ResetInterface
  51. {
  52.     protected $parameterBag;
  53.     protected $services = [];
  54.     protected $privates = [];
  55.     protected $fileMap = [];
  56.     protected $methodMap = [];
  57.     protected $factories = [];
  58.     protected $aliases = [];
  59.     protected $loading = [];
  60.     protected $resolving = [];
  61.     protected $syntheticIds = [];
  63.     private array $envCache = [];
  64.     private bool $compiled = false;
  65.     private \Closure $getEnv;
  67.     public function __construct(ParameterBagInterface $parameterBag = null)
  68.     {
  69.         $this->parameterBag = $parameterBag ?? new EnvPlaceholderParameterBag();
  70.     }
  72.     /**
  73.      * Compiles the container.
  74.      *
  75.      * This method does two things:
  76.      *
  77.      *  * Parameter values are resolved;
  78.      *  * The parameter bag is frozen.
  79.      */
  80.     public function compile()
  81.     {
  82.         $this->parameterBag->resolve();
  84.         $this->parameterBag = new FrozenParameterBag($this->parameterBag->all());
  86.         $this->compiled = true;
  87.     }
  89.     /**
  90.      * Returns true if the container is compiled.
  91.      */
  92.     public function isCompiled(): bool
  93.     {
  94.         return $this->compiled;
  95.     }
  97.     /**
  98.      * Gets the service container parameter bag.
  99.      */
  100.     public function getParameterBag(): ParameterBagInterface
  101.     {
  102.         return $this->parameterBag;
  103.     }
  105.     /**
  106.      * Gets a parameter.
  107.      *
  108.      * @return array|bool|string|int|float|\UnitEnum|null
  109.      *
  110.      * @throws ParameterNotFoundException if the parameter is not defined
  111.      */
  112.     public function getParameter(string $name)
  113.     {
  114.         return $this->parameterBag->get($name);
  115.     }
  117.     public function hasParameter(string $name): bool
  118.     {
  119.         return $this->parameterBag->has($name);
  120.     }
  122.     public function setParameter(string $name, array|bool|string|int|float|\UnitEnum|null $value)
  123.     {
  124.         $this->parameterBag->set($name, $value);
  125.     }
  127.     /**
  128.      * Sets a service.
  129.      *
  130.      * Setting a synthetic service to null resets it: has() returns false and get()
  131.      * behaves in the same way as if the service was never created.
  132.      */
  133.     public function set(string $id, ?object $service)
  134.     {
  135.         // Runs the internal initializer; used by the dumped container to include always-needed files
  136.         if (isset($this->privates['service_container']) && $this->privates['service_container'] instanceof \Closure) {
  137.             $initialize = $this->privates['service_container'];
  138.             unset($this->privates['service_container']);
  139.             $initialize();
  140.         }
  142.         if ('service_container' === $id) {
  143.             throw new InvalidArgumentException('You cannot set service "service_container".');
  144.         }
  146.         if (!(isset($this->fileMap[$id]) || isset($this->methodMap[$id]))) {
  147.             if (isset($this->syntheticIds[$id]) || !isset($this->getRemovedIds()[$id])) {
  148.                 // no-op
  149.             } elseif (null === $service) {
  150.                 throw new InvalidArgumentException(sprintf('The "%s" service is private, you cannot unset it.', $id));
  151.             } else {
  152.                 throw new InvalidArgumentException(sprintf('The "%s" service is private, you cannot replace it.', $id));
  153.             }
  154.         } elseif (isset($this->services[$id])) {
  155.             throw new InvalidArgumentException(sprintf('The "%s" service is already initialized, you cannot replace it.', $id));
  156.         }
  158.         if (isset($this->aliases[$id])) {
  159.             unset($this->aliases[$id]);
  160.         }
  162.         if (null === $service) {
  163.             unset($this->services[$id]);
  165.             return;
  166.         }
  168.         $this->services[$id] = $service;
  169.     }
  171.     public function has(string $id): bool
  172.     {
  173.         if (isset($this->aliases[$id])) {
  174.             $id = $this->aliases[$id];
  175.         }
  176.         if (isset($this->services[$id])) {
  177.             return true;
  178.         }
  179.         if ('service_container' === $id) {
  180.             return true;
  181.         }
  183.         return isset($this->fileMap[$id]) || isset($this->methodMap[$id]);
  184.     }
  186.     /**
  187.      * Gets a service.
  188.      *
  189.      * @throws ServiceCircularReferenceException When a circular reference is detected
  190.      * @throws ServiceNotFoundException          When the service is not defined
  191.      * @throws \Exception                        if an exception has been thrown when the service has been resolved
  192.      *
  193.      * @see Reference
  194.      */
  195.     public function get(string $id, int $invalidBehavior = self::EXCEPTION_ON_INVALID_REFERENCE): ?object
  196.     {
  197.         return $this->services[$id]
  198.             ?? $this->services[$id = $this->aliases[$id] ?? $id]
  199.             ?? ('service_container' === $id ? $this : ($this->factories[$id] ?? $this->make(...))($id, $invalidBehavior));
  200.     }
  202.     /**
  203.      * Creates a service.
  204.      *
  205.      * As a separate method to allow "get()" to use the really fast `??` operator.
  206.      */
  207.     private function make(string $id, int $invalidBehavior)
  208.     {
  209.         if (isset($this->loading[$id])) {
  210.             throw new ServiceCircularReferenceException($id, array_merge(array_keys($this->loading), [$id]));
  211.         }
  213.         $this->loading[$id] = true;
  215.         try {
  216.             if (isset($this->fileMap[$id])) {
  217.                 return /* self::IGNORE_ON_UNINITIALIZED_REFERENCE */ 4 === $invalidBehavior ? null : $this->load($this->fileMap[$id]);
  218.             } elseif (isset($this->methodMap[$id])) {
  219.                 return /* self::IGNORE_ON_UNINITIALIZED_REFERENCE */ 4 === $invalidBehavior ? null : $this->{$this->methodMap[$id]}();
  220.             }
  221.         } catch (\Exception $e) {
  222.             unset($this->services[$id]);
  224.             throw $e;
  225.         } finally {
  226.             unset($this->loading[$id]);
  227.         }
  229.         if (self::EXCEPTION_ON_INVALID_REFERENCE === $invalidBehavior) {
  230.             if (!$id) {
  231.                 throw new ServiceNotFoundException($id);
  232.             }
  233.             if (isset($this->syntheticIds[$id])) {
  234.                 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));
  235.             }
  236.             if (isset($this->getRemovedIds()[$id])) {
  237.                 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));
  238.             }
  240.             $alternatives = [];
  241.             foreach ($this->getServiceIds() as $knownId) {
  242.                 if ('' === $knownId || '.' === $knownId[0]) {
  243.                     continue;
  244.                 }
  245.                 $lev = levenshtein($id, $knownId);
  246.                 if ($lev <= \strlen($id) / 3 || str_contains($knownId, $id)) {
  247.                     $alternatives[] = $knownId;
  248.                 }
  249.             }
  251.             throw new ServiceNotFoundException($id, null, null, $alternatives);
  252.         }
  254.         return null;
  255.     }
  257.     /**
  258.      * Returns true if the given service has actually been initialized.
  259.      */
  260.     public function initialized(string $id): bool
  261.     {
  262.         if (isset($this->aliases[$id])) {
  263.             $id = $this->aliases[$id];
  264.         }
  266.         if ('service_container' === $id) {
  267.             return false;
  268.         }
  270.         return isset($this->services[$id]);
  271.     }
  273.     public function reset()
  274.     {
  275.         $services = $this->services + $this->privates;
  276.         $this->services = $this->factories = $this->privates = [];
  278.         foreach ($services as $service) {
  279.             try {
  280.                 if ($service instanceof ResetInterface) {
  281.                     $service->reset();
  282.                 }
  283.             } catch (\Throwable) {
  284.                 continue;
  285.             }
  286.         }
  287.     }
  289.     /**
  290.      * Gets all service ids.
  291.      *
  292.      * @return string[]
  293.      */
  294.     public function getServiceIds(): array
  295.     {
  296.         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))));
  297.     }
  299.     /**
  300.      * Gets service ids that existed at compile time.
  301.      */
  302.     public function getRemovedIds(): array
  303.     {
  304.         return [];
  305.     }
  307.     /**
  308.      * Camelizes a string.
  309.      */
  310.     public static function camelize(string $id): string
  311.     {
  312.         return strtr(ucwords(strtr($id, ['_' => ' ', '.' => '_ ', '\\' => '_ '])), [' ' => '']);
  313.     }
  315.     /**
  316.      * A string to underscore.
  317.      */
  318.     public static function underscore(string $id): string
  319.     {
  320.         return strtolower(preg_replace(['/([A-Z]+)([A-Z][a-z])/', '/([a-z\d])([A-Z])/'], ['\\1_\\2', '\\1_\\2'], str_replace('_', '.', $id)));
  321.     }
  323.     /**
  324.      * Creates a service by requiring its factory file.
  325.      */
  326.     protected function load(string $file)
  327.     {
  328.         return require $file;
  329.     }
  331.     /**
  332.      * Fetches a variable from the environment.
  333.      *
  334.      * @throws EnvNotFoundException When the environment variable is not found and has no default value
  335.      */
  336.     protected function getEnv(string $name): mixed
  337.     {
  338.         if (isset($this->resolving[$envName = "env($name)"])) {
  339.             throw new ParameterCircularReferenceException(array_keys($this->resolving));
  340.         }
  341.         if (isset($this->envCache[$name]) || \array_key_exists($name, $this->envCache)) {
  342.             return $this->envCache[$name];
  343.         }
  344.         if (!$this->has($id = 'container.env_var_processors_locator')) {
  345.             $this->set($id, new ServiceLocator([]));
  346.         }
  347.         $this->getEnv ??= $this->getEnv(...);
  348.         $processors = $this->get($id);
  350.         if (false !== $i = strpos($name, ':')) {
  351.             $prefix = substr($name, 0, $i);
  352.             $localName = substr($name, 1 + $i);
  353.         } else {
  354.             $prefix = 'string';
  355.             $localName = $name;
  356.         }
  358.         if ($processors->has($prefix)) {
  359.             $processor = $processors->get($prefix);
  360.         } else {
  361.             $processor = new EnvVarProcessor($this);
  362.             if (false === $i) {
  363.                 $prefix = '';
  364.             }
  365.         }
  367.         $this->resolving[$envName] = true;
  368.         try {
  369.             return $this->envCache[$name] = $processor->getEnv($prefix, $localName, $this->getEnv);
  370.         } finally {
  371.             unset($this->resolving[$envName]);
  372.         }
  373.     }
  375.     /**
  376.      * @internal
  377.      */
  378.     final protected function getService(string|false $registry, string $id, ?string $method, string|bool $load): mixed
  379.     {
  380.         if ('service_container' === $id) {
  381.             return $this;
  382.         }
  383.         if (\is_string($load)) {
  384.             throw new RuntimeException($load);
  385.         }
  386.         if (null === $method) {
  387.             return false !== $registry ? $this->{$registry}[$id] ?? null : null;
  388.         }
  389.         if (false !== $registry) {
  390.             return $this->{$registry}[$id] ??= $load ? $this->load($method) : $this->{$method}();
  391.         }
  392.         if (!$load) {
  393.             return $this->{$method}();
  394.         }
  396.         return ($factory = $this->factories[$id] ?? $this->factories['service_container'][$id] ?? null) ? $factory() : $this->load($method);
  397.     }
  399.     private function __clone()
  400.     {
  401.     }
  402. }