DefaultAuthenticationFailureHandler
in package
implements
AuthenticationFailureHandlerInterface
Class with the default authentication failure handling logic.
Can be optionally be extended from by the developer to alter the behavior while keeping the default behavior.
Tags
Interfaces, Classes, Traits and Enums
- AuthenticationFailureHandlerInterface
- Interface for custom authentication failure handlers.
Table of Contents
- $defaultOptions : mixed
- $httpKernel : mixed
- $httpUtils : mixed
- $logger : mixed
- $options : mixed
- __construct() : mixed
- getOptions() : array<string|int, mixed>
- Gets the options.
- onAuthenticationFailure() : Response
- This is called when an interactive authentication attempt fails. This is called by authentication listeners inheriting from AbstractAuthenticationListener.
- setOptions() : mixed
Properties
$defaultOptions
protected
mixed
$defaultOptions
= ['failure_path' => null, 'failure_forward' => false, 'login_path' => '/login', 'failure_path_parameter' => '_failure_path']
$httpKernel
protected
mixed
$httpKernel
$httpUtils
protected
mixed
$httpUtils
$logger
protected
mixed
$logger
$options
protected
mixed
$options
Methods
__construct()
public
__construct(HttpKernelInterface $httpKernel, HttpUtils $httpUtils[, array<string|int, mixed> $options = [] ][, LoggerInterface $logger = null ]) : mixed
Parameters
- $httpKernel : HttpKernelInterface
- $httpUtils : HttpUtils
- $options : array<string|int, mixed> = []
- $logger : LoggerInterface = null
Return values
mixed —getOptions()
Gets the options.
public
getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array of options
onAuthenticationFailure()
This is called when an interactive authentication attempt fails. This is called by authentication listeners inheriting from AbstractAuthenticationListener.
public
onAuthenticationFailure(Request $request, AuthenticationException $exception) : Response
Parameters
- $request : Request
- $exception : AuthenticationException
Return values
Response —The response to return, never null
setOptions()
public
setOptions(array<string|int, mixed> $options) : mixed
Parameters
- $options : array<string|int, mixed>