JsonLoginFactory
extends AbstractFactory
in package
JsonLoginFactory creates services for JSON login authentication.
Tags
Table of Contents
- $defaultFailureHandlerOptions : mixed
- $defaultSuccessHandlerOptions : mixed
- $options : mixed
- __construct() : mixed
- addConfiguration() : mixed
- addOption() : mixed
- create() : array<string|int, mixed>
- Configures the container services required to use the authentication listener.
- getKey() : mixed
- {@inheritdoc}
- getPosition() : mixed
- {@inheritdoc}
- createAuthenticationFailureHandler() : mixed
- createAuthenticationSuccessHandler() : mixed
- createAuthProvider() : string
- Subclasses must return the id of a service which implements the AuthenticationProviderInterface.
- createEntryPoint() : string|null
- Subclasses may create an entry point of their as they see fit. The default implementation does not change the default entry point.
- createListener() : mixed
- getFailureHandlerId() : mixed
- getListenerId() : string
- Subclasses must return the id of the abstract listener template.
- getSuccessHandlerId() : mixed
- isRememberMeAware() : bool
- Subclasses may disable remember-me features for the listener, by always returning false from this method.
Properties
$defaultFailureHandlerOptions
protected
mixed
$defaultFailureHandlerOptions
= ['failure_path' => null, 'failure_forward' => false, 'login_path' => '/login', 'failure_path_parameter' => '_failure_path']
$defaultSuccessHandlerOptions
protected
mixed
$defaultSuccessHandlerOptions
= ['always_use_default_target_path' => false, 'default_target_path' => '/', 'login_path' => '/login', 'target_path_parameter' => '_target_path', 'use_referer' => false]
$options
protected
mixed
$options
= ['check_path' => '/login_check', 'use_forward' => false, 'require_previous_session' => false]
Methods
__construct()
public
__construct() : mixed
Return values
mixed —addConfiguration()
public
addConfiguration(NodeDefinition $node) : mixed
Parameters
- $node : NodeDefinition
Return values
mixed —addOption()
public
final addOption(string $name[, mixed $default = null ]) : mixed
Parameters
- $name : string
- $default : mixed = null
Return values
mixed —create()
Configures the container services required to use the authentication listener.
public
create(ContainerBuilder $container, mixed $id, mixed $config, mixed $userProviderId, mixed $defaultEntryPointId) : array<string|int, mixed>
Parameters
- $container : ContainerBuilder
- $id : mixed
-
The unique id of the firewall
- $config : mixed
-
The options array for the listener
- $userProviderId : mixed
-
The service id of the user provider
- $defaultEntryPointId : mixed
Return values
array<string|int, mixed> —containing three values:
- the provider id
- the listener id
- the entry point id
getKey()
{@inheritdoc}
public
getKey() : mixed
Return values
mixed —getPosition()
{@inheritdoc}
public
getPosition() : mixed
Return values
mixed —createAuthenticationFailureHandler()
protected
createAuthenticationFailureHandler(mixed $container, mixed $id, mixed $config) : mixed
Parameters
- $container : mixed
- $id : mixed
- $config : mixed
Return values
mixed —createAuthenticationSuccessHandler()
protected
createAuthenticationSuccessHandler(mixed $container, mixed $id, mixed $config) : mixed
Parameters
- $container : mixed
- $id : mixed
- $config : mixed
Return values
mixed —createAuthProvider()
Subclasses must return the id of a service which implements the AuthenticationProviderInterface.
protected
createAuthProvider(ContainerBuilder $container, mixed $id, mixed $config, mixed $userProviderId) : string
Parameters
- $container : ContainerBuilder
- $id : mixed
-
The unique id of the firewall
- $config : mixed
-
The options array for this listener
- $userProviderId : mixed
-
The id of the user provider
Return values
string —never null, the id of the authentication provider
createEntryPoint()
Subclasses may create an entry point of their as they see fit. The default implementation does not change the default entry point.
protected
createEntryPoint(ContainerBuilder $container, string $id, array<string|int, mixed> $config, string|null $defaultEntryPointId) : string|null
Parameters
- $container : ContainerBuilder
- $id : string
- $config : array<string|int, mixed>
- $defaultEntryPointId : string|null
Return values
string|null —the entry point id
createListener()
protected
createListener(mixed $container, mixed $id, mixed $config, mixed $userProvider) : mixed
Parameters
- $container : mixed
- $id : mixed
- $config : mixed
- $userProvider : mixed
Return values
mixed —getFailureHandlerId()
protected
getFailureHandlerId(mixed $id) : mixed
Parameters
- $id : mixed
Return values
mixed —getListenerId()
Subclasses must return the id of the abstract listener template.
protected
getListenerId() : string
Return values
string —getSuccessHandlerId()
protected
getSuccessHandlerId(mixed $id) : mixed
Parameters
- $id : mixed
Return values
mixed —isRememberMeAware()
Subclasses may disable remember-me features for the listener, by always returning false from this method.
protected
isRememberMeAware(mixed $config) : bool
Parameters
- $config : mixed
Return values
bool —Whether a possibly configured RememberMeServices should be set for this listener