Documentation

ContainerInterface extends ContainerInterface

ContainerInterface is the interface implemented by service container classes.

Tags
author

Fabien Potencier fabien@symfony.com

author

Johannes M. Schmitt schmittjoh@gmail.com

Table of Contents

Constants

EXCEPTION_ON_INVALID_REFERENCE  = 1
IGNORE_ON_INVALID_REFERENCE  = 3
IGNORE_ON_UNINITIALIZED_REFERENCE  = 4
NULL_ON_INVALID_REFERENCE  = 2
RUNTIME_EXCEPTION_ON_INVALID_REFERENCE  = 0

Methods

get()  : mixed
Finds an entry of the container by its identifier and returns it.
getParameter()  : array<string|int, mixed>|bool|string|int|float|UnitEnum|null
has()  : bool
Returns true if the container can return an entry for the given identifier.
hasParameter()  : bool
initialized()  : bool
Check for whether or not a service has been initialized.
set()  : mixed
setParameter()  : mixed

Constants

IGNORE_ON_UNINITIALIZED_REFERENCE

public mixed IGNORE_ON_UNINITIALIZED_REFERENCE = 4

RUNTIME_EXCEPTION_ON_INVALID_REFERENCE

public mixed RUNTIME_EXCEPTION_ON_INVALID_REFERENCE = 0

Methods

get()

Finds an entry of the container by its identifier and returns it.

public get(string $id[, int $invalidBehavior = self::EXCEPTION_ON_INVALID_REFERENCE ]) : mixed
Parameters
$id : string

Identifier of the entry to look for.

$invalidBehavior : int = self::EXCEPTION_ON_INVALID_REFERENCE
Tags
throws
ServiceCircularReferenceException

When a circular reference is detected

throws
ServiceNotFoundException

When the service is not defined

see
Reference
Return values
mixed

Entry.

getParameter()

public getParameter(string $name) : array<string|int, mixed>|bool|string|int|float|UnitEnum|null
Parameters
$name : string
Tags
throws
InvalidArgumentException

if the parameter is not defined

Return values
array<string|int, mixed>|bool|string|int|float|UnitEnum|null

has()

Returns true if the container can return an entry for the given identifier.

public has(string $id) : bool

Returns false otherwise.

has($id) returning true does not mean that get($id) will not throw an exception. It does however mean that get($id) will not throw a NotFoundExceptionInterface.

Parameters
$id : string

Identifier of the entry to look for.

Return values
bool

hasParameter()

public hasParameter(string $name) : bool
Parameters
$name : string
Return values
bool

initialized()

Check for whether or not a service has been initialized.

public initialized(string $id) : bool
Parameters
$id : string
Return values
bool

set()

public set(string $id, object|null $service) : mixed
Parameters
$id : string
$service : object|null

setParameter()

public setParameter(string $name, array<string|int, mixed>|bool|string|int|float|UnitEnum|null $value) : mixed
Parameters
$name : string
$value : array<string|int, mixed>|bool|string|int|float|UnitEnum|null

        
On this page

Search results