W3cubDocs

/Symfony 2.7

Symfony\Component\DependencyInjection\ParameterBag\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.

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

public clear()

Clears all parameters.

public add(array $parameters)

Adds parameters to the service container parameters.

Parameters

array $parameters An array of parameters

public array all()

Gets the service container parameters.

Return Value

array An array of parameters

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

public set(string $name, mixed $value)

Sets a service container parameter.

Parameters

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

public 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

public resolve()

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

public 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

public mixed escapeValue(mixed $value)

Escape parameter placeholders %

Parameters

mixed $value

Return Value

mixed

public mixed unescapeValue(mixed $value)

Unescape parameter placeholders %

Parameters

mixed $value

Return Value

mixed