DefaultAuthenticationSuccessHandler

class DefaultAuthenticationSuccessHandler implements AuthenticationSuccessHandlerInterface

Class with the default authentication success handling logic.

Traits

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

Methods

	__construct(HttpUtils $httpUtils, array $options = array()) Constructor.
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) Sets the options.
string	getProviderKey() Get the provider key.
	setProviderKey(string $providerKey) Set the provider key.

Details

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

Constructor.

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)

Sets the options.

Parameters

array

$options

An array of options

string getProviderKey()

Get the provider key.

Return Value

string

setProviderKey(string $providerKey)

Set the provider key.

Parameters

string

$providerKey

Links:

http://api.symfony.com/master/Symfony/Component/Security/Http/Authentication/DefaultAuthenticationSuccessHandler.html

doc_Symfony

2016-10-28 06:13:34

Comments