Documentation

ParameterBag
in package
implements ParameterBagInterface

Holds parameters.

Tags
author

Fabien Potencier fabien@symfony.com

Table of Contents

Interfaces

ParameterBagInterface
ParameterBagInterface is the interface implemented by objects that manage service container parameters.

Properties

$deprecatedParameters  : array<string|int, mixed>
$parameters  : mixed
$resolved  : mixed

Methods

__construct()  : mixed
add()  : void
Adds parameters to the service container parameters.
all()  : array<string|int, mixed>
Gets the service container parameters.
allDeprecated()  : array<string|int, mixed>
clear()  : void
Clears all parameters.
deprecate()  : void
Deprecates a service container parameter.
escapeValue()  : mixed
Escape parameter placeholders %.
get()  : array<string|int, mixed>|bool|string|int|float|UnitEnum|null
Gets a service container parameter.
has()  : bool
Returns true if a parameter name is defined.
isResolved()  : bool
remove()  : void
Removes a parameter.
resolve()  : void
Replaces parameter placeholders (%name%) by their values for all parameters.
resolveString()  : mixed
Resolves parameters inside a string.
resolveValue()  : mixed
Replaces parameter placeholders (%name%) by their values.
set()  : void
Sets a service container parameter.
unescapeValue()  : mixed
Unescape parameter placeholders %.

Properties

$deprecatedParameters

protected array<string|int, mixed> $deprecatedParameters = []

Methods

__construct()

public __construct([array<string|int, mixed> $parameters = [] ]) : mixed
Parameters
$parameters : array<string|int, mixed> = []

add()

Adds parameters to the service container parameters.

public add(array<string|int, mixed> $parameters) : void
Parameters
$parameters : array<string|int, mixed>

all()

Gets the service container parameters.

public all() : array<string|int, mixed>
Return values
array<string|int, mixed>

allDeprecated()

public allDeprecated() : array<string|int, mixed>
Return values
array<string|int, mixed>

deprecate()

Deprecates a service container parameter.

public deprecate(string $name, string $package, string $version[, string $message = 'The parameter "%s" is deprecated.' ]) : void
Parameters
$name : string
$package : string
$version : string
$message : string = 'The parameter "%s" is deprecated.'
Tags
throws
ParameterNotFoundException

if the parameter is not defined

escapeValue()

Escape parameter placeholders %.

public escapeValue(mixed $value) : mixed
Parameters
$value : mixed

get()

Gets a service container parameter.

public get(string $name) : array<string|int, mixed>|bool|string|int|float|UnitEnum|null
Parameters
$name : string
Return values
array<string|int, mixed>|bool|string|int|float|UnitEnum|null

has()

Returns true if a parameter name is defined.

public has(string $name) : bool
Parameters
$name : string
Return values
bool

isResolved()

public isResolved() : bool
Return values
bool

remove()

Removes a parameter.

public remove(string $name) : void
Parameters
$name : string

resolve()

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

public resolve() : void

resolveString()

Resolves parameters inside a string.

public resolveString(string $value[, array<string|int, mixed> $resolving = [] ]) : mixed
Parameters
$value : string
$resolving : array<string|int, mixed> = []

An array of keys that are being resolved (used internally to detect circular references)

Tags
throws
ParameterNotFoundException

if a placeholder references a parameter that does not exist

throws
ParameterCircularReferenceException

if a circular reference if detected

throws
RuntimeException

when a given parameter has a type problem

resolveValue()

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

public resolveValue(TValue $value[, array<string|int, mixed> $resolving = [] ]) : mixed
Parameters
$value : TValue
$resolving : array<string|int, mixed> = []

An array of keys that are being resolved (used internally to detect circular references)

Tags
template
psalm-return

(TValue is scalar ? array|scalar : array<array|scalar>)

throws
ParameterNotFoundException

if a placeholder references a parameter that does not exist

throws
ParameterCircularReferenceException

if a circular reference if detected

throws
RuntimeException

when a given parameter has a type problem

set()

Sets a service container parameter.

public set(string $name, array<string|int, mixed>|bool|string|int|float|UnitEnum|null $value) : void
Parameters
$name : string
$value : array<string|int, mixed>|bool|string|int|float|UnitEnum|null

unescapeValue()

Unescape parameter placeholders %.

public unescapeValue(mixed $value) : mixed
Parameters
$value : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results