1. interface
  2. Symfony
  3. \
  4. Component
  5. \
  6. DependencyInjection
  7. \
  8. ParameterBag
  9. \
  10. ParameterBagInterface

ParameterBagInterface

interface ParameterBagInterface

ParameterBagInterface is the interface implemented by objects that manage service container parameters.

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

clear()

Clears all parameters.

Exceptions

LogicException if the ParameterBagInterface can not be cleared

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

array all()

Gets the service container parameters.

Return Value

array An array of parameters

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

remove(string $name)

Removes a parameter.

Parameters

string $name The parameter name

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

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

resolve()

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

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

mixed escapeValue(mixed $value)

Escape parameter placeholders %.

Parameters

mixed $value

Return Value

mixed

mixed unescapeValue(mixed $value)

Unescape parameter placeholders %.

Parameters

mixed $value

Return Value

mixed