ContainerInterface

interface ContainerInterface implements ContainerInterface

ContainerInterface is the interface implemented by service container classes.

Constants

EXCEPTION_ON_INVALID_REFERENCE
NULL_ON_INVALID_REFERENCE
IGNORE_ON_INVALID_REFERENCE
IGNORE_ON_UNINITIALIZED_REFERENCE

Methods

set(string $id, object $service)

Sets a service.

object get(string $id, int $invalidBehavior = self::EXCEPTION_ON_INVALID_REFERENCE)

Gets a service.

bool has(string $id)

Returns true if the given service is defined.

bool initialized(string $id)

Check for whether or not a service has been initialized.

mixed getParameter(string $name)

Gets a parameter.

bool hasParameter(string $name)

Checks if a parameter exists.

setParameter(string $name, mixed $value)

Sets a parameter.

Details

set(string $id, object $service)

Sets a service.

Parameters

string $id The service identifier
object $service The service instance

object get(string $id, int $invalidBehavior = self::EXCEPTION_ON_INVALID_REFERENCE)

Gets a service.

Parameters

string $id The service identifier
int $invalidBehavior The behavior when the service does not exist

Return Value

object The associated service

Exceptions

ServiceCircularReferenceException When a circular reference is detected
ServiceNotFoundException When the service is not defined

See also

Reference

bool has(string $id)

Returns true if the given service is defined.

Parameters

string $id The service identifier

Return Value

bool true if the service is defined, false otherwise

bool initialized(string $id)

Check for whether or not a service has been initialized.

Parameters

string $id

Return Value

bool true if the service has been initialized, false otherwise

mixed getParameter(string $name)

Gets a parameter.

Parameters

string $name The parameter name

Return Value

mixed The parameter value

Exceptions

InvalidArgumentException if the parameter is not defined

bool hasParameter(string $name)

Checks if a parameter exists.

Parameters

string $name The parameter name

Return Value

bool The presence of parameter in container

setParameter(string $name, mixed $value)

Sets a parameter.

Parameters

string $name The parameter name
mixed $value The parameter value

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/DependencyInjection/ContainerInterface.html