SecurityExtension

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

Returns extension configuration.

array getClassesToCompile()

Gets the classes to cache.

from Extension
addClassesToCompile(array $classes)

Adds classes to the class cache.

from Extension
__construct()
load(array $configs, ContainerBuilder $container)

Loads a specific configuration.

addSecurityListenerFactory(SecurityFactoryInterface $factory)
addUserProviderFactory(UserProviderFactoryInterface $factory)

Details

string getXsdValidationBasePath()

Returns the base path for the XSD files.

Return Value

string The XSD base path

string getNamespace()

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

Return Value

string The XML namespace

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

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

array getClassesToCompile()

Gets the classes to cache.

Return Value

array An array of classes

addClassesToCompile(array $classes)

Adds classes to the class cache.

Parameters

array $classes An array of classes

__construct()

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

addSecurityListenerFactory(SecurityFactoryInterface $factory)

Parameters

SecurityFactoryInterface $factory

addUserProviderFactory(UserProviderFactoryInterface $factory)

Parameters

UserProviderFactoryInterface $factory
doc_Symfony
2016-10-28 06:31:41
Comments
Leave a Comment

Please login to continue.