interface ParameterBagInterface

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

@author Fabien Potencier <fabien@symfony.com>

Hierarchy

interface \Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface

Expanded class hierarchy of ParameterBagInterface

All classes that implement ParameterBagInterface

5 files declare their use of ParameterBagInterface

Container.php in vendor/symfony/dependency-injection/Container.php
ContainerBuilder.php in vendor/symfony/dependency-injection/ContainerBuilder.php
ContainerBuilder.php in core/lib/Drupal/Core/DependencyInjection/ContainerBuilder.php
MergeExtensionConfigurationPass.php in vendor/symfony/dependency-injection/Compiler/MergeExtensionConfigurationPass.php
ResolveParameterPlaceHoldersPass.php in vendor/symfony/dependency-injection/Compiler/ResolveParameterPlaceHoldersPass.php

File

vendor/symfony/dependency-injection/ParameterBag/ParameterBagInterface.php, line 22

Namespace

Symfony\Component\DependencyInjection\ParameterBag

View source

interface ParameterBagInterface {
    
    /**
     * Clears all parameters.
     *
     * @throws LogicException if the ParameterBagInterface cannot be cleared
     */
    public function clear() : void;
    
    /**
     * Adds parameters to the service container parameters.
     *
     * @throws LogicException if the parameter cannot be added
     */
    public function add(array $parameters) : void;
    
    /**
     * Gets the service container parameters.
     */
    public function all() : array;
    
    /**
     * Gets a service container parameter.
     *
     * @throws ParameterNotFoundException if the parameter is not defined
     */
    public function get(string $name) : array|bool|string|int|float|\UnitEnum|null;
    
    /**
     * Removes a parameter.
     */
    public function remove(string $name) : void;
    
    /**
     * Sets a service container parameter.
     *
     * @throws LogicException if the parameter cannot be set
     */
    public function set(string $name, array|bool|string|int|float|\UnitEnum|null $value) : void;
    
    /**
     * Returns true if a parameter name is defined.
     */
    public function has(string $name) : bool;
    
    /**
     * Replaces parameter placeholders (%name%) by their values for all parameters.
     */
    public function resolve() : void;
    
    /**
     * Replaces parameter placeholders (%name%) by their values.
     *
     * @throws ParameterNotFoundException if a placeholder references a parameter that does not exist
     */
    public function resolveValue(mixed $value) : mixed;
    
    /**
     * Escape parameter placeholders %.
     */
    public function escapeValue(mixed $value) : mixed;
    
    /**
     * Unescape parameter placeholders %.
     */
    public function unescapeValue(mixed $value) : mixed;

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overrides
ParameterBagInterface::add	public	function	Adds parameters to the service container parameters.	1
ParameterBagInterface::all	public	function	Gets the service container parameters.	1
ParameterBagInterface::clear	public	function	Clears all parameters.	1
ParameterBagInterface::escapeValue	public	function	Escape parameter placeholders %.	1
ParameterBagInterface::get	public	function	Gets a service container parameter.	1
ParameterBagInterface::has	public	function	Returns true if a parameter name is defined.	1
ParameterBagInterface::remove	public	function	Removes a parameter.	1
ParameterBagInterface::resolve	public	function	Replaces parameter placeholders (%name%) by their values for all parameters.	1
ParameterBagInterface::resolveValue	public	function	Replaces parameter placeholders (%name%) by their values.	1
ParameterBagInterface::set	public	function	Sets a service container parameter.	1
ParameterBagInterface::unescapeValue	public	function	Unescape parameter placeholders %.	1