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

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