CheckPassportEvent
extends Event
in package
This event is dispatched when the credentials have to be checked.
Listeners to this event must validate the user and the credentials (e.g. default listeners do password verification and user checking)
Tags
Table of Contents
Properties
- $authenticator : mixed
- $passport : mixed
- $propagationStopped : bool
Methods
- __construct() : mixed
- getAuthenticator() : AuthenticatorInterface
- getPassport() : Passport
- isPropagationStopped() : bool
- Is propagation stopped?
- stopPropagation() : void
- Stops the propagation of the event to further event listeners.
Properties
$authenticator
private
mixed
$authenticator
$passport
private
mixed
$passport
$propagationStopped
private
bool
$propagationStopped
= false
Methods
__construct()
public
__construct(AuthenticatorInterface $authenticator, Passport $passport) : mixed
Parameters
- $authenticator : AuthenticatorInterface
- $passport : Passport
getAuthenticator()
public
getAuthenticator() : AuthenticatorInterface
Return values
AuthenticatorInterfacegetPassport()
public
getPassport() : Passport
Return values
PassportisPropagationStopped()
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().