1. class
  2. Symfony
  3. Component
  4. DependencyInjection
  5. ParameterBag
  6. ParameterBag

ParameterBag

class ParameterBag implements ParameterBagInterface

Holds parameters.

Methods

__construct(array $parameters = array())

Constructor.

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.

set(string $name, mixed $value)

Sets a service container parameter.

bool
has(string $name)

Returns true if a parameter name is defined.

remove(string $name)

Removes a parameter.

resolve()

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

resolveValue(mixed $value, array $resolving = array())

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

string
resolveString(string $value, array $resolving = array())

Resolves parameters inside a string.

isResolved()

No description

mixed
escapeValue(mixed $value)

Escape parameter placeholders %.

mixed
unescapeValue(mixed $value)

Unescape parameter placeholders %.

Details

at line line 33
__construct(array $parameters = array())

Constructor.

Parameters

array $parameters An array of parameters

at line line 41
clear()

Clears all parameters.

at line line 51
add(array $parameters)

Adds parameters to the service container parameters.

Parameters

array $parameters An array of parameters

at line line 63
array all()

Gets the service container parameters.

Return Value

array An array of parameters

at line line 77
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 106
set(string $name, mixed $value)

Sets a service container parameter.

Parameters

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

at line line 118
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 128
remove(string $name)

Removes a parameter.

Parameters

string $name The parameter name

at line line 136
resolve()

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

at line line 170
resolveValue(mixed $value, array $resolving = array())

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

Parameters

mixed $value A value
array $resolving An array of keys that are being resolved (used internally to detect circular references)

Exceptions

ParameterNotFoundException if a placeholder references a parameter that does not exist
ParameterCircularReferenceException if a circular reference if detected
RuntimeException when a given parameter has a type problem.

at line line 200
string resolveString(string $value, array $resolving = array())

Resolves parameters inside a string.

Parameters

string $value The string to resolve
array $resolving An array of keys that are being resolved (used internally to detect circular references)

Return Value

string The resolved string

Exceptions

ParameterNotFoundException if a placeholder references a parameter that does not exist
ParameterCircularReferenceException if a circular reference if detected
RuntimeException when a given parameter has a type problem.

at line line 241
isResolved()

at line line 249
mixed escapeValue(mixed $value)

Escape parameter placeholders %.

Parameters

mixed $value

Return Value

mixed

at line line 267
mixed unescapeValue(mixed $value)

Unescape parameter placeholders %.

Parameters

mixed $value

Return Value

mixed