class SecurityExtension extends Extension

SecurityExtension.

Methods

string
getXsdValidationBasePath()

Returns the base path for the XSD files.

string
getNamespace()

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

string
getAlias()

Returns the recommended alias to use in XML.

from Extension
getConfiguration(array $config, ContainerBuilder $container)

Returns extension configuration.

array
getClassesToCompile()

Gets the classes to cache.

from Extension
array
getAnnotatedClassesToCompile()

Gets the annotated classes to cache.

from Extension
addClassesToCompile(array $classes)

Adds classes to the class cache.

from Extension
addAnnotatedClassesToCompile(array $annotatedClasses)

Adds annotated classes to the class cache.

from Extension
__construct()

No description

load(array $configs, ContainerBuilder $container)

Loads a specific configuration.

Details

at line line 649
string getXsdValidationBasePath()

Returns the base path for the XSD files.

Return Value

string The XSD base path

at line line 654
string getNamespace()

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

Return Value

string The XML namespace

in Extension at line line 65
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

at line line 659
ConfigurationInterface|null getConfiguration(array $config, ContainerBuilder $container)

Returns extension configuration.

Parameters

array $config An array of configuration values
ContainerBuilder $container A ContainerBuilder instance

Return Value

ConfigurationInterface|null The configuration or null

in Extension at line line 31
array getClassesToCompile()

Gets the classes to cache.

Return Value

array An array of classes

in Extension at line line 41
array getAnnotatedClassesToCompile()

Gets the annotated classes to cache.

Return Value

array An array of classes

in Extension at line line 51
addClassesToCompile(array $classes)

Adds classes to the class cache.

Parameters

array $classes An array of class patterns

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

Adds annotated classes to the class cache.

Parameters

array $annotatedClasses An array of class patterns

at line line 42
__construct()

at line line 49
load(array $configs, ContainerBuilder $container)

Loads a specific configuration.

Parameters

array $configs An array of configuration values
ContainerBuilder $container A ContainerBuilder instance

Exceptions

InvalidArgumentException When provided tag is not defined in this extension

at line line 634
addSecurityListenerFactory(SecurityFactoryInterface $factory)

Parameters

SecurityFactoryInterface $factory

at line line 639
addUserProviderFactory(UserProviderFactoryInterface $factory)

Parameters

UserProviderFactoryInterface $factory