abstract class ConfigurableExtension extends Extension
This extension sub-class provides first-class integration with the Config/Definition Component.
You can use this as base class if
a) you use the Config/Definition component for configuration, b) your configuration class is named "Configuration", and c) the configuration class resides in the DependencyInjection sub-folder.
string | getXsdValidationBasePath() Returns the base path for the XSD files. | from Extension |
string | getNamespace() Returns the namespace to be used for this extension (XML namespace). | from Extension |
string | getAlias() Returns the recommended alias to use in XML. | from Extension |
ConfigurationInterface|null | getConfiguration(array $config, ContainerBuilder $container) Returns extension configuration. | from Extension |
processConfiguration(ConfigurationInterface $configuration, array $configs) | from Extension | |
getProcessedConfigs() | from Extension | |
bool | isConfigEnabled(ContainerBuilder $container, array $config) | from Extension |
array | getAnnotatedClassesToCompile() Gets the annotated classes to cache. | from Extension |
addAnnotatedClassesToCompile(array $annotatedClasses) Adds annotated classes to the class cache. | from Extension | |
load(array $configs, ContainerBuilder $container) Loads a specific configuration. | ||
loadInternal(array $mergedConfig, ContainerBuilder $container) Configures the passed container according to the merged configuration. |
Returns the base path for the XSD files.
string | The XSD base path |
Returns the namespace to be used for this extension (XML namespace).
string | The XML namespace |
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.
string | The alias |
BadMethodCallException | When the extension name does not follow conventions |
Returns extension configuration.
array | $config | |
ContainerBuilder | $container |
ConfigurationInterface|null | The configuration or null |
ConfigurationInterface | $configuration | |
array | $configs |
ContainerBuilder | $container | |
array | $config |
bool | Whether the configuration is enabled |
InvalidArgumentException | When the config is not enableable |
Gets the annotated classes to cache.
array | An array of classes |
Adds annotated classes to the class cache.
array | $annotatedClasses | An array of class patterns |
Loads a specific configuration.
array | $configs | |
ContainerBuilder | $container |
InvalidArgumentException | When provided tag is not defined in this extension |
Configures the passed container according to the merged configuration.
array | $mergedConfig | |
ContainerBuilder | $container |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/HttpKernel/DependencyInjection/ConfigurableExtension.html