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 ;
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface ;
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag ;
use Symfony\Component\DependencyInjection\ParameterBag\FrozenParameterBag ;
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 .
*
2011-01-03 08:07:06 +00:00
* Parameter and service keys are case insensitive .
2010-01-04 14:26:20 +00:00
*
* A service id can contain lowercased letters , digits , underscores , and dots .
* Underscores are used to separate words , and dots to group services
* under namespaces :
*
* < ul >
* < li > request </ li >
* < li > mysql_session_storage </ li >
* < li > symfony . mysql_session_storage </ li >
* </ ul >
*
* A service can also be defined by creating a method named
* getXXXService (), where XXX is the camelized version of the id :
*
* < ul >
* < li > request -> getRequestService () </ li >
* < li > mysql_session_storage -> getMysqlSessionStorageService () </ li >
* < li > symfony . mysql_session_storage -> getSymfony_MysqlSessionStorageService () </ li >
* </ ul >
*
* The container can have three possible behaviors when a service does not exist :
*
* * 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 )
*
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
*/
2010-11-15 09:05:16 +00:00
class Container implements ContainerInterface
2010-01-04 14:26:20 +00:00
{
2010-06-27 17:28:29 +01:00
protected $parameterBag ;
protected $services ;
2011-01-31 18:04:42 +00:00
protected $scopes ;
protected $scopeChildren ;
protected $scopedServices ;
protected $scopeStacks ;
2011-01-18 15:07:12 +00:00
protected $loading = array ();
2010-05-06 12:25:53 +01:00
/**
* Constructor .
*
2010-07-27 14:33:28 +01:00
* @ param ParameterBagInterface $parameterBag A ParameterBagInterface instance
2010-05-06 12:25:53 +01:00
*/
2010-06-27 17:28:29 +01:00
public function __construct ( ParameterBagInterface $parameterBag = null )
2010-01-04 14:26:20 +00:00
{
2010-06-27 17:28:29 +01:00
$this -> parameterBag = null === $parameterBag ? new ParameterBag () : $parameterBag ;
2011-01-17 22:28:59 +00:00
$this -> services =
$this -> scopes =
$this -> scopeChildren =
$this -> scopedServices =
$this -> scopeStacks = array ();
2010-06-27 17:28:29 +01:00
$this -> set ( 'service_container' , $this );
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 ());
2010-05-06 12:25:53 +01:00
}
/**
2010-06-27 17:28:29 +01:00
* Returns true if the container parameter bag are frozen .
2010-05-06 12:25:53 +01:00
*
2010-06-27 17:28:29 +01:00
* @ return Boolean true if the container parameter bag are frozen , false otherwise
2010-05-06 12:25:53 +01:00
*/
2010-06-27 17:28:29 +01:00
public function isFrozen ()
2010-05-06 12:25:53 +01:00
{
2010-06-27 17:28:29 +01:00
return $this -> parameterBag instanceof FrozenParameterBag ;
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
*
2010-06-27 17:28:29 +01:00
* @ param string $name The parameter name
2010-05-06 12:25:53 +01:00
*
* @ return mixed The parameter value
*
* @ throws \InvalidArgumentException if the parameter is not defined
*/
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 .
*
* @ param string $name The parameter name
*
2011-01-21 01:39:28 +00:00
* @ return Boolean 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
*
* @ param string $name The parameter name
* @ param mixed $parameters The parameter value
*/
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 .
*
* @ param string $id The service identifier
* @ param object $service The service instance
2011-01-17 22:28:59 +00:00
* @ param string $scope The scope of the service
2010-05-06 12:25:53 +01:00
*/
2011-01-17 22:28:59 +00:00
public function set ( $id , $service , $scope = self :: SCOPE_CONTAINER )
2010-01-04 14:26:20 +00:00
{
2011-01-17 22:28:59 +00:00
if ( self :: SCOPE_PROTOTYPE === $scope ) {
throw new \InvalidArgumentException ( 'You cannot set services of scope "prototype".' );
}
$id = strtolower ( $id );
if ( self :: SCOPE_CONTAINER !== $scope ) {
if ( ! isset ( $this -> scopedServices [ $scope ])) {
throw new \RuntimeException ( 'You cannot set services of inactive scopes.' );
}
$this -> scopedServices [ $scope ][ $id ] = $service ;
}
$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 .
*
* @ param string $id The service identifier
*
* @ return Boolean true if the service is defined , false otherwise
*/
2010-06-27 17:28:29 +01:00
public function has ( $id )
2010-01-19 12:29:28 +00:00
{
2011-01-03 08:07:06 +00:00
$id = strtolower ( $id );
2010-05-06 12:25:53 +01:00
return isset ( $this -> services [ $id ]) || method_exists ( $this , 'get' . strtr ( $id , array ( '_' => '' , '.' => '_' )) . 'Service' );
2010-01-19 12:29:28 +00:00
}
2010-05-06 12:25:53 +01:00
/**
* Gets a service .
*
2010-06-27 17:28:29 +01:00
* If a service is both defined through a set () method and
2010-05-06 12:25:53 +01:00
* with a set * Service () method , the former has always precedence .
*
* @ param string $id The service identifier
* @ param int $invalidBehavior The behavior when the service does not exist
*
* @ return object The associated service
*
* @ throws \InvalidArgumentException if the service is not defined
*
* @ see Reference
*/
2010-06-27 17:28:29 +01:00
public function get ( $id , $invalidBehavior = self :: EXCEPTION_ON_INVALID_REFERENCE )
2010-01-04 14:26:20 +00:00
{
2011-01-03 08:07:06 +00:00
$id = strtolower ( $id );
2010-05-06 12:25:53 +01:00
2010-05-07 15:09:11 +01:00
if ( isset ( $this -> services [ $id ])) {
2010-05-06 12:25:53 +01:00
return $this -> services [ $id ];
}
2011-01-18 15:07:12 +00:00
if ( isset ( $this -> loading [ $id ])) {
throw new \LogicException ( sprintf ( 'Circular reference detected for service "%s" (services currently loading: %s).' , $id , implode ( ', ' , array_keys ( $this -> loading ))));
2011-01-06 13:18:28 +00:00
}
2010-06-27 17:28:29 +01:00
if ( method_exists ( $this , $method = 'get' . strtr ( $id , array ( '_' => '' , '.' => '_' )) . 'Service' )) {
2011-01-18 15:07:12 +00:00
$this -> loading [ $id ] = true ;
2011-01-06 13:18:28 +00:00
$service = $this -> $method ();
2011-01-18 15:07:12 +00:00
unset ( $this -> loading [ $id ]);
2011-01-06 13:18:28 +00:00
return $service ;
2010-05-06 12:25:53 +01:00
}
2010-05-07 15:09:11 +01:00
if ( self :: EXCEPTION_ON_INVALID_REFERENCE === $invalidBehavior ) {
2010-05-06 12:25:53 +01:00
throw new \InvalidArgumentException ( sprintf ( 'The service "%s" does not exist.' , $id ));
}
2010-01-04 14:26:20 +00: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
{
2010-05-06 12:25:53 +01:00
$ids = array ();
$r = new \ReflectionClass ( $this );
2010-05-07 15:09:11 +01:00
foreach ( $r -> getMethods () as $method ) {
2011-02-04 18:10:13 +00:00
if ( preg_match ( '/^get(.+)Service$/' , $method -> getName (), $match )) {
2010-05-06 12:25:53 +01:00
$ids [] = self :: underscore ( $match [ 1 ]);
}
}
return array_merge ( $ids , array_keys ( $this -> services ));
2010-01-04 14:26:20 +00:00
}
2011-01-17 22:28:59 +00:00
/**
* This is called when you enter a scope
*
* @ param string $name
* @ return void
*/
public function enterScope ( $name )
{
if ( ! isset ( $this -> scopes [ $name ])) {
throw new \InvalidArgumentException ( sprintf ( 'The scope "%s" does not exist.' , $name ));
}
if ( self :: SCOPE_CONTAINER !== $this -> scopes [ $name ] && ! isset ( $this -> scopedServices [ $this -> scopes [ $name ]])) {
throw new \RuntimeException ( sprintf ( 'The parent scope "%s" must be active when entering this scope.' , $this -> scopes [ $name ]));
}
// check if a scope of this name is already active, if so we need to
// remove all services of this scope, and those of any of its child
// scopes from the global services map
if ( isset ( $this -> scopedServices [ $name ])) {
$services = array ( $this -> services , $name => $this -> scopedServices [ $name ]);
unset ( $this -> scopedServices [ $name ]);
foreach ( $this -> scopeChildren [ $name ] as $child ) {
$services [ $child ] = $this -> scopedServices [ $child ];
unset ( $this -> scopedServices [ $child ]);
}
// update global map
$this -> services = call_user_func_array ( 'array_diff_key' , $services );
array_shift ( $services );
// add stack entry for this scope so we can restore the removed services later
if ( ! isset ( $this -> scopeStacks [ $name ])) {
$this -> scopeStacks [ $name ] = new \SplStack ();
}
$this -> scopeStacks [ $name ] -> push ( $services );
}
$this -> scopedServices [ $name ] = array ();
}
/**
* This is called to leave the current scope , and move back to the parent
* scope .
*
2011-02-13 18:06:41 +00:00
* @ param string $name The name of the scope to leave
2011-01-17 22:28:59 +00:00
* @ return void
2011-02-13 18:06:41 +00:00
* @ throws \InvalidArgumentException if the scope is not active
2011-01-17 22:28:59 +00:00
*/
public function leaveScope ( $name )
{
if ( ! isset ( $this -> scopedServices [ $name ])) {
throw new \InvalidArgumentException ( sprintf ( 'The scope "%s" is not active.' , $name ));
}
// remove all services of this scope, or any of its child scopes from
// the global service map
$services = array ( $this -> services , $this -> scopedServices [ $name ]);
unset ( $this -> scopedServices [ $name ]);
foreach ( $this -> scopeChildren [ $name ] as $child ) {
if ( ! isset ( $this -> scopedServices [ $child ])) {
continue ;
}
$services [] = $this -> scopedServices [ $child ];
unset ( $this -> scopedServices [ $child ]);
}
$this -> services = call_user_func_array ( 'array_diff_key' , $services );
// check if we need to restore services of a previous scope of this type
if ( isset ( $this -> scopeStacks [ $name ]) && count ( $this -> scopeStacks [ $name ]) > 0 ) {
$services = $this -> scopeStacks [ $name ] -> pop ();
$this -> scopedServices += $services ;
array_unshift ( $services , $this -> services );
$this -> services = call_user_func_array ( 'array_merge' , $services );
}
}
/**
2011-02-13 18:06:41 +00:00
* Adds a scope to the container .
2011-01-17 22:28:59 +00:00
*
2011-02-13 09:33:53 +00:00
* @ param ScopeInterface $scope
2011-01-17 22:28:59 +00:00
* @ return void
*/
2011-02-13 09:33:53 +00:00
public function addScope ( ScopeInterface $scope )
2011-01-17 22:28:59 +00:00
{
2011-02-13 09:33:53 +00:00
$name = $scope -> getName ();
$parentScope = $scope -> getParentName ();
2011-01-17 22:28:59 +00:00
if ( self :: SCOPE_CONTAINER === $name || self :: SCOPE_PROTOTYPE === $name ) {
throw new \InvalidArgumentException ( sprintf ( 'The scope "%s" is reserved.' , $name ));
}
if ( isset ( $this -> scopes [ $name ])) {
throw new \InvalidArgumentException ( sprintf ( 'A scope with name "%s" already exists.' , $name ));
}
if ( self :: SCOPE_CONTAINER !== $parentScope && ! isset ( $this -> scopes [ $parentScope ])) {
throw new \InvalidArgumentException ( sprintf ( 'The parent scope "%s" does not exist, or is invalid.' , $parentScope ));
}
$this -> scopes [ $name ] = $parentScope ;
$this -> scopeChildren [ $name ] = array ();
// normalize the child relations
2011-01-31 18:04:42 +00:00
while ( $parentScope !== self :: SCOPE_CONTAINER ) {
2011-01-17 22:28:59 +00:00
$this -> scopeChildren [ $parentScope ][] = $name ;
2011-01-31 18:04:42 +00:00
$parentScope = $this -> scopes [ $parentScope ];
2011-01-17 22:28:59 +00:00
}
}
/**
* Returns whether this container has a certain scope
*
2011-02-13 18:06:41 +00:00
* @ param string $name The name of the scope
2011-01-17 22:28:59 +00:00
* @ return Boolean
*/
public function hasScope ( $name )
{
return isset ( $this -> scopes [ $name ]);
}
/**
* Returns whether this scope is currently active
*
* This does not actually check if the passed scope actually exists .
*
* @ param string $name
* @ return Boolean
*/
public function isScopeActive ( $name )
{
return isset ( $this -> scopedServices [ $name ]);
}
2011-02-13 18:06:41 +00:00
/**
* Camelizes a string .
*
* @ param string $id A string to camelize
* @ return string The camelized string
*/
2010-05-06 12:25:53 +01:00
static public function camelize ( $id )
{
2010-10-20 19:33:59 +01:00
return preg_replace ( array ( '/(?:^|_)+(.)/e' , '/\.(.)/e' ), array ( " strtoupper(' \\ 1') " , " '_'.strtoupper(' \\ 1') " ), $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
* @ return string The underscored string
*/
2010-05-06 12:25:53 +01:00
static public function underscore ( $id )
{
return strtolower ( preg_replace ( array ( '/([A-Z]+)([A-Z][a-z])/' , '/([a-z\d])([A-Z])/' ), array ( '\\1_\\2' , '\\1_\\2' ), strtr ( $id , '_' , '.' )));
}
2010-01-04 14:26:20 +00:00
}