1. interface
  2. Symfony
  3. Component
  4. DependencyInjection
  5. ParameterBag
  6. ParameterBagInterface

ParameterBagInterface

interface ParameterBagInterface

ParameterBagInterface.

Methods

clear()

Clears all parameters.

add(array $parameters)

Adds parameters to the service container parameters.

array
all()

Gets the service container parameters.

mixed
get(string $name)

Gets a service container parameter.

remove(string $name)

Removes a parameter.

set(string $name, mixed $value)

Sets a service container parameter.

bool
has(string $name)

Returns true if a parameter name is defined.

resolve()

Replaces parameter placeholders (%name%) by their values for all parameters.

resolveValue(mixed $value)

Replaces parameter placeholders (%name%) by their values.

mixed
escapeValue(mixed $value)

Escape parameter placeholders %.

mixed
unescapeValue(mixed $value)

Unescape parameter placeholders %.

Details

at line line 29
clear()

Clears all parameters.

Exceptions

LogicException if the ParameterBagInterface can not be cleared

at line line 38
add(array $parameters)

Adds parameters to the service container parameters.

Parameters

array $parameters An array of parameters

Exceptions

LogicException if the parameter can not be added

at line line 45
array all()

Gets the service container parameters.

Return Value

array An array of parameters

at line line 56
mixed get(string $name)

Gets a service container parameter.

Parameters

string $name The parameter name

Return Value

mixed The parameter value

Exceptions

ParameterNotFoundException if the parameter is not defined

at line line 63
remove(string $name)

Removes a parameter.

Parameters

string $name The parameter name

at line line 73
set(string $name, mixed $value)

Sets a service container parameter.

Parameters

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

Exceptions

LogicException if the parameter can not be set

at line line 82
bool has(string $name)

Returns true if a parameter name is defined.

Parameters

string $name The parameter name

Return Value

bool true if the parameter name is defined, false otherwise

at line line 87
resolve()

Replaces parameter placeholders (%name%) by their values for all parameters.

at line line 96
resolveValue(mixed $value)

Replaces parameter placeholders (%name%) by their values.

Parameters

mixed $value A value

Exceptions

ParameterNotFoundException if a placeholder references a parameter that does not exist

at line line 105
mixed escapeValue(mixed $value)

Escape parameter placeholders %.

Parameters

mixed $value

Return Value

mixed

at line line 114
mixed unescapeValue(mixed $value)

Unescape parameter placeholders %.

Parameters

mixed $value

Return Value

mixed