ParameterBag

class ParameterBag implements ParameterBagInterface

Holds parameters.

Methods

	__construct(array $parameters = array())
	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()
mixed	escapeValue(mixed $value) Escape parameter placeholders %.
mixed	unescapeValue(mixed $value) Unescape parameter placeholders %.

Details

__construct(array $parameters = array())

Parameters

array

$parameters

An array of parameters

clear()

Clears all parameters.

add(array $parameters)

Adds parameters to the service container parameters.

Parameters

array

$parameters

An array of parameters

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

set(string $name, mixed $value)

Sets a service container parameter.

Parameters

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

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

remove(string $name)

Removes a parameter.

Parameters

string

$name

The parameter name

resolve()

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

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.

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.

isResolved()

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

Links:

http://api.symfony.com/master/Symfony/Component/DependencyInjection/ParameterBag/ParameterBag.html

doc_Symfony

2016-10-28 06:25:43

Comments