SecurityExtension
extends Extension
in package
implements
PrependExtensionInterface
SecurityExtension.
Tags
Table of Contents
Interfaces
Properties
- $annotatedClasses : array<string|int, mixed>
- $contextListeners : array<string|int, mixed>
- $expressions : array<string|int, mixed>
- $factories : array<int, AuthenticatorFactoryInterface}>
- $processedConfigs : array<string|int, mixed>
- $requestMatchers : array<string|int, mixed>
- $sortedFactories : array<string|int, AuthenticatorFactoryInterface>
- $userProviderFactories : array<string|int, mixed>
Methods
- addAnnotatedClassesToCompile() : mixed
- Adds annotated classes to the class cache.
- addAuthenticatorFactory() : 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() : ConfigurationInterface|null
- getNamespace() : string
- getXsdValidationBasePath() : string|false
- {@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
- createExceptionListener() : string
- createExpression() : Reference
- createFirewall() : mixed
- createFirewalls() : mixed
- createHasher() : mixed
- createHashers() : mixed
- createRequestMatcher() : Reference
- createRoleHierarchy() : mixed
- createStrategyDefinition() : Definition
- createSwitchUserListener() : string
- createUserDaoProvider() : string
- createUserProviders() : array<string|int, mixed>
- getSortedFactories() : array<int, AuthenticatorFactoryInterface>
- getUserProvider() : string
- getUserProviderId() : string
- isValidIp() : bool
- isValidIps() : bool
Properties
$annotatedClasses
private
array<string|int, mixed>
$annotatedClasses
= []
$contextListeners
private
array<string|int, mixed>
$contextListeners
= []
$expressions
private
array<string|int, mixed>
$expressions
= []
$factories
private
array<int, AuthenticatorFactoryInterface}>
$factories
= []
$processedConfigs
private
array<string|int, mixed>
$processedConfigs
= []
$requestMatchers
private
array<string|int, mixed>
$requestMatchers
= []
$sortedFactories
private
array<string|int, AuthenticatorFactoryInterface>
$sortedFactories
= []
$userProviderFactories
private
array<string|int, mixed>
$userProviderFactories
= []
Methods
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
addAuthenticatorFactory()
public
addAuthenticatorFactory(AuthenticatorFactoryInterface $factory) : mixed
Parameters
- $factory : AuthenticatorFactoryInterface
addUserProviderFactory()
public
addUserProviderFactory(UserProviderFactoryInterface $factory) : mixed
Parameters
- $factory : UserProviderFactoryInterface
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
stringgetAnnotatedClassesToCompile()
Gets the annotated classes to cache.
public
getAnnotatedClassesToCompile() : array<string|int, mixed>
Return values
array<string|int, mixed>getConfiguration()
public
getConfiguration(array<string|int, mixed> $config, ContainerBuilder $container) : ConfigurationInterface|null
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
Return values
ConfigurationInterface|nullgetNamespace()
public
getNamespace() : string
Return values
stringgetXsdValidationBasePath()
{@inheritdoc}
public
getXsdValidationBasePath() : string|false
Return values
string|falseload()
public
load(array<string|int, mixed> $configs, ContainerBuilder $container) : mixed
Parameters
- $configs : array<string|int, mixed>
- $container : ContainerBuilder
prepend()
Allow an extension to prepend the extension configurations.
public
prepend(ContainerBuilder $container) : mixed
Parameters
- $container : 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>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
createAuthorization()
private
createAuthorization(array<string|int, mixed> $config, ContainerBuilder $container) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
createContextListener()
private
createContextListener(ContainerBuilder $container, string $contextKey, string|null $firewallEventDispatcherId) : mixed
Parameters
- $container : ContainerBuilder
- $contextKey : string
- $firewallEventDispatcherId : string|null
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
stringcreateExpression()
private
createExpression(ContainerBuilder $container, string $expression) : Reference
Parameters
- $container : ContainerBuilder
- $expression : string
Return values
ReferencecreateFirewall()
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
createFirewalls()
private
createFirewalls(array<string|int, mixed> $config, ContainerBuilder $container) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
createHasher()
private
createHasher(array<string|int, mixed> $config) : mixed
Parameters
- $config : array<string|int, mixed>
createHashers()
private
createHashers(array<string|int, mixed> $hashers, ContainerBuilder $container) : mixed
Parameters
- $hashers : array<string|int, mixed>
- $container : ContainerBuilder
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
ReferencecreateRoleHierarchy()
private
createRoleHierarchy(array<string|int, mixed> $config, ContainerBuilder $container) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
createStrategyDefinition()
private
createStrategyDefinition(string $strategy, bool $allowIfAllAbstainDecisions, bool $allowIfEqualGrantedDeniedDecisions) : Definition
Parameters
- $strategy : string
- $allowIfAllAbstainDecisions : bool
- $allowIfEqualGrantedDeniedDecisions : bool
Tags
Return values
DefinitioncreateSwitchUserListener()
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
stringcreateUserDaoProvider()
private
createUserDaoProvider(string $name, array<string|int, mixed> $provider, ContainerBuilder $container) : string
Parameters
- $name : string
- $provider : array<string|int, mixed>
- $container : ContainerBuilder
Return values
stringcreateUserProviders()
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>getSortedFactories()
private
getSortedFactories() : array<int, AuthenticatorFactoryInterface>
Return values
array<int, AuthenticatorFactoryInterface>getUserProvider()
private
getUserProvider(ContainerBuilder $container, string $id, array<string|int, mixed> $firewall, string $factoryKey, string|null $defaultProvider, array<string|int, mixed> $providerIds, string|null $contextListenerId) : string
Parameters
- $container : ContainerBuilder
- $id : string
- $firewall : array<string|int, mixed>
- $factoryKey : string
- $defaultProvider : string|null
- $providerIds : array<string|int, mixed>
- $contextListenerId : string|null
Return values
stringgetUserProviderId()
private
getUserProviderId(string $name) : string
Parameters
- $name : string
Return values
stringisValidIp()
private
isValidIp(string $cidr) : bool
Parameters
- $cidr : string
Return values
boolisValidIps()
private
isValidIps(string|array<string|int, mixed> $ips) : bool
Parameters
- $ips : string|array<string|int, mixed>