1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. DependencyInjection
  7. \
  8. ParameterBag
  9. \
  10. EnvPlaceholderParameterBag

EnvPlaceholderParameterBag

class EnvPlaceholderParameterBag extends ParameterBag

Properties

protected $parameters from ParameterBag
protected $resolved from ParameterBag

Methods

__construct(array $parameters = array())

No description

from ParameterBag
clear()

Clears all parameters.

from ParameterBag
add(array $parameters)

Adds parameters to the service container parameters.

from ParameterBag
array
all()

Gets the service container parameters.

from ParameterBag
mixed
get(string $name)

Gets a service container parameter.

set(string $name, mixed $value)

Sets a service container parameter.

from ParameterBag
bool
has(string $name)

Returns true if a parameter name is defined.

from ParameterBag
remove(string $name)

Removes a parameter.

from ParameterBag
resolve()

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

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

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

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

Resolves parameters inside a string.

from ParameterBag
isResolved()

No description

from ParameterBag
mixed
escapeValue(mixed $value)

Escape parameter placeholders %.

from ParameterBag
mixed
unescapeValue(mixed $value)

Unescape parameter placeholders %.

from ParameterBag
string
getEnvPlaceholderUniquePrefix()

Gets the common env placeholder prefix for env vars created by this bag.

string[][]
getEnvPlaceholders()

Returns the map of env vars used in the resolved parameter values to their placeholders.

array
getUnusedEnvPlaceholders()

No description

clearUnusedEnvPlaceholders()

No description

mergeEnvPlaceholders(EnvPlaceholderParameterBag $bag)

Merges the env placeholders of another EnvPlaceholderParameterBag.

setProvidedTypes(array $providedTypes)

Maps env prefixes to their corresponding PHP types.

string[][]
getProvidedTypes()

Gets the PHP types corresponding to env() parameter prefixes.

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

string getEnvPlaceholderUniquePrefix()

Gets the common env placeholder prefix for env vars created by this bag.

Return Value

string

string[][] getEnvPlaceholders()

Returns the map of env vars used in the resolved parameter values to their placeholders.

Return Value

string[][] A map of env var names to their placeholders

array getUnusedEnvPlaceholders()

Return Value

array

clearUnusedEnvPlaceholders()

mergeEnvPlaceholders(EnvPlaceholderParameterBag $bag)

Merges the env placeholders of another EnvPlaceholderParameterBag.

Parameters

EnvPlaceholderParameterBag $bag

setProvidedTypes(array $providedTypes)

Maps env prefixes to their corresponding PHP types.

Parameters

array $providedTypes

string[][] getProvidedTypes()

Gets the PHP types corresponding to env() parameter prefixes.

Return Value

string[][]