Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/DependencyInjection/ContainerBuilder.php \Drupal\Core\DependencyInjection\ContainerBuilder
  2. 9 core/lib/Drupal/Core/DependencyInjection/ContainerBuilder.php \Drupal\Core\DependencyInjection\ContainerBuilder

Drupal's dependency injection container builder.

@todo Submit upstream patches to Symfony to not require these overrides.

Hierarchy

Expanded class hierarchy of ContainerBuilder

Related topics

144 files declare their use of ContainerBuilder
AcceptHeaderRoutingTestServiceProvider.php in core/modules/system/tests/modules/accept_header_routing_test/src/AcceptHeaderRoutingTestServiceProvider.php
AccessResultTest.php in core/tests/Drupal/Tests/Core/Access/AccessResultTest.php
AuthenticationProviderPassTest.php in core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/AuthenticationProviderPassTest.php
BaseFieldDefinitionTest.php in core/tests/Drupal/Tests/Core/Entity/BaseFieldDefinitionTest.php
BlockComponentRenderArrayTest.php in core/modules/layout_builder/tests/src/Unit/BlockComponentRenderArrayTest.php

... See full list

File

core/lib/Drupal/Core/DependencyInjection/ContainerBuilder.php, line 20

Namespace

Drupal\Core\DependencyInjection
View source
class ContainerBuilder extends SymfonyContainerBuilder implements ContainerInterface {
  use ServiceIdHashTrait;

  /**
   * {@inheritdoc}
   */
  public function __construct(ParameterBagInterface $parameterBag = NULL) {
    parent::__construct($parameterBag);
    $this
      ->setResourceTracking(FALSE);
  }

  /**
   * Overrides Symfony\Component\DependencyInjection\ContainerBuilder::set().
   *
   * Drupal's container builder can be used at runtime after compilation, so we
   * override Symfony's ContainerBuilder's restriction on setting services in a
   * frozen builder.
   *
   * phpcs:ignore Drupal.Commenting.FunctionComment.VoidReturn
   * @return void
   *
   * @todo Restrict this to synthetic services only. Ideally, the upstream
   *   ContainerBuilder class should be fixed to allow setting synthetic
   *   services in a frozen builder.
   */
  public function set($id, $service) {
    SymfonyContainer::set($id, $service);
  }

  /**
   * {@inheritdoc}
   */
  public function register($id, $class = NULL) : Definition {
    $definition = new Definition($class);

    // As of Symfony 5.2 all services are private by default, but in Drupal
    // services are still public by default.
    $definition
      ->setPublic(TRUE);
    return $this
      ->setDefinition($id, $definition);
  }

  /**
   * {@inheritdoc}
   */
  public function setAlias($alias, $id) : Alias {
    $alias = parent::setAlias($alias, $id);

    // As of Symfony 3.4 all aliases are private by default.
    $alias
      ->setPublic(TRUE);
    return $alias;
  }

  /**
   * {@inheritdoc}
   *
   * phpcs:ignore Drupal.Commenting.FunctionComment.VoidReturn
   * @return void
   */
  public function setParameter($name, $value) {
    if (strtolower($name) !== $name) {
      throw new \InvalidArgumentException("Parameter names must be lowercase: {$name}");
    }
    parent::setParameter($name, $value);
  }

  /**
   * {@inheritdoc}
   */
  public function __sleep() {
    assert(FALSE, 'The container was serialized.');
    return array_keys(get_object_vars($this));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContainerBuilder::register public function
ContainerBuilder::set public function Overrides Symfony\Component\DependencyInjection\ContainerBuilder::set().
ContainerBuilder::setAlias public function
ContainerBuilder::setParameter public function phpcs:ignore Drupal.Commenting.FunctionComment.VoidReturn
ContainerBuilder::__construct public function
ContainerBuilder::__sleep public function
ContainerInterface::getServiceIds public function Gets all defined service IDs.
ServiceIdHashTrait::generateServiceIdHash public function Implements \Drupal\Component\DependencyInjection\ContainerInterface::generateServiceIdHash()
ServiceIdHashTrait::getServiceIdMappings public function Implements \Drupal\Component\DependencyInjection\ContainerInterface::getServiceIdMappings()