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

Breadcrumb

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

class AbstractConfigurator

Hierarchy

  • class \Symfony\Component\DependencyInjection\Loader\Configurator\AbstractConfigurator

Expanded class hierarchy of AbstractConfigurator

File

vendor/symfony/dependency-injection/Loader/Configurator/AbstractConfigurator.php, line 25

Namespace

Symfony\Component\DependencyInjection\Loader\Configurator
View source
abstract class AbstractConfigurator {
    public const FACTORY = 'unknown';
    
    /**
     * @var \Closure(mixed, bool):mixed|null
     */
    public static ?\Closure $valuePreProcessor = null;
    
    /** @internal */
    protected Definition|Alias|null $definition = null;
    public function __call(string $method, array $args) : mixed {
        if (method_exists($this, 'set' . $method)) {
            return $this->{'set' . $method}(...$args);
        }
        throw new \BadMethodCallException(\sprintf('Call to undefined method "%s::%s()".', static::class, $method));
    }
    public function __sleep() : array {
        throw new \BadMethodCallException('Cannot serialize ' . __CLASS__);
    }
    public function __wakeup() : void {
        throw new \BadMethodCallException('Cannot unserialize ' . __CLASS__);
    }
    
    /**
     * Checks that a value is valid, optionally replacing Definition and Reference configurators by their configure value.
     *
     * @param bool $allowServices whether Definition and Reference are allowed; by default, only scalars, arrays and enum are
     *
     * @return mixed the value, optionally cast to a Definition/Reference
     */
    public static function processValue(mixed $value, bool $allowServices = false) : mixed {
        if (\is_array($value)) {
            foreach ($value as $k => $v) {
                $value[$k] = static::processValue($v, $allowServices);
            }
            return self::$valuePreProcessor ? (self::$valuePreProcessor)($value, $allowServices) : $value;
        }
        if (self::$valuePreProcessor) {
            $value = (self::$valuePreProcessor)($value, $allowServices);
        }
        if ($value instanceof ReferenceConfigurator) {
            $reference = new Reference($value->id, $value->invalidBehavior);
            return $value instanceof ClosureReferenceConfigurator ? new ServiceClosureArgument($reference) : $reference;
        }
        if ($value instanceof InlineServiceConfigurator) {
            $def = $value->definition;
            $value->definition = null;
            return $def;
        }
        if ($value instanceof ParamConfigurator) {
            return (string) $value;
        }
        if ($value instanceof self) {
            throw new InvalidArgumentException(\sprintf('"%s()" can be used only at the root of service configuration files.', $value::FACTORY));
        }
        switch (true) {
            case null === $value:
            case \is_scalar($value):
            case $value instanceof \UnitEnum:
                return $value;
            case $value instanceof ArgumentInterface:
            case $value instanceof Definition:
            case $value instanceof Expression:
            case $value instanceof Parameter:
            case $value instanceof AbstractArgument:
            case $value instanceof Reference:
                if ($allowServices) {
                    return $value;
                }
        }
        throw new InvalidArgumentException(\sprintf('Cannot use values of type "%s" in service configuration files.', get_debug_type($value)));
    }

}

Members

Title Sort descending Modifiers Object type Summary Overrides
AbstractConfigurator::$definition protected property @internal
AbstractConfigurator::$valuePreProcessor public static property
AbstractConfigurator::FACTORY public constant 10
AbstractConfigurator::processValue public static function Checks that a value is valid, optionally replacing Definition and Reference configurators by their configure value.
AbstractConfigurator::__call public function
AbstractConfigurator::__sleep public function
AbstractConfigurator::__wakeup public function
RSS feed
Powered by Drupal