interface ContainerInterface

ContainerInterface is the interface implemented by service container classes.

Constants

EXCEPTION_ON_INVALID_REFERENCE

NULL_ON_INVALID_REFERENCE

IGNORE_ON_INVALID_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

at line line 36
set(string $id, object $service)

Sets a service.

Parameters

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

at line line 51
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

at line line 60
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

at line line 69
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

at line line 80
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

at line line 89
bool hasParameter(string $name)

Checks if a parameter exists.

Parameters

string $name The parameter name

Return Value

bool The presence of parameter in container

at line line 97
setParameter(string $name, mixed $value)

Sets a parameter.

Parameters

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