W3cubDocs

/Symfony 4.1

AbstractFactory

abstract class AbstractFactory implements SecurityFactoryInterface

AbstractFactory is the base class for all classes inheriting from AbstractAuthenticationListener.

Properties

protected $options
protected $defaultSuccessHandlerOptions
protected $defaultFailureHandlerOptions

Methods

array create(ContainerBuilder $container, string $id, array $config, $userProviderId, $defaultEntryPointId)

Configures the container services required to use the authentication listener.

addConfiguration(NodeDefinition $node)
addOption($name, $default = null)
string createAuthProvider(ContainerBuilder $container, string $id, array $config, string $userProviderId)

Subclasses must return the id of a service which implements the AuthenticationProviderInterface.

string getListenerId()

Subclasses must return the id of the abstract listener template.

string createEntryPoint(ContainerBuilder $container, string $id, array $config, string $defaultEntryPointId)

Subclasses may create an entry point of their as they see fit. The default implementation does not change the default entry point.

bool isRememberMeAware($config)

Subclasses may disable remember-me features for the listener, by always returning false from this method.

createListener($container, $id, $config, $userProvider)
createAuthenticationSuccessHandler($container, $id, $config)
createAuthenticationFailureHandler($container, $id, $config)
getSuccessHandlerId($id)
getFailureHandlerId($id)

Details

array create(ContainerBuilder $container, string $id, array $config, $userProviderId, $defaultEntryPointId)

Configures the container services required to use the authentication listener.

Parameters

ContainerBuilder $container
string $id The unique id of the firewall
array $config The options array for the listener
$userProviderId
$defaultEntryPointId

Return Value

array containing three values: - the provider id - the listener id - the entry point id

addConfiguration(NodeDefinition $node)

Parameters

NodeDefinition $node

final addOption($name, $default = null)

Parameters

$name
$default

abstract protected string createAuthProvider(ContainerBuilder $container, string $id, array $config, string $userProviderId)

Subclasses must return the id of a service which implements the AuthenticationProviderInterface.

Parameters

ContainerBuilder $container
string $id The unique id of the firewall
array $config The options array for this listener
string $userProviderId The id of the user provider

Return Value

string never null, the id of the authentication provider

abstract protected string getListenerId()

Subclasses must return the id of the abstract listener template.

Listener definitions should inherit from the AbstractAuthenticationListener like this:

In the above case, this method would return "my.listener.id".

Return Value

string

protected string createEntryPoint(ContainerBuilder $container, string $id, array $config, string $defaultEntryPointId)

Subclasses may create an entry point of their as they see fit. The default implementation does not change the default entry point.

Parameters

ContainerBuilder $container
string $id
array $config
string $defaultEntryPointId

Return Value

string the entry point id

protected bool isRememberMeAware($config)

Subclasses may disable remember-me features for the listener, by always returning false from this method.

Parameters

$config

Return Value

bool Whether a possibly configured RememberMeServices should be set for this listener

protected createListener($container, $id, $config, $userProvider)

Parameters

$container
$id
$config
$userProvider

protected createAuthenticationSuccessHandler($container, $id, $config)

Parameters

$container
$id
$config

protected createAuthenticationFailureHandler($container, $id, $config)

Parameters

$container
$id
$config

protected getSuccessHandlerId($id)

Parameters

$id

protected getFailureHandlerId($id)

Parameters

$id