class ContainerBuilder
Same name in other branches
- 8.9.x core/lib/Drupal/Core/DependencyInjection/ContainerBuilder.php \Drupal\Core\DependencyInjection\ContainerBuilder
- 10 core/lib/Drupal/Core/DependencyInjection/ContainerBuilder.php \Drupal\Core\DependencyInjection\ContainerBuilder
- 11.x 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
- class \Drupal\Core\DependencyInjection\ContainerBuilder extends \Symfony\Component\DependencyInjection\ContainerBuilder implements \Drupal\Component\DependencyInjection\ContainerInterface uses \Drupal\Component\DependencyInjection\ServiceIdHashTrait
Expanded class hierarchy of ContainerBuilder
Related topics
160 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 - Contains \Drupal\Tests\Core\Access\AccessResultTest.
- AuthenticationProviderPassTest.php in core/
tests/ Drupal/ Tests/ Core/ DependencyInjection/ Compiler/ AuthenticationProviderPassTest.php - BaseFieldDefinitionTest.php in core/
tests/ Drupal/ Tests/ Core/ Entity/ BaseFieldDefinitionTest.php - BaseFieldDefinitionTestBase.php in core/
tests/ Drupal/ Tests/ Core/ Field/ BaseFieldDefinitionTestBase.php
File
-
core/
lib/ Drupal/ Core/ DependencyInjection/ ContainerBuilder.php, line 20
Namespace
Drupal\Core\DependencyInjectionView 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.
*
* @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}
*/
public function setDefinition($id, Definition $definition) : Definition {
$definition = parent::setDefinition($id, $definition);
// As of Symfony 3.4 all definitions are private by default.
// \Symfony\Component\DependencyInjection\Compiler\ResolvePrivatesPassOnly
// removes services marked as private from the container even if they are
// also marked as public. Drupal requires services that are public to
// remain in the container and not be removed.
if ($definition->isPublic() && $definition->isPrivate()) {
@trigger_error('Not marking service definitions as public is deprecated in drupal:9.2.0 and is required in drupal:10.0.0. Call $definition->setPublic(TRUE) before calling ::setDefinition(). See https://www.drupal.org/node/3194517', E_USER_DEPRECATED);
$definition->setPrivate(FALSE);
}
return $definition;
}
/**
* {@inheritdoc}
*/
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
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
ContainerBuilder::register | public | function | ||
ContainerBuilder::set | public | function | Overrides Symfony\Component\DependencyInjection\ContainerBuilder::set(). | |
ContainerBuilder::setAlias | public | function | ||
ContainerBuilder::setDefinition | public | function | ||
ContainerBuilder::setParameter | public | function | ||
ContainerBuilder::__construct | public | function | ||
ContainerBuilder::__sleep | public | function | ||
ContainerInterface::getServiceIds | public | function | Gets all defined service IDs. | 1 |
ServiceIdHashTrait::generateServiceIdHash | public | function | Implements \Drupal\Component\DependencyInjection\ContainerInterface::generateServiceIdHash() | |
ServiceIdHashTrait::getServiceIdMappings | public | function | Implements \Drupal\Component\DependencyInjection\ContainerInterface::getServiceIdMappings() |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.