TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver Class Reference

Public Member Functions
	__construct (array $loginProviders=null)
array	getLoginProviders ()
bool	hasLoginProvider (string $identifier)
	getLoginProviderConfigurationByIdentifier (string $identifier)
string	getPrimaryLoginProviderIdentifier ()
string	resolveLoginProviderIdentifierFromRequest (ServerRequestInterface $request, string $cookieName)

Protected Member Functions
array	validateAndSortLoginProviders (array $providers)

Protected Attributes
array	$loginProviders = []

Detailed Description

Login Providers for the TYPO3 Backend can be registered via $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['backend']['loginProviders']

This makes it possible to e.g. register a login provider to log-in via a common SSO login, with a different entry point.

By default, TYPO3 ships with a username/password login provider.

This class is responsible to fetch the login providers sorted by their priority, and encapsulate the logic further.

This resolver class itself is not part of the TYPO3 Core API as it is only used in TYPO3's Backend login.

Definition at line 36 of file LoginProviderResolver.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver::__construct

(

array

$loginProviders = null

)

Definition at line 40 of file LoginProviderResolver.php.

References $GLOBALS, TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver\$loginProviders, and TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver\validateAndSortLoginProviders().

Member Function Documentation

getLoginProviderConfigurationByIdentifier()

TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver::getLoginProviderConfigurationByIdentifier

(

string

$identifier

)

Definition at line 109 of file LoginProviderResolver.php.

getLoginProviders()

array TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver::getLoginProviders

(

)

Get all registered login providers in the right order

Returns

‪array

Definition at line 92 of file LoginProviderResolver.php.

References TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver\$loginProviders.

getPrimaryLoginProviderIdentifier()

string TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver::getPrimaryLoginProviderIdentifier

(

)

Returns the identifier of the first login provider / with the highest priority.

Returns

‪string

Definition at line 118 of file LoginProviderResolver.php.

Referenced by TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver\resolveLoginProviderIdentifierFromRequest().

hasLoginProvider()

bool TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver::hasLoginProvider

(

string

$identifier

)

Check if the login provider is registered.

Parameters

string

$identifier

Returns

‪bool

Definition at line 104 of file LoginProviderResolver.php.

Referenced by TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver\resolveLoginProviderIdentifierFromRequest().

resolveLoginProviderIdentifierFromRequest()

string TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver::resolveLoginProviderIdentifierFromRequest	(	ServerRequestInterface	$request,
		string	$cookieName
	)

Fetches the login provider identifier from a ServerRequest, checking for POST Body, then Query Param, and then checks for the cookie.

Parameters

ServerRequestInterface	$request
string	$cookieName

Returns

‪string

Definition at line 132 of file LoginProviderResolver.php.

References TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver\getPrimaryLoginProviderIdentifier(), and TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver\hasLoginProvider().

validateAndSortLoginProviders()

array TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver::validateAndSortLoginProviders ( array  $providers )

protected

Validates the registered login providers

Parameters

array

$providers

Returns

‪array the sorted login providers

Exceptions

Definition at line 59 of file LoginProviderResolver.php.

Referenced by TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver\__construct().

Member Data Documentation

$loginProviders

array TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver::$loginProviders = []

protected

Definition at line 38 of file LoginProviderResolver.php.

Referenced by TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver\__construct(), and TYPO3\CMS\Backend\LoginProvider\LoginProviderResolver\getLoginProviders().