abstract class Extension in Zircon Profile 8
Same name in this branch
- 8 vendor/symfony/http-kernel/DependencyInjection/Extension.php \Symfony\Component\HttpKernel\DependencyInjection\Extension
- 8 vendor/symfony/dependency-injection/Extension/Extension.php \Symfony\Component\DependencyInjection\Extension\Extension
- 8 core/lib/Drupal/Core/Extension/Extension.php \Drupal\Core\Extension\Extension
Same name and namespace in other branches
- 8.0 vendor/symfony/dependency-injection/Extension/Extension.php \Symfony\Component\DependencyInjection\Extension\Extension
Provides useful features shared by many extensions.
@author Fabien Potencier <fabien@symfony.com>
Hierarchy
- class \Symfony\Component\DependencyInjection\Extension\Extension implements ConfigurationExtensionInterface, ExtensionInterface
Expanded class hierarchy of Extension
1 file declares its use of Extension
- Extension.php in vendor/
symfony/ http-kernel/ DependencyInjection/ Extension.php
5 string references to 'Extension'
- Bundle::getContainerExtensionClass in vendor/
symfony/ http-kernel/ Bundle/ Bundle.php - Returns the bundle's container extension class.
- ConvertImageEffect::buildConfigurationForm in core/
modules/ image/ src/ Plugin/ ImageEffect/ ConvertImageEffect.php - Form constructor.
- Extension::getAlias in vendor/
symfony/ dependency-injection/ Extension/ Extension.php - Returns the recommended alias to use in XML.
- FileViewsData::getViewsData in core/
modules/ file/ src/ FileViewsData.php - Returns views data for the entity type.
- image.schema.yml in core/
modules/ image/ config/ schema/ image.schema.yml - core/modules/image/config/schema/image.schema.yml
File
- vendor/
symfony/ dependency-injection/ Extension/ Extension.php, line 27
Namespace
Symfony\Component\DependencyInjection\ExtensionView source
abstract class Extension implements ExtensionInterface, ConfigurationExtensionInterface {
/**
* Returns the base path for the XSD files.
*
* @return string The XSD base path
*/
public function getXsdValidationBasePath() {
return false;
}
/**
* Returns the namespace to be used for this extension (XML namespace).
*
* @return string The XML namespace
*/
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.
*
* @return string The alias
*
* @throws BadMethodCallException When the extension name does not follow conventions
*/
public function getAlias() {
$className = get_class($this);
if (substr($className, -9) != '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);
}
/**
* {@inheritdoc}
*/
public function getConfiguration(array $config, ContainerBuilder $container) {
$reflected = new \ReflectionClass($this);
$namespace = $reflected
->getNamespaceName();
$class = $namespace . '\\Configuration';
if (class_exists($class)) {
$r = new \ReflectionClass($class);
$container
->addResource(new FileResource($r
->getFileName()));
if (!method_exists($class, '__construct')) {
$configuration = new $class();
return $configuration;
}
}
}
protected final function processConfiguration(ConfigurationInterface $configuration, array $configs) {
$processor = new Processor();
return $processor
->processConfiguration($configuration, $configs);
}
/**
* @param ContainerBuilder $container
* @param array $config
*
* @return bool Whether the configuration is enabled
*
* @throws InvalidArgumentException When the config is not enableable
*/
protected function isConfigEnabled(ContainerBuilder $container, array $config) {
if (!array_key_exists('enabled', $config)) {
throw new InvalidArgumentException("The config array has no 'enabled' key.");
}
return (bool) $container
->getParameterBag()
->resolveValue($config['enabled']);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Extension:: |
public | function |
Returns the recommended alias to use in XML. Overrides ExtensionInterface:: |
|
Extension:: |
public | function |
Returns extension configuration. Overrides ConfigurationExtensionInterface:: |
|
Extension:: |
public | function |
Returns the namespace to be used for this extension (XML namespace). Overrides ExtensionInterface:: |
|
Extension:: |
public | function |
Returns the base path for the XSD files. Overrides ExtensionInterface:: |
|
Extension:: |
protected | function | ||
Extension:: |
final protected | function | ||
ExtensionInterface:: |
public | function | Loads a specific configuration. | 4 |