RememberMeAuthenticator
in package
implements
InteractiveAuthenticatorInterface
The RememberMe *Authenticator* performs remember me authentication.
This authenticator is executed whenever a user's session expired and a remember-me cookie was found. This authenticator then "re-authenticates" the user using the information in the cookie.
Tags
Table of Contents
Interfaces
- InteractiveAuthenticatorInterface
- This is an extension of the authenticator interface that must be used by interactive authenticators.
Properties
- $cookieName : string
- $logger : mixed
- $rememberMeHandler : mixed
- $secret : string
- $tokenStorage : mixed
Methods
- __construct() : mixed
- authenticate() : Passport
- createToken() : TokenInterface
- isInteractive() : bool
- Should return true to make this authenticator perform an interactive login.
- onAuthenticationFailure() : Response|null
- onAuthenticationSuccess() : Response|null
- supports() : bool|null
Properties
$cookieName
private
string
$cookieName
$logger
private
mixed
$logger
$rememberMeHandler
private
mixed
$rememberMeHandler
$secret
private
string
$secret
$tokenStorage
private
mixed
$tokenStorage
Methods
__construct()
public
__construct(RememberMeHandlerInterface $rememberMeHandler, string $secret, TokenStorageInterface $tokenStorage, string $cookieName[, LoggerInterface $logger = null ]) : mixed
Parameters
- $rememberMeHandler : RememberMeHandlerInterface
- $secret : string
- $tokenStorage : TokenStorageInterface
- $cookieName : string
- $logger : LoggerInterface = null
authenticate()
public
authenticate(Request $request) : Passport
Parameters
- $request : Request
Return values
PassportcreateToken()
public
createToken(Passport $passport, string $firewallName) : TokenInterface
Parameters
- $passport : Passport
- $firewallName : string
Return values
TokenInterfaceisInteractive()
Should return true to make this authenticator perform an interactive login.
public
isInteractive() : bool
Return values
boolonAuthenticationFailure()
public
onAuthenticationFailure(Request $request, AuthenticationException $exception) : Response|null
Parameters
- $request : Request
- $exception : AuthenticationException
Return values
Response|nullonAuthenticationSuccess()
public
onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName) : Response|null
Parameters
- $request : Request
- $token : TokenInterface
- $firewallName : string
Return values
Response|nullsupports()
public
supports(Request $request) : bool|null
Parameters
- $request : Request