TokenDeauthenticatedEvent
extends Event
in package
This event is dispatched when the current security token is deauthenticated when trying to reference the token.
This includes changes in the user (DeauthenticatedEvent), but also cases where there is no user provider available to refresh the user.
Use this event if you want to trigger some actions whenever a user is deauthenticated and redirected back to the authentication entry point (e.g. clearing all remember-me cookies).
Tags
Table of Contents
Properties
- $originalToken : mixed
- $propagationStopped : bool
- $request : mixed
Methods
- __construct() : mixed
- getOriginalToken() : TokenInterface
- getRequest() : Request
- isPropagationStopped() : bool
- Is propagation stopped?
- stopPropagation() : void
- Stops the propagation of the event to further event listeners.
Properties
$originalToken
private
mixed
$originalToken
$propagationStopped
private
bool
$propagationStopped
= false
$request
private
mixed
$request
Methods
__construct()
public
__construct(TokenInterface $originalToken, Request $request) : mixed
Parameters
- $originalToken : TokenInterface
- $request : Request
getOriginalToken()
public
getOriginalToken() : TokenInterface
Return values
TokenInterfacegetRequest()
public
getRequest() : Request
Return values
RequestisPropagationStopped()
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.
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().