LoginFailureEvent
extends Event
in package
This event is dispatched after an error during authentication.
Listeners to this event can change state based on authentication failure (e.g. to implement login throttling).
Tags
Table of Contents
Properties
- $authenticator : mixed
- $exception : mixed
- $firewallName : string
- $passport : mixed
- $propagationStopped : bool
- $request : mixed
- $response : mixed
Methods
- __construct() : mixed
- getAuthenticator() : AuthenticatorInterface
- getException() : AuthenticationException
- getFirewallName() : string
- getPassport() : Passport|null
- getRequest() : Request
- getResponse() : Response|null
- isPropagationStopped() : bool
- Is propagation stopped?
- setResponse() : mixed
- stopPropagation() : void
- Stops the propagation of the event to further event listeners.
Properties
$authenticator
private
mixed
$authenticator
$exception
private
mixed
$exception
$firewallName
private
string
$firewallName
$passport
private
mixed
$passport
$propagationStopped
private
bool
$propagationStopped
= false
$request
private
mixed
$request
$response
private
mixed
$response
Methods
__construct()
public
__construct(AuthenticationException $exception, AuthenticatorInterface $authenticator, Request $request, Response|null $response, string $firewallName[, Passport $passport = null ]) : mixed
Parameters
- $exception : AuthenticationException
- $authenticator : AuthenticatorInterface
- $request : Request
- $response : Response|null
- $firewallName : string
- $passport : Passport = null
getAuthenticator()
public
getAuthenticator() : AuthenticatorInterface
Return values
AuthenticatorInterfacegetException()
public
getException() : AuthenticationException
Return values
AuthenticationExceptiongetFirewallName()
public
getFirewallName() : string
Return values
stringgetPassport()
public
getPassport() : Passport|null
Return values
Passport|nullgetRequest()
public
getRequest() : Request
Return values
RequestgetResponse()
public
getResponse() : Response|null
Return values
Response|nullisPropagationStopped()
Is propagation stopped?
public
isPropagationStopped() : bool
Return values
bool —True if the Event is complete and no further listeners should be called. False to continue calling listeners.
setResponse()
public
setResponse(Response|null $response) : mixed
Parameters
- $response : Response|null
stopPropagation()
Stops the propagation of the event to further event listeners.
public
stopPropagation() : void
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().