class FrozenParameterBag extends ParameterBag

Holds read-only parameters.

Methods

__construct(array $parameters = array())

For performance reasons, the constructor assumes that all keys are already lowercased.

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 31
__construct(array $parameters = array())

For performance reasons, the constructor assumes that all keys are already lowercased.

This is always the case when used internally.

Parameters

array $parameters An array of parameters

at line line 40
clear()

Clears all parameters.

at line line 48
add(array $parameters)

Adds parameters to the service container parameters.

Parameters

array $parameters An array of parameters

in ParameterBag at line line 59
array all()

Gets the service container parameters.

Return Value

array An array of parameters

in ParameterBag at line line 67
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 56
set(string $name, mixed $value)

Sets a service container parameter.

Parameters

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

in ParameterBag at line line 104
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 64
remove(string $name)

Removes a parameter.

Parameters

string $name The parameter name

in ParameterBag at line line 122
resolve()

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

in ParameterBag at line line 156
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.

in ParameterBag at line line 186
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.

in ParameterBag at line line 227
isResolved()

in ParameterBag at line line 235
mixed escapeValue(mixed $value)

Escape parameter placeholders %.

Parameters

mixed $value

Return Value

mixed

in ParameterBag at line line 256
mixed unescapeValue(mixed $value)

Unescape parameter placeholders %.

Parameters

mixed $value

Return Value

mixed