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

Breadcrumb

  1. Drupal Core 11.1.x

ContainerConfigurator.php

Namespace

Symfony\Component\DependencyInjection\Loader\Configurator

File

vendor/symfony/dependency-injection/Loader/Configurator/ContainerConfigurator.php

View source
<?php


/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

use Symfony\Component\Config\Loader\ParamConfigurator;
use Symfony\Component\DependencyInjection\Argument\AbstractArgument;
use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
use Symfony\Component\DependencyInjection\Argument\ServiceLocatorArgument;
use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
use Symfony\Component\DependencyInjection\Loader\UndefinedExtensionHandler;
use Symfony\Component\ExpressionLanguage\Expression;

/**
 * @author Nicolas Grekas <p@tchwork.com>
 */
class ContainerConfigurator extends AbstractConfigurator {
    public const FACTORY = 'container';
    private array $instanceof;
    private int $anonymousCount = 0;
    public function __construct(ContainerBuilder $container, PhpFileLoader $loader, array &$instanceof, string $path, string $file, ?string $env = null) {
        $this->instanceof =& $instanceof;
    }
    public final function extension(string $namespace, array $config, bool $prepend = false) : void {
        if ($prepend) {
            $this->container
                ->prependExtensionConfig($namespace, static::processValue($config));
            return;
        }
        if (!$this->container
            ->hasExtension($namespace)) {
            $extensions = array_filter(array_map(fn(ExtensionInterface $ext) => $ext->getAlias(), $this->container
                ->getExtensions()));
            throw new InvalidArgumentException(UndefinedExtensionHandler::getErrorMessage($namespace, $this->file, $namespace, $extensions));
        }
        $this->container
            ->loadFromExtension($namespace, static::processValue($config));
    }
    public final function import(string $resource, ?string $type = null, bool|string $ignoreErrors = false) : void {
        $this->loader
            ->setCurrentDir(\dirname($this->path));
        $this->loader
            ->import($resource, $type, $ignoreErrors, $this->file);
    }
    public final function parameters() : ParametersConfigurator {
        return new ParametersConfigurator($this->container);
    }
    public final function services() : ServicesConfigurator {
        return new ServicesConfigurator($this->container, $this->loader, $this->instanceof, $this->path, $this->anonymousCount);
    }
    
    /**
     * Get the current environment to be able to write conditional configuration.
     */
    public final function env() : ?string {
        return $this->env;
    }
    public final function withPath(string $path) : static {
        $clone = clone $this;
        $clone->path = $clone->file = $path;
        $clone->loader
            ->setCurrentDir(\dirname($path));
        return $clone;
    }

}

/**
 * Creates a parameter.
 */
function param(string $name) : ParamConfigurator {
    return new ParamConfigurator($name);
}

/**
 * Creates a reference to a service.
 */
function service(string $serviceId) : ReferenceConfigurator {
    return new ReferenceConfigurator($serviceId);
}

/**
 * Creates an inline service.
 */
function inline_service(?string $class = null) : InlineServiceConfigurator {
    return new InlineServiceConfigurator(new Definition($class));
}

/**
 * Creates a service locator.
 *
 * @param array<ReferenceConfigurator|InlineServiceConfigurator> $values
 */
function service_locator(array $values) : ServiceLocatorArgument {
    $values = AbstractConfigurator::processValue($values, true);
    return new ServiceLocatorArgument($values);
}

/**
 * Creates a lazy iterator.
 *
 * @param ReferenceConfigurator[] $values
 */
function iterator(array $values) : IteratorArgument {
    return new IteratorArgument(AbstractConfigurator::processValue($values, true));
}

/**
 * Creates a lazy iterator by tag name.
 */
function tagged_iterator(string $tag, ?string $indexAttribute = null, ?string $defaultIndexMethod = null, ?string $defaultPriorityMethod = null, string|array $exclude = [], bool $excludeSelf = true) : TaggedIteratorArgument {
    return new TaggedIteratorArgument($tag, $indexAttribute, $defaultIndexMethod, false, $defaultPriorityMethod, (array) $exclude, $excludeSelf);
}

/**
 * Creates a service locator by tag name.
 */
function tagged_locator(string $tag, ?string $indexAttribute = null, ?string $defaultIndexMethod = null, ?string $defaultPriorityMethod = null, string|array $exclude = [], bool $excludeSelf = true) : ServiceLocatorArgument {
    return new ServiceLocatorArgument(new TaggedIteratorArgument($tag, $indexAttribute, $defaultIndexMethod, true, $defaultPriorityMethod, (array) $exclude, $excludeSelf));
}

/**
 * Creates an expression.
 */
function expr(string $expression) : Expression {
    return new Expression($expression);
}

/**
 * Creates an abstract argument.
 */
function abstract_arg(string $description) : AbstractArgument {
    return new AbstractArgument($description);
}

/**
 * Creates an environment variable reference.
 */
function env(string $name) : EnvConfigurator {
    return new EnvConfigurator($name);
}

/**
 * Creates a closure service reference.
 */
function service_closure(string $serviceId) : ClosureReferenceConfigurator {
    return new ClosureReferenceConfigurator($serviceId);
}

/**
 * Creates a closure.
 */
function closure(string|array|ReferenceConfigurator|Expression $callable) : InlineServiceConfigurator {
    return (new InlineServiceConfigurator(new Definition('Closure')))->factory([
        'Closure',
        'fromCallable',
    ])
        ->args([
        $callable,
    ]);
}

Functions

Title Deprecated Summary
abstract_arg Creates an abstract argument.
closure Creates a closure.
env Creates an environment variable reference.
expr Creates an expression.
inline_service Creates an inline service.
iterator Creates a lazy iterator.
param Creates a parameter.
service Creates a reference to a service.
service_closure Creates a closure service reference.
service_locator Creates a service locator.
tagged_iterator Creates a lazy iterator by tag name.
tagged_locator Creates a service locator by tag name.

Classes

Title Deprecated Summary
ContainerConfigurator @author Nicolas Grekas <p@tchwork.com>
RSS feed
Powered by Drupal