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.

Methods

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
getConfiguration(array $config, ContainerBuilder $container)

Returns extension configuration.

from Extension
getProcessedConfigs()

No description

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.

Details

in Extension at line line 33
string getXsdValidationBasePath()

Returns the base path for the XSD files.

Return Value

string The XSD base path

in Extension at line line 41
string getNamespace()

Returns the namespace to be used for this extension (XML namespace).

Return Value

string The XML namespace

in Extension at line line 66
string 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 Value

string The alias

Exceptions

BadMethodCallException When the extension name does not follow conventions

in Extension at line line 80
ConfigurationInterface|null getConfiguration(array $config, ContainerBuilder $container)

Returns extension configuration.

Parameters

array $config
ContainerBuilder $container

Return Value

ConfigurationInterface|null The configuration or null

in Extension at line line 102
final getProcessedConfigs()

in Extension at line line 30
array getAnnotatedClassesToCompile()

Gets the annotated classes to cache.

Return Value

array An array of classes

in Extension at line line 40
addAnnotatedClassesToCompile(array $annotatedClasses)

Adds annotated classes to the class cache.

Parameters

array $annotatedClasses An array of class patterns

at line line 33
final load(array $configs, ContainerBuilder $container)

Loads a specific configuration.

Parameters

array $configs
ContainerBuilder $container

Exceptions

InvalidArgumentException When provided tag is not defined in this extension