ContainerInterface
interface ContainerInterface
ContainerInterface is the interface implemented by service container classes.
Constants
| EXCEPTION_ON_INVALID_REFERENCE | |
| NULL_ON_INVALID_REFERENCE | |
| IGNORE_ON_INVALID_REFERENCE | |
| SCOPE_CONTAINER | |
| SCOPE_PROTOTYPE |
Methods
| set(string $id, object $service, string $scope = self::SCOPE_CONTAINER) 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. | |
| mixed | getParameter(string $name) Gets a parameter. | |
| bool | hasParameter(string $name) Checks if a parameter exists. | |
| setParameter(string $name, mixed $value) Sets a parameter. | ||
| enterScope(string $name) deprecated Enters the given scope. | ||
| leaveScope(string $name) deprecated Leaves the current scope, and re-enters the parent scope. | ||
| addScope(ScopeInterface $scope) deprecated Adds a scope to the container. | ||
| bool | hasScope(string $name) deprecated Whether this container has the given scope. | |
| bool | isScopeActive(string $name) deprecated Determines whether the given scope is currently active. |
Details
set(string $id, object $service, string $scope = self::SCOPE_CONTAINER)
Sets a service.
Note: The $scope parameter is deprecated since version 2.8 and will be removed in 3.0.
Parameters
| string | $id | The service identifier |
| object | $service | The service instance |
| string | $scope | The scope of the service |
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 |
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 |
enterScope(string $name) deprecated
deprecated
Enters the given scope.
Parameters
| string | $name |
leaveScope(string $name) deprecated
deprecated
Leaves the current scope, and re-enters the parent scope.
Parameters
| string | $name |
addScope(ScopeInterface $scope) deprecated
deprecated
Adds a scope to the container.
Parameters
| ScopeInterface | $scope |
bool hasScope(string $name) deprecated
deprecated
Whether this container has the given scope.
Parameters
| string | $name |
Return Value
| bool |
bool isScopeActive(string $name) deprecated
deprecated
Determines whether the given scope is currently active.
It does however not check if the scope actually exists.
Parameters
| string | $name |
Return Value
| bool |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/DependencyInjection/ContainerInterface.html