abstract class Extension extends Extension

Allow adding classes to the class cache.

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
processConfiguration(ConfigurationInterface $configuration, array $configs)

No description

from Extension
getProcessedConfigs()

No description

from Extension
bool
isConfigEnabled(ContainerBuilder $container, array $config)

No description

from Extension
array
getClassesToCompile() deprecated

Gets the classes to cache.

array
getAnnotatedClassesToCompile()

Gets the annotated classes to cache.

addClassesToCompile(array $classes) deprecated

Adds classes to the class cache.

addAnnotatedClassesToCompile(array $annotatedClasses)

Adds annotated classes to the class cache.

Details

in Extension at line 33
string getXsdValidationBasePath()

Returns the base path for the XSD files.

Return Value

string The XSD base path

in Extension at 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 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 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 92
final protected processConfiguration(ConfigurationInterface $configuration, array $configs)

Parameters

ConfigurationInterface $configuration
array $configs

in Extension at line 102
final getProcessedConfigs()

in Extension at line 116
protected bool isConfigEnabled(ContainerBuilder $container, array $config)

Parameters

ContainerBuilder $container
array $config

Return Value

bool Whether the configuration is enabled

Exceptions

InvalidArgumentException When the config is not enableable

at line 33
array getClassesToCompile() deprecated

deprecated since version 3.3, to be removed in 4.0.

Gets the classes to cache.

Return Value

array An array of classes

at line 47
array getAnnotatedClassesToCompile()

Gets the annotated classes to cache.

Return Value

array An array of classes

at line 59
addClassesToCompile(array $classes) deprecated

deprecated since version 3.3, to be removed in 4.0.

Adds classes to the class cache.

Parameters

array $classes An array of class patterns

at line 73
addAnnotatedClassesToCompile(array $annotatedClasses)

Adds annotated classes to the class cache.

Parameters

array $annotatedClasses An array of class patterns