Symfony\Component\Security\Http\RememberMe\RememberMeServicesInterface
Interface that needs to be implemented by classes which provide remember-me capabilities.
We provide two implementations out-of-the-box:
- TokenBasedRememberMeServices (does not require a TokenProvider)
- PersistentTokenBasedRememberMeServices (requires a TokenProvider)
- Author: Johannes M. Schmitt <schmittjoh@gmail.com>
Synopsis
interface RememberMeServicesInterface
{
- // constants
- const COOKIE_ATTR_NAME = '_security_remember_me_cookie';
- // methods
- public TokenInterface autoLogin()
- public void loginFail()
- public void loginSuccess()
Constants
Name | Value |
---|---|
COOKIE_ATTR_NAME | '_security_remember_me_cookie' |
Methods
public
- autoLogin() — This method will be called whenever the SecurityContext does not contain an TokenInterface object and the framework wishes to provide an implementation with an opportunity to authenticate the request using remember-me capabilities.
- loginFail() — Called whenever an interactive authentication attempt was made, but the credentials supplied by the user were missing or otherwise invalid.
- loginSuccess() — Called whenever an interactive authentication attempt is successful (e.g. a form login).