Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ParameterBag.php

class ParameterBag

Same name in this branch
  1. 11.1.x vendor/symfony/http-foundation/ParameterBag.php \Symfony\Component\HttpFoundation\ParameterBag

Holds parameters.

@author Fabien Potencier <fabien@symfony.com>

Hierarchy

  • class \Symfony\Component\DependencyInjection\ParameterBag\ParameterBag implements \Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface

Expanded class hierarchy of ParameterBag

6 files declare their use of ParameterBag
Container.php in vendor/symfony/dependency-injection/Container.php
ContainerBuilder.php in vendor/symfony/dependency-injection/ContainerBuilder.php
DrupalKernel.php in core/lib/Drupal/Core/DrupalKernel.php
GraphvizDumper.php in vendor/symfony/dependency-injection/Dumper/GraphvizDumper.php
PhpDumper.php in vendor/symfony/dependency-injection/Dumper/PhpDumper.php

... See full list

File

vendor/symfony/dependency-injection/ParameterBag/ParameterBag.php, line 25

Namespace

Symfony\Component\DependencyInjection\ParameterBag
View source
class ParameterBag implements ParameterBagInterface {
    protected array $parameters = [];
    protected bool $resolved = false;
    protected array $deprecatedParameters = [];
    protected array $nonEmptyParameters = [];
    public function __construct(array $parameters = []) {
        $this->add($parameters);
    }
    public function clear() : void {
        $this->parameters = [];
    }
    public function add(array $parameters) : void {
        foreach ($parameters as $key => $value) {
            $this->set($key, $value);
        }
    }
    public function all() : array {
        return $this->parameters;
    }
    public function allDeprecated() : array {
        return $this->deprecatedParameters;
    }
    public function allNonEmpty() : array {
        return $this->nonEmptyParameters;
    }
    public function get(string $name) : array|bool|string|int|float|\UnitEnum|null {
        if (!\array_key_exists($name, $this->parameters)) {
            if (!$name) {
                throw new ParameterNotFoundException($name);
            }
            if (\array_key_exists($name, $this->nonEmptyParameters)) {
                throw new ParameterNotFoundException($name, extraMessage: $this->nonEmptyParameters[$name]);
            }
            $alternatives = [];
            foreach ($this->parameters as $key => $parameterValue) {
                $lev = levenshtein($name, $key);
                if ($lev <= \strlen($name) / 3 || str_contains($key, $name)) {
                    $alternatives[] = $key;
                }
            }
            $nonNestedAlternative = null;
            if (!\count($alternatives) && str_contains($name, '.')) {
                $namePartsLength = array_map('strlen', explode('.', $name));
                $key = substr($name, 0, -1 * (1 + array_pop($namePartsLength)));
                while (\count($namePartsLength)) {
                    if ($this->has($key)) {
                        if (\is_array($this->get($key))) {
                            $nonNestedAlternative = $key;
                        }
                        break;
                    }
                    $key = substr($key, 0, -1 * (1 + array_pop($namePartsLength)));
                }
            }
            throw new ParameterNotFoundException($name, null, null, null, $alternatives, $nonNestedAlternative);
        }
        if (isset($this->deprecatedParameters[$name])) {
            trigger_deprecation(...$this->deprecatedParameters[$name]);
        }
        if (\array_key_exists($name, $this->nonEmptyParameters) && (null === $this->parameters[$name] || '' === $this->parameters[$name] || [] === $this->parameters[$name])) {
            throw new EmptyParameterValueException($this->nonEmptyParameters[$name]);
        }
        return $this->parameters[$name];
    }
    public function set(string $name, array|bool|string|int|float|\UnitEnum|null $value) : void {
        if (is_numeric($name)) {
            throw new InvalidArgumentException(\sprintf('The parameter name "%s" cannot be numeric.', $name));
        }
        $this->parameters[$name] = $value;
    }
    
    /**
     * Deprecates a service container parameter.
     *
     * @throws ParameterNotFoundException if the parameter is not defined
     */
    public function deprecate(string $name, string $package, string $version, string $message = 'The parameter "%s" is deprecated.') : void {
        if (!\array_key_exists($name, $this->parameters)) {
            throw new ParameterNotFoundException($name);
        }
        $this->deprecatedParameters[$name] = [
            $package,
            $version,
            $message,
            $name,
        ];
    }
    public function cannotBeEmpty(string $name, string $message) : void {
        $this->nonEmptyParameters[$name] = $message;
    }
    public function has(string $name) : bool {
        return \array_key_exists($name, $this->parameters);
    }
    public function remove(string $name) : void {
        unset($this->parameters[$name], $this->deprecatedParameters[$name], $this->nonEmptyParameters[$name]);
    }
    public function resolve() : void {
        if ($this->resolved) {
            return;
        }
        $parameters = [];
        foreach ($this->parameters as $key => $value) {
            try {
                $value = $this->resolveValue($value);
                $parameters[$key] = $this->unescapeValue($value);
            } catch (ParameterNotFoundException $e) {
                $e->setSourceKey($key);
                throw $e;
            }
        }
        $this->parameters = $parameters;
        $this->resolved = true;
    }
    
    /**
     * Replaces parameter placeholders (%name%) by their values.
     *
     * @template TValue of array<array|scalar>|scalar
     *
     * @param TValue $value
     * @param array  $resolving An array of keys that are being resolved (used internally to detect circular references)
     *
     * @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
     */
    public function resolveValue(mixed $value, array $resolving = []) : mixed {
        if (\is_array($value)) {
            $args = [];
            foreach ($value as $key => $v) {
                $resolvedKey = \is_string($key) ? $this->resolveValue($key, $resolving) : $key;
                if (!\is_scalar($resolvedKey) && !$resolvedKey instanceof \Stringable) {
                    throw new RuntimeException(\sprintf('Array keys must be a scalar-value, but found key "%s" to resolve to type "%s".', $key, get_debug_type($resolvedKey)));
                }
                $args[$resolvedKey] = $this->resolveValue($v, $resolving);
            }
            return $args;
        }
        if (!\is_string($value) || '' === $value || !str_contains($value, '%')) {
            return $value;
        }
        return $this->resolveString($value, $resolving);
    }
    
    /**
     * Resolves parameters inside a string.
     *
     * @param array $resolving An array of keys that are being resolved (used internally to detect circular references)
     *
     * @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
     */
    public function resolveString(string $value, array $resolving = []) : mixed {
        // we do this to deal with non string values (Boolean, integer, ...)
        // as the preg_replace_callback throw an exception when trying
        // a non-string in a parameter value
        if (preg_match('/^%([^%\\s]+)%$/', $value, $match)) {
            $key = $match[1];
            if (isset($resolving[$key])) {
                throw new ParameterCircularReferenceException(array_keys($resolving));
            }
            $resolving[$key] = true;
            return $this->resolved ? $this->get($key) : $this->resolveValue($this->get($key), $resolving);
        }
        return preg_replace_callback('/%%|%([^%\\s]+)%/', function ($match) use ($resolving, $value) {
            // skip %%
            if (!isset($match[1])) {
                return '%%';
            }
            $key = $match[1];
            if (isset($resolving[$key])) {
                throw new ParameterCircularReferenceException(array_keys($resolving));
            }
            $resolved = $this->get($key);
            if (!\is_string($resolved) && !is_numeric($resolved)) {
                throw new RuntimeException(\sprintf('A string value must be composed of strings and/or numbers, but found parameter "%s" of type "%s" inside string value "%s".', $key, get_debug_type($resolved), $value));
            }
            $resolved = (string) $resolved;
            $resolving[$key] = true;
            return $this->isResolved() ? $resolved : $this->resolveString($resolved, $resolving);
        }, $value);
    }
    public function isResolved() : bool {
        return $this->resolved;
    }
    public function escapeValue(mixed $value) : mixed {
        if (\is_string($value)) {
            return str_replace('%', '%%', $value);
        }
        if (\is_array($value)) {
            $result = [];
            foreach ($value as $k => $v) {
                $result[$k] = $this->escapeValue($v);
            }
            return $result;
        }
        return $value;
    }
    public function unescapeValue(mixed $value) : mixed {
        if (\is_string($value)) {
            return str_replace('%%', '%', $value);
        }
        if (\is_array($value)) {
            $result = [];
            foreach ($value as $k => $v) {
                $result[$k] = $this->unescapeValue($v);
            }
            return $result;
        }
        return $value;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ParameterBag::$deprecatedParameters protected property
ParameterBag::$nonEmptyParameters protected property
ParameterBag::$parameters protected property
ParameterBag::$resolved protected property
ParameterBag::add public function Adds parameters to the service container parameters. Overrides ParameterBagInterface::add 1
ParameterBag::all public function Gets the service container parameters. Overrides ParameterBagInterface::all 1
ParameterBag::allDeprecated public function
ParameterBag::allNonEmpty public function
ParameterBag::cannotBeEmpty public function 1
ParameterBag::clear public function Clears all parameters. Overrides ParameterBagInterface::clear 1
ParameterBag::deprecate public function Deprecates a service container parameter. 1
ParameterBag::escapeValue public function Escape parameter placeholders %. Overrides ParameterBagInterface::escapeValue
ParameterBag::get public function Gets a service container parameter. Overrides ParameterBagInterface::get 2
ParameterBag::has public function Returns true if a parameter name is defined. Overrides ParameterBagInterface::has 1
ParameterBag::isResolved public function
ParameterBag::remove public function Removes a parameter. Overrides ParameterBagInterface::remove 1
ParameterBag::resolve public function Replaces parameter placeholders (%name%) by their values for all parameters. Overrides ParameterBagInterface::resolve 1
ParameterBag::resolveString public function Resolves parameters inside a string.
ParameterBag::resolveValue public function Replaces parameter placeholders (%name%) by their values. Overrides ParameterBagInterface::resolveValue
ParameterBag::set public function Sets a service container parameter. Overrides ParameterBagInterface::set 1
ParameterBag::unescapeValue public function Unescape parameter placeholders %. Overrides ParameterBagInterface::unescapeValue
ParameterBag::__construct public function 2

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal