interface ParameterBagInterface in Zircon Profile 8

ParameterBagInterface.

@author Fabien Potencier <[e-mail]>

Hierarchy

• interface \Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface

2 files declare their use of ParameterBagInterface

Container.php in vendor/symfony/dependency-injection/Container.php

ContainerBuilder.php in core/lib/Drupal/Core/DependencyInjection/ContainerBuilder.php

Contains \Drupal\Core\DependencyInjection\ContainerBuilder.

File

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

Namespace

Symfony\Component\DependencyInjection\ParameterBag

interface ParameterBagInterface {

  /**
   * Clears all parameters.
   *
   * @throws LogicException if the ParameterBagInterface can not be cleared
   */
  public function clear();

  /**
   * Adds parameters to the service container parameters.
   *
   * @param array $parameters An array of parameters
   *
   * @throws LogicException if the parameter can not be added
   */
  public function add(array $parameters);

  /**
   * Gets the service container parameters.
   *
   * @return array An array of parameters
   */
  public function all();

  /**
   * Gets a service container parameter.
   *
   * @param string $name The parameter name
   *
   * @return mixed The parameter value
   *
   * @throws ParameterNotFoundException if the parameter is not defined
   */
  public function get($name);

  /**
   * Sets a service container parameter.
   *
   * @param string $name  The parameter name
   * @param mixed  $value The parameter value
   *
   * @throws LogicException if the parameter can not be set
   */
  public function set($name, $value);

  /**
   * Returns true if a parameter name is defined.
   *
   * @param string $name The parameter name
   *
   * @return bool true if the parameter name is defined, false otherwise
   */
  public function has($name);

  /**
   * Replaces parameter placeholders (%name%) by their values for all parameters.
   */
  public function resolve();

  /**
   * Replaces parameter placeholders (%name%) by their values.
   *
   * @param mixed $value A value
   *
   * @throws ParameterNotFoundException if a placeholder references a parameter that does not exist
   */
  public function resolveValue($value);

  /**
   * Escape parameter placeholders %.
   *
   * @param mixed $value
   *
   * @return mixed
   */
  public function escapeValue($value);

  /**
   * Unescape parameter placeholders %.
   *
   * @param mixed $value
   *
   * @return mixed
   */
  public function unescapeValue($value);

}

Members

Name	Modifiers	Type	Description	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::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