W3cubDocs

/Symfony 2.7

Symfony\Component\Security\Http\Authentication\DefaultAuthenticationSuccessHandler

class DefaultAuthenticationSuccessHandler implements AuthenticationSuccessHandlerInterface

Class with the default authentication success handling logic.

Methods

__construct(HttpUtils $httpUtils, array $options = array())

Constructor.

Response onAuthenticationSuccess(Request $request, TokenInterface $token)

This is called when an interactive authentication attempt succeeds.

array getOptions()

Gets the options.

setOptions(array $options)

Sets the options.

string getProviderKey()

Get the provider key.

setProviderKey(string $providerKey)

Set the provider key.

Details

public __construct(HttpUtils $httpUtils, array $options = array())

Constructor.

Parameters

HttpUtils $httpUtils
array $options Options for processing a successful authentication attempt.

public Response onAuthenticationSuccess(Request $request, TokenInterface $token)

This is called when an interactive authentication attempt succeeds.

This is called by authentication listeners inheriting from AbstractAuthenticationListener.

Parameters

Request $request
TokenInterface $token

Return Value

Response never null

public array getOptions()

Gets the options.

Return Value

array An array of options

public setOptions(array $options)

Sets the options.

Parameters

array $options An array of options

public string getProviderKey()

Get the provider key.

Return Value

string

public setProviderKey(string $providerKey)

Set the provider key.

Parameters

string $providerKey