SecurityExtension
extends Extension
in package
implements
PrependExtensionInterface
SecurityExtension.
Tags
Interfaces, Classes, Traits and Enums
Table of Contents
- $annotatedClasses : mixed
- $contextListeners : mixed
- $expressions : mixed
- $factories : mixed
- $listenerPositions : mixed
- $processedConfigs : mixed
- $requestMatchers : mixed
- $statelessFirewallKeys : mixed
- $userProviderFactories : mixed
- __construct() : mixed
- addAnnotatedClassesToCompile() : mixed
- Adds annotated classes to the class cache.
- addSecurityListenerFactory() : mixed
- addUserProviderFactory() : mixed
- getAlias() : string
- Returns the recommended alias to use in XML.
- getAnnotatedClassesToCompile() : array<string|int, mixed>
- Gets the annotated classes to cache.
- getConfiguration() : mixed
- getNamespace() : mixed
- getXsdValidationBasePath() : mixed
- {@inheritdoc}
- load() : mixed
- prepend() : mixed
- Allow an extension to prepend the extension configurations.
- isConfigEnabled() : bool
- processConfiguration() : array<string|int, mixed>
- createAuthenticationListeners() : mixed
- createAuthorization() : mixed
- createContextListener() : mixed
- createEncoder() : mixed
- createEncoders() : mixed
- createExceptionListener() : string
- createExpression() : Reference
- createFirewall() : mixed
- createFirewalls() : mixed
- createRequestMatcher() : Reference
- createRoleHierarchy() : mixed
- createSwitchUserListener() : string
- createUserDaoProvider() : string
- createUserProviders() : array<string|int, mixed>
- getUserProviderId() : string
- isValidIp() : bool
Properties
$annotatedClasses
private
mixed
$annotatedClasses
= []
$contextListeners
private
mixed
$contextListeners
= []
$expressions
private
mixed
$expressions
= []
$factories
private
mixed
$factories
= []
$listenerPositions
private
mixed
$listenerPositions
= ['pre_auth', 'form', 'http', 'remember_me', 'anonymous']
$processedConfigs
private
mixed
$processedConfigs
= []
$requestMatchers
private
mixed
$requestMatchers
= []
$statelessFirewallKeys
private
mixed
$statelessFirewallKeys
= []
$userProviderFactories
private
mixed
$userProviderFactories
= []
Methods
__construct()
public
__construct() : mixed
Return values
mixed —addAnnotatedClassesToCompile()
Adds annotated classes to the class cache.
public
addAnnotatedClassesToCompile(array<string|int, mixed> $annotatedClasses) : mixed
Parameters
- $annotatedClasses : array<string|int, mixed>
-
An array of class patterns
Return values
mixed —addSecurityListenerFactory()
public
addSecurityListenerFactory(SecurityFactoryInterface $factory) : mixed
Parameters
- $factory : SecurityFactoryInterface
Return values
mixed —addUserProviderFactory()
public
addUserProviderFactory(UserProviderFactoryInterface $factory) : mixed
Parameters
- $factory : UserProviderFactoryInterface
Return values
mixed —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
string —getAnnotatedClassesToCompile()
Gets the annotated classes to cache.
public
getAnnotatedClassesToCompile() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array of classes
getConfiguration()
public
getConfiguration(array<string|int, mixed> $config, ContainerBuilder $container) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
Return values
mixed —getNamespace()
public
getNamespace() : mixed
Return values
mixed —getXsdValidationBasePath()
{@inheritdoc}
public
getXsdValidationBasePath() : mixed
Return values
mixed —load()
public
load(array<string|int, mixed> $configs, ContainerBuilder $container) : mixed
Parameters
- $configs : array<string|int, mixed>
- $container : ContainerBuilder
Return values
mixed —prepend()
Allow an extension to prepend the extension configurations.
public
prepend(ContainerBuilder $container) : mixed
Parameters
- $container : ContainerBuilder
Return values
mixed —isConfigEnabled()
protected
isConfigEnabled(ContainerBuilder $container, array<string|int, mixed> $config) : bool
Parameters
- $container : ContainerBuilder
- $config : array<string|int, mixed>
Tags
Return values
bool —processConfiguration()
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> —createAuthenticationListeners()
private
createAuthenticationListeners(ContainerBuilder $container, string $id, array<string|int, mixed> $firewall, array<string|int, mixed> &$authenticationProviders, string|null $defaultProvider, array<string|int, mixed> $providerIds, string|null $defaultEntryPoint[, string $contextListenerId = null ]) : mixed
Parameters
- $container : ContainerBuilder
- $id : string
- $firewall : array<string|int, mixed>
- $authenticationProviders : array<string|int, mixed>
- $defaultProvider : string|null
- $providerIds : array<string|int, mixed>
- $defaultEntryPoint : string|null
- $contextListenerId : string = null
Return values
mixed —createAuthorization()
private
createAuthorization(array<string|int, mixed> $config, ContainerBuilder $container) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
Return values
mixed —createContextListener()
private
createContextListener(ContainerBuilder $container, string $contextKey) : mixed
Parameters
- $container : ContainerBuilder
- $contextKey : string
Return values
mixed —createEncoder()
private
createEncoder(array<string|int, mixed> $config) : mixed
Parameters
- $config : array<string|int, mixed>
Return values
mixed —createEncoders()
private
createEncoders(array<string|int, mixed> $encoders, ContainerBuilder $container) : mixed
Parameters
- $encoders : array<string|int, mixed>
- $container : ContainerBuilder
Return values
mixed —createExceptionListener()
private
createExceptionListener(ContainerBuilder $container, array<string|int, mixed> $config, string $id, string|null $defaultEntryPoint, bool $stateless) : string
Parameters
- $container : ContainerBuilder
- $config : array<string|int, mixed>
- $id : string
- $defaultEntryPoint : string|null
- $stateless : bool
Return values
string —createExpression()
private
createExpression(ContainerBuilder $container, string $expression) : Reference
Parameters
- $container : ContainerBuilder
- $expression : string
Return values
Reference —createFirewall()
private
createFirewall(ContainerBuilder $container, string $id, array<string|int, mixed> $firewall, array<string|int, mixed> &$authenticationProviders, array<string|int, mixed> $providerIds, string $configId) : mixed
Parameters
- $container : ContainerBuilder
- $id : string
- $firewall : array<string|int, mixed>
- $authenticationProviders : array<string|int, mixed>
- $providerIds : array<string|int, mixed>
- $configId : string
Return values
mixed —createFirewalls()
private
createFirewalls(array<string|int, mixed> $config, ContainerBuilder $container) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
Return values
mixed —createRequestMatcher()
private
createRequestMatcher(ContainerBuilder $container[, string $path = null ][, string $host = null ][, int $port = null ][, array<string|int, mixed> $methods = [] ][, array<string|int, mixed> $ips = null ][, array<string|int, mixed> $attributes = [] ]) : Reference
Parameters
- $container : ContainerBuilder
- $path : string = null
- $host : string = null
- $port : int = null
- $methods : array<string|int, mixed> = []
- $ips : array<string|int, mixed> = null
- $attributes : array<string|int, mixed> = []
Return values
Reference —createRoleHierarchy()
private
createRoleHierarchy(array<string|int, mixed> $config, ContainerBuilder $container) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
Return values
mixed —createSwitchUserListener()
private
createSwitchUserListener(ContainerBuilder $container, string $id, array<string|int, mixed> $config, string|null $defaultProvider, bool $stateless) : string
Parameters
- $container : ContainerBuilder
- $id : string
- $config : array<string|int, mixed>
- $defaultProvider : string|null
- $stateless : bool
Return values
string —createUserDaoProvider()
private
createUserDaoProvider(string $name, array<string|int, mixed> $provider, ContainerBuilder $container) : string
Parameters
- $name : string
- $provider : array<string|int, mixed>
- $container : ContainerBuilder
Return values
string —createUserProviders()
private
createUserProviders(array<string|int, mixed> $config, ContainerBuilder $container) : array<string|int, mixed>
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
Return values
array<string|int, mixed> —getUserProviderId()
private
getUserProviderId(string $name) : string
Parameters
- $name : string
Return values
string —isValidIp()
private
isValidIp(string $cidr) : bool
Parameters
- $cidr : string