AbstractRememberMeServices
abstract class AbstractRememberMeServices implements RememberMeServicesInterface, LogoutHandlerInterface
Base class implementing the RememberMeServicesInterface.
Constants
| COOKIE_DELIMITER |
|
Properties
| protected | $logger | ||
| protected | $options |
Methods
No description
Returns the parameter that is used for checking whether remember-me services have been requested.
No description
Implementation for LogoutHandlerInterface. Deletes the cookie.
Implementation for RememberMeServicesInterface. This is called when an authentication is successful.
Subclasses should validate the cookie and do any additional processing that is required. This is called from autoLogin().
This is called after a user has been logged in successfully, and has requested remember-me capabilities. The implementation usually sets a cookie and possibly stores a persistent record of it.
No description
Decodes the raw cookie value.
Encodes the cookie parts.
Details
__construct(array $userProviders, string $secret, string $providerKey, array $options = array(), LoggerInterface $logger = null)
string
getRememberMeParameter()
Returns the parameter that is used for checking whether remember-me services have been requested.
final TokenInterface
autoLogin(Request $request)
Implementation of RememberMeServicesInterface. Detects whether a remember-me cookie was set, decodes it, and hands it to subclasses for further processing.
logout(Request $request, Response $response, TokenInterface $token)
Implementation for LogoutHandlerInterface. Deletes the cookie.
final
loginFail(Request $request, Exception $exception = null)
Implementation for RememberMeServicesInterface. Deletes the cookie when an attempted authentication fails.
final
loginSuccess(Request $request, Response $response, TokenInterface $token)
Implementation for RememberMeServicesInterface. This is called when an authentication is successful.
abstract protected UserInterface
processAutoLoginCookie(array $cookieParts, Request $request)
Subclasses should validate the cookie and do any additional processing that is required. This is called from autoLogin().
abstract protected
onLoginSuccess(Request $request, Response $response, TokenInterface $token)
This is called after a user has been logged in successfully, and has requested remember-me capabilities. The implementation usually sets a cookie and possibly stores a persistent record of it.
protected bool
isRememberMeRequested(Request $request)
Checks whether remember-me capabilities were requested.