LoginSuccessEvent
extends Event
in package
This event is dispatched after authentication has successfully completed.
At this stage, the authenticator created a token and generated an authentication success response. Listeners to this event can do actions related to successful authentication (such as migrating the password).
Tags
Table of Contents
Properties
- $authenticatedToken : mixed
- $authenticator : mixed
- $firewallName : string
- $passport : mixed
- $propagationStopped : bool
- $request : mixed
- $response : mixed
Methods
- __construct() : mixed
- getAuthenticatedToken() : TokenInterface
- getAuthenticator() : AuthenticatorInterface
- getFirewallName() : string
- getPassport() : Passport
- getRequest() : Request
- getResponse() : Response|null
- getUser() : UserInterface
- isPropagationStopped() : bool
- Is propagation stopped?
- setResponse() : void
- stopPropagation() : void
- Stops the propagation of the event to further event listeners.
Properties
$authenticatedToken
private
mixed
$authenticatedToken
$authenticator
private
mixed
$authenticator
$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(AuthenticatorInterface $authenticator, Passport $passport, TokenInterface $authenticatedToken, Request $request, Response|null $response, string $firewallName) : mixed
Parameters
- $authenticator : AuthenticatorInterface
- $passport : Passport
- $authenticatedToken : TokenInterface
- $request : Request
- $response : Response|null
- $firewallName : string
getAuthenticatedToken()
public
getAuthenticatedToken() : TokenInterface
Return values
TokenInterfacegetAuthenticator()
public
getAuthenticator() : AuthenticatorInterface
Return values
AuthenticatorInterfacegetFirewallName()
public
getFirewallName() : string
Return values
stringgetPassport()
public
getPassport() : Passport
Return values
PassportgetRequest()
public
getRequest() : Request
Return values
RequestgetResponse()
public
getResponse() : Response|null
Return values
Response|nullgetUser()
public
getUser() : UserInterface
Return values
UserInterfaceisPropagationStopped()
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) : void
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().