class Extension
Same name in this branch
- 11.1.x vendor/phar-io/manifest/src/values/Extension.php \PharIo\Manifest\Extension
- 11.1.x vendor/mglaman/phpstan-drupal/src/Drupal/Extension.php \mglaman\PHPStanDrupal\Drupal\Extension
- 11.1.x vendor/symfony/http-kernel/DependencyInjection/Extension.php \Symfony\Component\HttpKernel\DependencyInjection\Extension
- 11.1.x core/lib/Drupal/Core/Extension/Extension.php \Drupal\Core\Extension\Extension
- 11.1.x core/modules/system/src/Plugin/migrate/source/Extension.php \Drupal\system\Plugin\migrate\source\Extension
Provides useful features shared by many extensions.
@author Fabien Potencier <fabien@symfony.com>
Hierarchy
- class \Symfony\Component\DependencyInjection\Extension\Extension implements \Symfony\Component\DependencyInjection\Extension\ExtensionInterface, \Symfony\Component\DependencyInjection\Extension\ConfigurationExtensionInterface
Expanded class hierarchy of Extension
3 files declare their use of Extension
- BundleExtension.php in vendor/
symfony/ http-kernel/ Bundle/ BundleExtension.php - Extension.php in vendor/
symfony/ http-kernel/ DependencyInjection/ Extension.php - MergeExtensionConfigurationPass.php in vendor/
symfony/ dependency-injection/ Compiler/ MergeExtensionConfigurationPass.php
14 string references to 'Extension'
- Application::writePharExtensionInformation in vendor/
phpunit/ phpunit/ src/ TextUI/ Application.php - @psalm-param ?list<string> $pharExtensions
- Bundle::getContainerExtensionClass in vendor/
symfony/ http-kernel/ Bundle/ Bundle.php - Returns the bundle's container extension class.
- ContainsElement::getExtensionElement in vendor/
phar-io/ manifest/ src/ xml/ ContainsElement.php - ConvertImageEffect::submitConfigurationForm in core/
modules/ image/ src/ Plugin/ ImageEffect/ ConvertImageEffect.php - d6_language_content_menu_settings.yml in core/
modules/ language/ migrations/ d6_language_content_menu_settings.yml - core/modules/language/migrations/d6_language_content_menu_settings.yml
File
-
vendor/
symfony/ dependency-injection/ Extension/ Extension.php, line 27
Namespace
Symfony\Component\DependencyInjection\ExtensionView source
abstract class Extension implements ExtensionInterface, ConfigurationExtensionInterface {
private array $processedConfigs = [];
/**
* @return string|false
*/
public function getXsdValidationBasePath() {
return false;
}
/**
* @return string
*/
public function getNamespace() {
return 'http://example.org/schema/dic/' . $this->getAlias();
}
/**
* Returns the recommended alias to use in XML.
*
* This alias is also the mandatory prefix to use when using YAML.
*
* This convention is to remove the "Extension" postfix from the class
* name and then lowercase and underscore the result. So:
*
* AcmeHelloExtension
*
* becomes
*
* acme_hello
*
* This can be overridden in a sub-class to specify the alias manually.
*
* @throws BadMethodCallException When the extension name does not follow conventions
*/
public function getAlias() : string {
$className = static::class;
if (!str_ends_with($className, 'Extension')) {
throw new BadMethodCallException('This extension does not follow the naming convention; you must overwrite the getAlias() method.');
}
$classBaseName = substr(strrchr($className, '\\'), 1, -9);
return Container::underscore($classBaseName);
}
/**
* @return ConfigurationInterface|null
*/
public function getConfiguration(array $config, ContainerBuilder $container) {
$class = static::class;
if (str_contains($class, "\x00")) {
return null;
// ignore anonymous classes
}
$class = substr_replace($class, '\\Configuration', strrpos($class, '\\'));
$class = $container->getReflectionClass($class);
if (!$class) {
return null;
}
if (!$class->implementsInterface(ConfigurationInterface::class)) {
throw new LogicException(\sprintf('The extension configuration class "%s" must implement "%s".', $class->getName(), ConfigurationInterface::class));
}
if (!($constructor = $class->getConstructor()) || !$constructor->getNumberOfRequiredParameters()) {
return $class->newInstance();
}
return null;
}
protected final function processConfiguration(ConfigurationInterface $configuration, array $configs) : array {
$processor = new Processor();
return $this->processedConfigs[] = $processor->processConfiguration($configuration, $configs);
}
/**
* @internal
*/
public final function getProcessedConfigs() : array {
try {
return $this->processedConfigs;
} finally {
$this->processedConfigs = [];
}
}
/**
* @throws InvalidArgumentException When the config is not enableable
*/
protected function isConfigEnabled(ContainerBuilder $container, array $config) : bool {
if (!\array_key_exists('enabled', $config)) {
throw new InvalidArgumentException("The config array has no 'enabled' key.");
}
return (bool) $container->getParameterBag()
->resolveValue($config['enabled']);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
Extension::$processedConfigs | private | property | |||
Extension::getAlias | public | function | Returns the recommended alias to use in XML. | Overrides ExtensionInterface::getAlias | 1 |
Extension::getConfiguration | public | function | Overrides ConfigurationExtensionInterface::getConfiguration | 2 | |
Extension::getNamespace | public | function | Overrides ExtensionInterface::getNamespace | ||
Extension::getProcessedConfigs | final public | function | @internal | ||
Extension::getXsdValidationBasePath | public | function | Overrides ExtensionInterface::getXsdValidationBasePath | ||
Extension::isConfigEnabled | protected | function | |||
Extension::processConfiguration | final protected | function | |||
ExtensionInterface::load | public | function | Loads a specific configuration. | 3 |