PersistentRememberMeHandler
extends AbstractRememberMeHandler
in package
FinalYes
Implements remember-me tokens using a {@see TokenProviderInterface}.
This requires storing remember-me tokens in a database. This allows more control over the invalidation of remember-me tokens. See SignatureRememberMeHandler if you don't want to use a database.
Tags
Table of Contents
Properties
- $logger : mixed
- $options : mixed
- $requestStack : mixed
- $tokenProvider : mixed
- $tokenVerifier : mixed
- $userProvider : mixed
Methods
- __construct() : mixed
- clearRememberMeCookie() : void
- Clears the remember-me cookie.
- consumeRememberMeCookie() : UserInterface
- Validates the remember-me cookie and returns the associated User.
- createRememberMeCookie() : void
- {@inheritdoc}
- processRememberMe() : void
- Checks if the RememberMeDetails is a valid cookie to login the given User.
- createCookie() : mixed
- Creates the remember-me cookie using the correct configuration.
Properties
$logger
protected
mixed
$logger
$options
protected
mixed
$options
$requestStack
protected
mixed
$requestStack
$tokenProvider
private
mixed
$tokenProvider
$tokenVerifier
private
mixed
$tokenVerifier
$userProvider
private
mixed
$userProvider
Methods
__construct()
public
__construct(TokenProviderInterface $tokenProvider, string $secret, UserProviderInterface $userProvider, RequestStack $requestStack, array<string|int, mixed> $options[, LoggerInterface $logger = null ][, TokenVerifierInterface $tokenVerifier = null ]) : mixed
Parameters
- $tokenProvider : TokenProviderInterface
- $secret : string
- $userProvider : UserProviderInterface
- $requestStack : RequestStack
- $options : array<string|int, mixed>
- $logger : LoggerInterface = null
- $tokenVerifier : TokenVerifierInterface = null
clearRememberMeCookie()
Clears the remember-me cookie.
public
clearRememberMeCookie() : void
consumeRememberMeCookie()
Validates the remember-me cookie and returns the associated User.
public
consumeRememberMeCookie(RememberMeDetails $rememberMeDetails) : UserInterface
Parameters
- $rememberMeDetails : RememberMeDetails
Return values
UserInterfacecreateRememberMeCookie()
{@inheritdoc}
public
createRememberMeCookie(UserInterface $user) : void
Parameters
- $user : UserInterface
processRememberMe()
Checks if the RememberMeDetails is a valid cookie to login the given User.
public
processRememberMe(RememberMeDetails $rememberMeDetails, UserInterface $user) : void
This method should also:
- Create a new remember-me cookie to be sent with the response (using createCookie());
- If you store the token somewhere else (e.g. in a database), invalidate the stored token.
Parameters
- $rememberMeDetails : RememberMeDetails
- $user : UserInterface
createCookie()
Creates the remember-me cookie using the correct configuration.
protected
createCookie(RememberMeDetails|null $rememberMeDetails) : mixed
Parameters
- $rememberMeDetails : RememberMeDetails|null
-
The details for the cookie, or null to clear the remember-me cookie