Symfony2 API
Class

Symfony\Component\DependencyInjection\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.
Boolean 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.
mixed 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()

mixed escapeValue(mixed $value)

Escape parameter placeholders %
mixed unescapeValue(mixed $value)

Unescape parameter placeholders %

Details

at line 37
public __construct(array $parameters = array())

Constructor.

Parameters

array $parameters An array of parameters

at line 49
public clear()

Clears all parameters.

at line 61
public add(array $parameters)

Adds parameters to the service container parameters.

Parameters

array $parameters An array of parameters

at line 75
public array all()

Gets the service container parameters.

Return Value

array An array of parameters

at line 91
public 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 122
public set(string $name, mixed $value)

Sets a service container parameter.

Parameters

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

at line 136
public Boolean has(string $name)

Returns true if a parameter name is defined.

Parameters

string $name The parameter name

Return Value

Boolean true if the parameter name is defined, false otherwise

at line 148
public remove(string $name)

Removes a parameter.

Parameters

string $name The parameter name

at line 156
public resolve()

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

at line 190
public mixed 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)

Return Value

mixed The resolved value

Exceptions

ParameterNotFoundException if a placeholder references a parameter that does not exist

at line 220
public 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 263
public isResolved()

at line 271
public mixed escapeValue(mixed $value)

Escape parameter placeholders %

Parameters

mixed $value

Return Value

mixed

at line 289
public mixed unescapeValue(mixed $value)

Unescape parameter placeholders %

Parameters

mixed $value

Return Value

mixed