2010-01-04 14:26:20 +00:00
< ? php
/*
2011-01-15 13:29:43 +00:00
* This file is part of the Symfony package .
2010-01-04 14:26:20 +00:00
*
2011-03-06 11:40:06 +00:00
* ( c ) Fabien Potencier < fabien @ symfony . com >
2010-01-04 14:26:20 +00:00
*
2011-01-15 13:29:43 +00:00
* For the full copyright and license information , please view the LICENSE
* file that was distributed with this source code .
2010-01-04 14:26:20 +00:00
*/
2011-01-15 13:29:43 +00:00
namespace Symfony\Component\DependencyInjection ;
2016-08-12 19:34:27 +01:00
use Symfony\Component\DependencyInjection\Exception\EnvNotFoundException ;
2011-12-04 23:51:22 +00:00
use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException ;
2016-10-22 17:25:15 +01:00
use Symfony\Component\DependencyInjection\Exception\ParameterCircularReferenceException ;
2018-06-30 07:39:51 +01:00
use Symfony\Component\DependencyInjection\Exception\RuntimeException ;
2011-05-25 08:46:30 +01:00
use Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException ;
2018-07-26 10:03:18 +01:00
use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException ;
2016-08-12 19:34:27 +01:00
use Symfony\Component\DependencyInjection\ParameterBag\EnvPlaceholderParameterBag ;
2011-01-15 13:29:43 +00:00
use Symfony\Component\DependencyInjection\ParameterBag\FrozenParameterBag ;
2018-07-26 10:03:18 +01:00
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface ;
2018-09-05 09:24:27 +01:00
use Symfony\Contracts\Service\ResetInterface ;
2011-01-15 13:29:43 +00:00
2010-01-04 14:26:20 +00:00
/**
* Container is a dependency injection container .
*
2010-06-27 17:28:29 +01:00
* It gives access to object instances ( services ) .
2010-01-04 14:26:20 +00:00
* Services and parameters are simple key / pair stores .
2017-08-30 08:27:55 +01:00
* The container can have four possible behaviors when a service
* does not exist ( or is not initialized for the last case ) :
2010-01-04 14:26:20 +00:00
*
* * EXCEPTION_ON_INVALID_REFERENCE : Throws an exception ( the default )
* * NULL_ON_INVALID_REFERENCE : Returns null
* * IGNORE_ON_INVALID_REFERENCE : Ignores the wrapping command asking for the reference
* ( for instance , ignore a setter if the service does not exist )
2017-08-30 08:27:55 +01:00
* * IGNORE_ON_UNINITIALIZED_REFERENCE : Ignores / returns null for uninitialized services or invalid references
2010-01-04 14:26:20 +00:00
*
2011-03-06 11:40:06 +00:00
* @ author Fabien Potencier < fabien @ symfony . com >
2011-01-17 22:28:59 +00:00
* @ author Johannes M . Schmitt < schmittjoh @ gmail . com >
2010-01-04 14:26:20 +00:00
*/
2015-07-23 11:18:12 +01:00
class Container implements ResettableContainerInterface
2010-01-04 14:26:20 +00:00
{
2010-06-27 17:28:29 +01:00
protected $parameterBag ;
2019-01-16 20:35:37 +00:00
protected $services = [];
protected $privates = [];
protected $fileMap = [];
protected $methodMap = [];
protected $factories = [];
protected $aliases = [];
protected $loading = [];
protected $resolving = [];
protected $syntheticIds = [];
private $envCache = [];
2016-08-19 13:18:08 +01:00
private $compiled = false ;
2016-10-22 17:25:15 +01:00
private $getEnv ;
2015-05-15 13:54:35 +01:00
2010-06-27 17:28:29 +01:00
public function __construct ( ParameterBagInterface $parameterBag = null )
2010-01-04 14:26:20 +00:00
{
2016-08-12 19:34:27 +01:00
$this -> parameterBag = $parameterBag ? : new EnvPlaceholderParameterBag ();
2010-01-04 14:26:20 +00:00
}
2010-05-06 12:25:53 +01:00
/**
2011-01-16 07:12:36 +00:00
* Compiles the container .
2010-07-16 08:15:22 +01:00
*
* This method does two things :
*
* * Parameter values are resolved ;
2011-01-14 17:43:51 +00:00
* * The parameter bag is frozen .
2010-05-06 12:25:53 +01:00
*/
2011-01-16 07:12:36 +00:00
public function compile ()
2010-05-06 12:25:53 +01:00
{
2010-07-16 08:15:22 +01:00
$this -> parameterBag -> resolve ();
2010-06-27 17:28:29 +01:00
$this -> parameterBag = new FrozenParameterBag ( $this -> parameterBag -> all ());
2016-08-19 13:18:08 +01:00
$this -> compiled = true ;
}
/**
* Returns true if the container is compiled .
*
* @ return bool
*/
public function isCompiled ()
{
return $this -> compiled ;
2010-05-06 12:25:53 +01:00
}
/**
2010-06-27 17:28:29 +01:00
* Gets the service container parameter bag .
2010-05-06 12:25:53 +01:00
*
2010-07-27 14:33:28 +01:00
* @ return ParameterBagInterface A ParameterBagInterface instance
2010-05-06 12:25:53 +01:00
*/
2010-06-27 17:28:29 +01:00
public function getParameterBag ()
2010-05-06 12:25:53 +01:00
{
2010-06-27 17:28:29 +01:00
return $this -> parameterBag ;
2010-05-06 12:25:53 +01:00
}
/**
2010-06-27 17:28:29 +01:00
* Gets a parameter .
2010-05-06 12:25:53 +01:00
*
2012-05-15 21:19:31 +01:00
* @ param string $name The parameter name
2010-05-06 12:25:53 +01:00
*
2014-11-30 13:33:44 +00:00
* @ return mixed The parameter value
2010-05-06 12:25:53 +01:00
*
2011-12-04 23:51:22 +00:00
* @ throws InvalidArgumentException if the parameter is not defined
2010-05-06 12:25:53 +01:00
*/
public function getParameter ( $name )
{
2010-06-27 17:28:29 +01:00
return $this -> parameterBag -> get ( $name );
2010-05-06 12:25:53 +01:00
}
2010-08-25 23:30:10 +01:00
/**
* Checks if a parameter exists .
*
2012-05-15 21:19:31 +01:00
* @ param string $name The parameter name
2010-08-25 23:30:10 +01:00
*
2014-11-30 13:33:44 +00:00
* @ return bool The presence of parameter in container
2010-08-25 23:30:10 +01:00
*/
public function hasParameter ( $name )
{
return $this -> parameterBag -> has ( $name );
}
2010-05-06 12:25:53 +01:00
/**
2010-06-27 17:28:29 +01:00
* Sets a parameter .
2010-05-06 12:25:53 +01:00
*
2011-04-23 16:05:44 +01:00
* @ param string $name The parameter name
* @ param mixed $value The parameter value
2010-05-06 12:25:53 +01:00
*/
public function setParameter ( $name , $value )
{
2010-06-27 17:28:29 +01:00
$this -> parameterBag -> set ( $name , $value );
2010-05-06 12:25:53 +01:00
}
/**
* Sets a service .
*
2019-03-08 18:10:13 +00:00
* Setting a synthetic service to null resets it : has () returns false and get ()
2013-07-25 16:13:34 +01:00
* behaves in the same way as if the service was never created .
*
2010-05-06 12:25:53 +01:00
* @ param string $id The service identifier
* @ param object $service The service instance
*/
2015-09-04 20:54:37 +01:00
public function set ( $id , $service )
2010-01-04 14:26:20 +00:00
{
2018-01-20 10:46:59 +00:00
// Runs the internal initializer; used by the dumped container to include always-needed files
if ( isset ( $this -> privates [ 'service_container' ]) && $this -> privates [ 'service_container' ] instanceof \Closure ) {
$initialize = $this -> privates [ 'service_container' ];
unset ( $this -> privates [ 'service_container' ]);
$initialize ();
}
2014-07-19 19:07:52 +01:00
if ( 'service_container' === $id ) {
2015-04-01 03:23:52 +01:00
throw new InvalidArgumentException ( 'You cannot set service "service_container".' );
2014-07-19 19:07:52 +01:00
}
2015-04-01 03:23:52 +01:00
2017-10-10 15:32:10 +01:00
if ( ! ( isset ( $this -> fileMap [ $id ]) || isset ( $this -> methodMap [ $id ]))) {
if ( isset ( $this -> syntheticIds [ $id ]) || ! isset ( $this -> getRemovedIds ()[ $id ])) {
2017-10-07 22:38:34 +01:00
// no-op
} elseif ( null === $service ) {
2017-10-10 15:32:10 +01:00
throw new InvalidArgumentException ( sprintf ( 'The "%s" service is private, you cannot unset it.' , $id ));
2016-06-22 21:01:50 +01:00
} else {
2017-10-10 15:32:10 +01:00
throw new InvalidArgumentException ( sprintf ( 'The "%s" service is private, you cannot replace it.' , $id ));
2017-01-14 09:13:01 +00:00
}
2017-10-07 22:38:34 +01:00
} elseif ( isset ( $this -> services [ $id ])) {
2017-10-05 16:11:25 +01:00
throw new InvalidArgumentException ( sprintf ( 'The "%s" service is already initialized, you cannot replace it.' , $id ));
2017-05-20 14:15:17 +01:00
}
2016-02-09 19:58:01 +00:00
if ( isset ( $this -> aliases [ $id ])) {
unset ( $this -> aliases [ $id ]);
}
2013-07-25 16:13:34 +01:00
if ( null === $service ) {
unset ( $this -> services [ $id ]);
2016-06-22 21:01:50 +01:00
2017-05-20 14:15:17 +01:00
return ;
2016-06-22 21:01:50 +01:00
}
2017-05-20 14:15:17 +01:00
$this -> services [ $id ] = $service ;
2010-01-04 14:26:20 +00:00
}
2010-05-06 12:25:53 +01:00
/**
* Returns true if the given service is defined .
*
2012-05-15 21:19:31 +01:00
* @ param string $id The service identifier
2010-05-06 12:25:53 +01:00
*
2014-11-30 13:33:44 +00:00
* @ return bool true if the service is defined , false otherwise
2010-05-06 12:25:53 +01:00
*/
2010-06-27 17:28:29 +01:00
public function has ( $id )
2010-01-19 12:29:28 +00:00
{
2017-05-20 21:54:17 +01:00
if ( isset ( $this -> aliases [ $id ])) {
$id = $this -> aliases [ $id ];
}
if ( isset ( $this -> services [ $id ])) {
return true ;
}
2017-07-18 09:02:14 +01:00
if ( 'service_container' === $id ) {
return true ;
}
2016-09-30 22:26:24 +01:00
2017-08-07 19:06:09 +01:00
return isset ( $this -> fileMap [ $id ]) || isset ( $this -> methodMap [ $id ]);
2010-01-19 12:29:28 +00:00
}
2010-05-06 12:25:53 +01:00
/**
* Gets a service .
*
2014-11-30 13:33:44 +00:00
* @ param string $id The service identifier
* @ param int $invalidBehavior The behavior when the service does not exist
2010-05-06 12:25:53 +01:00
*
* @ return object The associated service
*
2012-09-07 23:56:45 +01:00
* @ throws ServiceCircularReferenceException When a circular reference is detected
2014-07-26 13:09:47 +01:00
* @ throws ServiceNotFoundException When the service is not defined
* @ throws \Exception if an exception has been thrown when the service has been resolved
2010-05-06 12:25:53 +01:00
*
* @ see Reference
*/
2017-12-12 21:42:08 +00:00
public function get ( $id , $invalidBehavior = /* self::EXCEPTION_ON_INVALID_REFERENCE */ 1 )
2010-01-04 14:26:20 +00:00
{
2018-02-13 08:11:34 +00:00
return $this -> services [ $id ]
? ? $this -> services [ $id = $this -> aliases [ $id ] ? ? $id ]
2019-01-16 20:35:37 +00:00
? ? ( 'service_container' === $id ? $this : ( $this -> factories [ $id ] ? ? [ $this , 'make' ])( $id , $invalidBehavior ));
2018-02-13 08:11:34 +00:00
}
2010-05-06 12:25:53 +01:00
2018-02-13 08:11:34 +00:00
/**
* Creates a service .
*
* As a separate method to allow " get() " to use the really fast `??` operator .
*/
private function make ( string $id , int $invalidBehavior )
{
2017-05-20 21:54:17 +01:00
if ( isset ( $this -> loading [ $id ])) {
2019-01-16 20:35:37 +00:00
throw new ServiceCircularReferenceException ( $id , array_merge ( array_keys ( $this -> loading ), [ $id ]));
2017-05-20 21:54:17 +01:00
}
2011-01-06 13:18:28 +00:00
2017-05-20 21:54:17 +01:00
$this -> loading [ $id ] = true ;
2013-05-05 11:11:01 +01:00
2017-05-20 21:54:17 +01:00
try {
2017-08-07 19:06:09 +01:00
if ( isset ( $this -> fileMap [ $id ])) {
2017-12-14 19:48:22 +00:00
return /* self::IGNORE_ON_UNINITIALIZED_REFERENCE */ 4 === $invalidBehavior ? null : $this -> load ( $this -> fileMap [ $id ]);
2017-08-07 19:06:09 +01:00
} elseif ( isset ( $this -> methodMap [ $id ])) {
2017-12-14 19:48:22 +00:00
return /* self::IGNORE_ON_UNINITIALIZED_REFERENCE */ 4 === $invalidBehavior ? null : $this -> { $this -> methodMap [ $id ]}();
2013-04-30 18:55:25 +01:00
}
2017-05-20 21:54:17 +01:00
} catch ( \Exception $e ) {
unset ( $this -> services [ $id ]);
2013-04-30 18:55:25 +01:00
2017-05-20 21:54:17 +01:00
throw $e ;
} finally {
unset ( $this -> loading [ $id ]);
2015-05-15 13:54:35 +01:00
}
2017-05-20 21:54:17 +01:00
2017-12-12 21:42:08 +00:00
if ( /* self::EXCEPTION_ON_INVALID_REFERENCE */ 1 === $invalidBehavior ) {
2017-07-24 20:11:47 +01:00
if ( ! $id ) {
throw new ServiceNotFoundException ( $id );
}
2017-10-07 22:38:34 +01:00
if ( isset ( $this -> syntheticIds [ $id ])) {
2019-01-16 20:35:37 +00:00
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 ));
2017-10-07 22:38:34 +01:00
}
if ( isset ( $this -> getRemovedIds ()[ $id ])) {
2019-01-16 20:35:37 +00:00
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 ));
2017-10-07 22:38:34 +01:00
}
2017-07-24 20:11:47 +01:00
2019-01-16 20:35:37 +00:00
$alternatives = [];
2017-07-24 20:11:47 +01:00
foreach ( $this -> getServiceIds () as $knownId ) {
2018-04-13 15:55:17 +01:00
if ( '' === $knownId || '.' === $knownId [ 0 ]) {
continue ;
}
2017-07-24 20:11:47 +01:00
$lev = levenshtein ( $id , $knownId );
2018-07-26 09:45:46 +01:00
if ( $lev <= \strlen ( $id ) / 3 || false !== strpos ( $knownId , $id )) {
2017-07-24 20:11:47 +01:00
$alternatives [] = $knownId ;
}
}
2013-04-30 18:55:25 +01:00
2017-07-24 20:11:47 +01:00
throw new ServiceNotFoundException ( $id , null , null , $alternatives );
2015-05-15 13:54:35 +01:00
}
2010-01-04 14:26:20 +00:00
}
2012-05-01 13:46:26 +01:00
2012-04-18 18:26:58 +01:00
/**
2014-12-21 17:00:50 +00:00
* Returns true if the given service has actually been initialized .
2012-04-18 18:26:58 +01:00
*
2012-05-15 21:19:31 +01:00
* @ param string $id The service identifier
2012-04-18 18:26:58 +01:00
*
2014-11-30 13:33:44 +00:00
* @ return bool true if service has already been initialized , false otherwise
2012-04-18 18:26:58 +01:00
*/
public function initialized ( $id )
{
2017-07-12 19:41:02 +01:00
if ( isset ( $this -> aliases [ $id ])) {
$id = $this -> aliases [ $id ];
}
2014-07-19 19:07:52 +01:00
if ( 'service_container' === $id ) {
2017-07-18 08:52:56 +01:00
return false ;
2014-07-19 19:07:52 +01:00
}
2016-08-21 13:01:27 +01:00
return isset ( $this -> services [ $id ]);
2012-04-18 18:26:58 +01:00
}
2010-01-04 14:26:20 +00:00
2015-07-02 23:05:34 +01:00
/**
* { @ inheritdoc }
*/
public function reset ()
{
2018-09-05 09:24:27 +01:00
$services = $this -> services + $this -> privates ;
2019-01-16 20:35:37 +00:00
$this -> services = $this -> factories = $this -> privates = [];
2018-09-05 09:24:27 +01:00
foreach ( $services as $service ) {
try {
if ( $service instanceof ResetInterface ) {
$service -> reset ();
}
} catch ( \Throwable $e ) {
continue ;
}
}
2015-07-02 23:05:34 +01:00
}
2010-05-06 12:25:53 +01:00
/**
* Gets all service ids .
*
* @ return array An array of all defined service ids
*/
public function getServiceIds ()
2010-01-04 14:26:20 +00:00
{
2019-01-16 20:35:37 +00:00
return array_unique ( array_merge ([ 'service_container' ], array_keys ( $this -> fileMap ), array_keys ( $this -> methodMap ), array_keys ( $this -> services )));
2010-01-04 14:26:20 +00:00
}
2017-10-07 22:38:34 +01:00
/**
* Gets service ids that existed at compile time .
*
* @ return array
*/
public function getRemovedIds ()
{
2019-01-16 20:35:37 +00:00
return [];
2017-10-07 22:38:34 +01:00
}
2011-02-13 18:06:41 +00:00
/**
* Camelizes a string .
*
* @ param string $id A string to camelize
2011-12-13 07:50:54 +00:00
*
2011-02-13 18:06:41 +00:00
* @ return string The camelized string
*/
2012-07-09 13:50:58 +01:00
public static function camelize ( $id )
2010-05-06 12:25:53 +01:00
{
2019-01-16 20:35:37 +00:00
return strtr ( ucwords ( strtr ( $id , [ '_' => ' ' , '.' => '_ ' , '\\' => '_ ' ])), [ ' ' => '' ]);
2010-05-06 12:25:53 +01:00
}
2011-02-13 18:06:41 +00:00
/**
* A string to underscore .
*
* @ param string $id The string to underscore
2011-12-13 07:50:54 +00:00
*
2011-02-13 18:06:41 +00:00
* @ return string The underscored string
*/
2012-07-09 13:50:58 +01:00
public static function underscore ( $id )
2010-05-06 12:25:53 +01:00
{
2019-01-16 20:35:37 +00:00
return strtolower ( preg_replace ([ '/([A-Z]+)([A-Z][a-z])/' , '/([a-z\d])([A-Z])/' ], [ '\\1_\\2' , '\\1_\\2' ], str_replace ( '_' , '.' , $id )));
2010-05-06 12:25:53 +01:00
}
2015-07-16 09:25:41 +01:00
2017-07-24 20:11:47 +01:00
/**
* Creates a service by requiring its factory file .
*
* @ return object The service created by the file
*/
protected function load ( $file )
{
return require $file ;
}
2016-08-12 19:34:27 +01:00
/**
* Fetches a variable from the environment .
*
2017-08-13 22:58:09 +01:00
* @ param string $name The name of the environment variable
2016-08-12 19:34:27 +01:00
*
2017-08-16 09:13:36 +01:00
* @ return mixed The value to use for the provided environment variable name
2016-08-12 19:34:27 +01:00
*
* @ throws EnvNotFoundException When the environment variable is not found and has no default value
*/
protected function getEnv ( $name )
{
2016-10-22 17:25:15 +01:00
if ( isset ( $this -> resolving [ $envName = " env( $name ) " ])) {
throw new ParameterCircularReferenceException ( array_keys ( $this -> resolving ));
}
2019-02-23 15:06:07 +00:00
if ( isset ( $this -> envCache [ $name ]) || \array_key_exists ( $name , $this -> envCache )) {
2016-08-12 19:34:27 +01:00
return $this -> envCache [ $name ];
}
2016-10-22 17:25:15 +01:00
if ( ! $this -> has ( $id = 'container.env_var_processors_locator' )) {
2019-01-16 20:35:37 +00:00
$this -> set ( $id , new ServiceLocator ([]));
2016-08-12 19:34:27 +01:00
}
2016-10-22 17:25:15 +01:00
if ( ! $this -> getEnv ) {
$this -> getEnv = new \ReflectionMethod ( $this , __FUNCTION__ );
$this -> getEnv -> setAccessible ( true );
$this -> getEnv = $this -> getEnv -> getClosure ( $this );
2016-08-12 19:34:27 +01:00
}
2016-10-22 17:25:15 +01:00
$processors = $this -> get ( $id );
if ( false !== $i = strpos ( $name , ':' )) {
$prefix = substr ( $name , 0 , $i );
$localName = substr ( $name , 1 + $i );
} else {
$prefix = 'string' ;
$localName = $name ;
2016-08-12 19:34:27 +01:00
}
2016-10-22 17:25:15 +01:00
$processor = $processors -> has ( $prefix ) ? $processors -> get ( $prefix ) : new EnvVarProcessor ( $this );
2016-08-12 19:34:27 +01:00
2016-10-22 17:25:15 +01:00
$this -> resolving [ $envName ] = true ;
try {
return $this -> envCache [ $name ] = $processor -> getEnv ( $prefix , $localName , $this -> getEnv );
} finally {
unset ( $this -> resolving [ $envName ]);
}
2016-08-12 19:34:27 +01:00
}
2018-06-30 07:39:51 +01:00
/**
* @ internal
*/
final protected function getService ( $registry , $id , $method , $load )
{
if ( 'service_container' === $id ) {
return $this ;
}
if ( \is_string ( $load )) {
throw new RuntimeException ( $load );
}
if ( null === $method ) {
return false !== $registry ? $this -> { $registry }[ $id ] ? ? null : null ;
}
if ( false !== $registry ) {
return $this -> { $registry }[ $id ] ? ? $this -> { $registry }[ $id ] = $load ? $this -> load ( $method ) : $this -> { $method }();
}
if ( ! $load ) {
return $this -> { $method }();
}
return ( $factory = $this -> factories [ $id ] ? ? $this -> factories [ 'service_container' ][ $id ] ? ? null ) ? $factory () : $this -> load ( $method );
}
2015-07-16 09:25:41 +01:00
private function __clone ()
{
}
2010-01-04 14:26:20 +00:00
}