AbstractExtension
extends Extension
in package
implements
ConfigurableExtensionInterface, PrependExtensionInterface
uses
ExtensionTrait
AbstractYes
An Extension that provides configuration hooks.
Tags
Table of Contents
Interfaces
Methods
- configure() : void
- Generates the configuration tree builder.
- getAlias() : string
- Returns the recommended alias to use in XML.
- getConfiguration() : ConfigurationInterface|null
- Returns extension configuration.
- getNamespace() : string
- Returns the namespace to be used for this extension (XML namespace).
- getXsdValidationBasePath() : string|false
- Returns the base path for the XSD files.
- load() : void
- Loads a specific configuration.
- loadExtension() : void
- Loads a specific configuration.
- prepend() : void
- Allow an extension to prepend the extension configurations.
- prependExtension() : void
- Allows an extension to prepend the extension configurations.
- isConfigEnabled() : bool
- processConfiguration() : array<string|int, mixed>
- createContainerLoader() : DelegatingLoader
- executeConfiguratorCallback() : void
Methods
configure()
Generates the configuration tree builder.
public
configure(DefinitionConfigurator $definition) : void
Parameters
- $definition : DefinitionConfigurator
getAlias()
Returns the recommended alias to use in XML.
public
getAlias() : string
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.
Tags
Return values
stringgetConfiguration()
Returns extension configuration.
public
getConfiguration(array<string|int, mixed> $config, ContainerBuilder $container) : ConfigurationInterface|null
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
Return values
ConfigurationInterface|nullgetNamespace()
Returns the namespace to be used for this extension (XML namespace).
public
getNamespace() : string
Return values
stringgetXsdValidationBasePath()
Returns the base path for the XSD files.
public
getXsdValidationBasePath() : string|false
Return values
string|falseload()
Loads a specific configuration.
public
final load(array<string|int, mixed> $configs, ContainerBuilder $container) : void
Parameters
- $configs : array<string|int, mixed>
- $container : ContainerBuilder
loadExtension()
Loads a specific configuration.
public
loadExtension(array<string|int, mixed> $config, ContainerConfigurator $container, ContainerBuilder $builder) : void
Parameters
- $config : array<string|int, mixed>
- $container : ContainerConfigurator
- $builder : ContainerBuilder
prepend()
Allow an extension to prepend the extension configurations.
public
final prepend(ContainerBuilder $container) : void
Parameters
- $container : ContainerBuilder
prependExtension()
Allows an extension to prepend the extension configurations.
public
prependExtension(ContainerConfigurator $container, ContainerBuilder $builder) : void
Parameters
- $container : ContainerConfigurator
- $builder : ContainerBuilder
isConfigEnabled()
protected
isConfigEnabled(ContainerBuilder $container, array<string|int, mixed> $config) : bool
Parameters
- $container : ContainerBuilder
- $config : array<string|int, mixed>
Tags
Return values
boolprocessConfiguration()
protected
final processConfiguration(ConfigurationInterface $configuration, array<string|int, mixed> $configs) : array<string|int, mixed>
Parameters
- $configuration : ConfigurationInterface
- $configs : array<string|int, mixed>
Return values
array<string|int, mixed>createContainerLoader()
private
createContainerLoader(ContainerBuilder $container, string $env) : DelegatingLoader
Parameters
- $container : ContainerBuilder
- $env : string
Return values
DelegatingLoaderexecuteConfiguratorCallback()
private
executeConfiguratorCallback(ContainerBuilder $container, Closure $callback, ConfigurableExtensionInterface $subject) : void
Parameters
- $container : ContainerBuilder
- $callback : Closure
- $subject : ConfigurableExtensionInterface