DefaultAuthenticationSuccessHandler

class DefaultAuthenticationSuccessHandler implements AuthenticationSuccessHandlerInterface

Class with the default authentication success handling logic.

Traits

TargetPathTrait Trait to get (and set) the URL the user last visited before being forced to authenticate.

Properties

protected $httpUtils
protected $options
protected $providerKey
protected $defaultOptions

Methods

__construct(HttpUtils $httpUtils, array $options = array())
Response onAuthenticationSuccess(Request $request, TokenInterface $token)

This is called when an interactive authentication attempt succeeds. This is called by authentication listeners inheriting from AbstractAuthenticationListener.

array getOptions()

Gets the options.

setOptions(array $options)
string getProviderKey()

Get the provider key.

setProviderKey(string $providerKey)

Set the provider key.

string determineTargetUrl(Request $request)

Builds the target URL according to the defined options.

Details

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

Parameters

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

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

array getOptions()

Gets the options.

Return Value

array An array of options

setOptions(array $options)

Parameters

array $options

string getProviderKey()

Get the provider key.

Return Value

string

setProviderKey(string $providerKey)

Set the provider key.

Parameters

string $providerKey

protected string determineTargetUrl(Request $request)

Builds the target URL according to the defined options.

Parameters

Request $request

Return Value

string