Symfony2 API
Class

Symfony\Component\Security\Http\RememberMe\PersistentTokenBasedRememberMeServices

class PersistentTokenBasedRememberMeServices extends AbstractRememberMeServices

Concrete implementation of the RememberMeServicesInterface which needs an implementation of TokenProviderInterface for providing remember-me capabilities.

Constants

COOKIE_DELIMITER

Methods

__construct(array $userProviders, string $key, string $providerKey, array $options = array(), LoggerInterface $logger = null, SecureRandomInterface $secureRandom)

Constructor
string getRememberMeParameter()

Returns the parameter that is used for checking whether remember-me services have been requested.

 from AbstractRememberMeServices
getKey()

from AbstractRememberMeServices
TokenInterface|null autoLogin(Request $request)

Implementation of RememberMeServicesInterface.

 from AbstractRememberMeServices
logout(Request $request, Response $response, TokenInterface $token)

Implementation for LogoutHandlerInterface.

 from AbstractRememberMeServices
loginFail(Request $request)

Implementation for RememberMeServicesInterface.

 from AbstractRememberMeServices
loginSuccess(Request $request, Response $response, TokenInterface $token)

Implementation for RememberMeServicesInterface.

 from AbstractRememberMeServices
setTokenProvider(TokenProviderInterface $tokenProvider)

Sets the token provider

Details

at line 47
public __construct(array $userProviders, string $key, string $providerKey, array $options = array(), LoggerInterface $logger = null, SecureRandomInterface $secureRandom)

Constructor

Parameters

array $userProviders
string $key
string $providerKey
array $options
LoggerInterface $logger
SecureRandomInterface $secureRandom

Exceptions

InvalidArgumentException

in AbstractRememberMeServices at line 78
public string getRememberMeParameter()

Returns the parameter that is used for checking whether remember-me services have been requested.

Return Value

string

in AbstractRememberMeServices at line 83
public getKey()

in AbstractRememberMeServices at line 98
final public TokenInterface|null autoLogin(Request $request)

Implementation of RememberMeServicesInterface.

Detects whether a remember-me
cookie was set, decodes it, and hands it to subclasses for further processing.

Parameters

Request $request

Return Value

TokenInterface|null

Exceptions

CookieTheftException

in AbstractRememberMeServices at line 152
public logout(Request $request, Response $response, TokenInterface $token)

Implementation for LogoutHandlerInterface.

Deletes the cookie.

Parameters

Request $request
Response $response
TokenInterface $token

in AbstractRememberMeServices at line 163
final public loginFail(Request $request)

Implementation for RememberMeServicesInterface.

Deletes the cookie when
an attempted authentication fails.

Parameters

Request $request

in AbstractRememberMeServices at line 177
final public loginSuccess(Request $request, Response $response, TokenInterface $token)

Implementation for RememberMeServicesInterface.

This is called when an
authentication is successful.

Parameters

Request $request
Response $response
TokenInterface $token The token that resulted in a successful authentication

at line 59
public setTokenProvider(TokenProviderInterface $tokenProvider)

Sets the token provider

Parameters

TokenProviderInterface $tokenProvider