TYPO3\CMS\Backend\Controller\LoginController Class Reference

Public Member Functions
	__construct ()
	formAction (ServerRequestInterface $request, ResponseInterface $response)
	makeInterfaceSelectorBox ()
	getLoginProviderIdentifier ()

Protected Member Functions
	checkRedirect ()
	getSystemNews ()
	isLoginInProgress ()
	validateAndSortLoginProviders ()
	detectLoginProvider ()
	getLanguageService ()
	getBackendUserAuthentication ()
	getDatabaseConnection ()
	getDocumentTemplate ()

Protected Attributes
	$redirectUrl
	$redirectToURL
	$loginProviderIdentifier = null
	$loginProviders = []
	$loginRefresh
	$submitValue
	$view

Private Member Functions
	getUriForFileName ($filename)

Detailed Description

Script Class for rendering the login form

Definition at line 34 of file LoginController.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Controller\LoginController::__construct

(

)

Initialize the login box. Will also react on a &L=OUT flag and exit.

Definition at line 88 of file LoginController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Backend\Controller\LoginController\detectLoginProvider(), TYPO3\CMS\Backend\Controller\LoginController\getBackendUserAuthentication(), TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\Backend\Controller\LoginController\getLanguageService(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Utility\HttpUtility\redirect(), TYPO3\CMS\Core\Utility\GeneralUtility\sanitizeLocalUrl(), and TYPO3\CMS\Backend\Controller\LoginController\validateAndSortLoginProviders().

Member Function Documentation

checkRedirect()

TYPO3\CMS\Backend\Controller\LoginController::checkRedirect ( )

protected

Checking, if we should perform some sort of redirection OR closing of windows.

Do redirect:

If a user is logged in AND a) if either the login is just done (isLoginInProgress) or b) a loginRefresh is done

Exceptions

Definition at line 259 of file LoginController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Core\FormProtection\FormProtectionFactory\get(), TYPO3\CMS\Backend\Controller\LoginController\getBackendUserAuthentication(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getCookieName(), TYPO3\CMS\Backend\Controller\LoginController\getDocumentTemplate(), TYPO3\CMS\Backend\Controller\LoginController\isLoginInProgress(), and TYPO3\CMS\Core\Utility\HttpUtility\redirect().

Referenced by TYPO3\CMS\Backend\Controller\LoginController\formAction().

detectLoginProvider()

TYPO3\CMS\Backend\Controller\LoginController::detectLoginProvider ( )

protected

Detect the login provider, get from request or choose the first one as default

Returns

string

Definition at line 485 of file LoginController.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\_GP().

Referenced by TYPO3\CMS\Backend\Controller\LoginController\__construct().

formAction()

TYPO3\CMS\Backend\Controller\LoginController::formAction	(	ServerRequestInterface	$request,
		ResponseInterface	$response
	)

Injects the request and response objects for the current request or subrequest As this controller goes only through the main() method, it is rather simple for now

Parameters

ServerRequestInterface	$request	the current request
ResponseInterface	$response	the current response

Returns

ResponseInterface the finished response with the content

Definition at line 134 of file LoginController.php.

References $extConf, $GLOBALS, TYPO3\CMS\Backend\Controller\LoginController\checkRedirect(), TYPO3\CMS\Core\Utility\GeneralUtility\clientInfo(), TYPO3\CMS\Core\Utility\GeneralUtility\deprecationLog(), TYPO3\CMS\Backend\Controller\LoginController\getBackendUserAuthentication(), TYPO3\CMS\Backend\Controller\LoginController\getDocumentTemplate(), TYPO3\CMS\Backend\Controller\LoginController\getSystemNews(), TYPO3\CMS\Backend\Controller\LoginController\getUriForFileName(), TYPO3\CMS\Backend\Controller\LoginController\isLoginInProgress(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Backend\Controller\LoginController\makeInterfaceSelectorBox(), and TYPO3\CMS\Backend\Utility\BackendUtility\TYPO3_copyRightNotice().

getBackendUserAuthentication()

TYPO3\CMS\Backend\Controller\LoginController::getBackendUserAuthentication ( )

protected

Returns

BackendUserAuthentication

Definition at line 520 of file LoginController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\LoginController\__construct(), TYPO3\CMS\Backend\Controller\LoginController\checkRedirect(), and TYPO3\CMS\Backend\Controller\LoginController\formAction().

getDatabaseConnection()

TYPO3\CMS\Backend\Controller\LoginController::getDatabaseConnection ( )

protected

Returns the database connection

Returns

Definition at line 530 of file LoginController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\LoginController\getSystemNews().

getDocumentTemplate()

TYPO3\CMS\Backend\Controller\LoginController::getDocumentTemplate ( )

protected

Returns an instance of DocumentTemplate

Returns

Definition at line 540 of file LoginController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\LoginController\checkRedirect(), and TYPO3\CMS\Backend\Controller\LoginController\formAction().

getLanguageService()

TYPO3\CMS\Backend\Controller\LoginController::getLanguageService ( )

protected

Returns LanguageService

Returns

Definition at line 512 of file LoginController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\LoginController\__construct(), and TYPO3\CMS\Backend\Controller\LoginController\makeInterfaceSelectorBox().

getLoginProviderIdentifier()

TYPO3\CMS\Backend\Controller\LoginController::getLoginProviderIdentifier

(

)

Returns

string

Definition at line 502 of file LoginController.php.

References TYPO3\CMS\Backend\Controller\LoginController\$loginProviderIdentifier.

getSystemNews()

TYPO3\CMS\Backend\Controller\LoginController::getSystemNews ( )

protected

Gets news from sys_news and converts them into a format suitable for showing them at the login screen.

Returns

array An array of login news.

Definition at line 370 of file LoginController.php.

References $GLOBALS, TYPO3\CMS\Backend\Utility\BackendUtility\BEenableFields(), TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), and TYPO3\CMS\Backend\Controller\LoginController\getDatabaseConnection().

Referenced by TYPO3\CMS\Backend\Controller\LoginController\formAction().

getUriForFileName()

TYPO3\CMS\Backend\Controller\LoginController::getUriForFileName (   $filename )

private

Returns the uri of a relative reference, resolves the "EXT:" prefix (way of referring to files inside extensions) and checks that the file is inside the PATH_site of the TYPO3 installation

Parameters

string

$filename

The input filename/filepath to evaluate

Returns

string Returns the filename of $filename if valid, otherwise blank string.

Definition at line 394 of file LoginController.php.

References TYPO3\CMS\Core\Utility\PathUtility\getAbsoluteWebPath(), TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), and TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv().

Referenced by TYPO3\CMS\Backend\Controller\LoginController\formAction().

isLoginInProgress()

TYPO3\CMS\Backend\Controller\LoginController::isLoginInProgress ( )

protected

Checks if login credentials are currently submitted

Returns

bool

Definition at line 417 of file LoginController.php.

References TYPO3\CMS\Backend\Controller\LoginController\$view, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Backend\Controller\LoginController\checkRedirect(), TYPO3\CMS\Backend\Controller\LoginController\formAction(), and TYPO3\CMS\Backend\Controller\LoginController\makeInterfaceSelectorBox().

makeInterfaceSelectorBox()

TYPO3\CMS\Backend\Controller\LoginController::makeInterfaceSelectorBox

(

)

Making interface selector:

Returns

void

Definition at line 334 of file LoginController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\LoginController\getLanguageService(), TYPO3\CMS\Backend\Controller\LoginController\isLoginInProgress(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Controller\LoginController\formAction().

validateAndSortLoginProviders()

TYPO3\CMS\Backend\Controller\LoginController::validateAndSortLoginProviders ( )

protected

Validates the registered login providers

Exceptions

Definition at line 445 of file LoginController.php.

References $a, and $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\LoginController\__construct().

Member Data Documentation

$loginProviderIdentifier

TYPO3\CMS\Backend\Controller\LoginController::$loginProviderIdentifier = null

protected

Definition at line 55 of file LoginController.php.

Referenced by TYPO3\CMS\Backend\Controller\LoginController\getLoginProviderIdentifier().

$loginProviders

TYPO3\CMS\Backend\Controller\LoginController::$loginProviders = []

protected

Definition at line 62 of file LoginController.php.

$loginRefresh

TYPO3\CMS\Backend\Controller\LoginController::$loginRefresh

protected

Definition at line 71 of file LoginController.php.

$redirectToURL

TYPO3\CMS\Backend\Controller\LoginController::$redirectToURL

protected

Definition at line 48 of file LoginController.php.

$redirectUrl

TYPO3\CMS\Backend\Controller\LoginController::$redirectUrl

protected

Definition at line 41 of file LoginController.php.

$submitValue

TYPO3\CMS\Backend\Controller\LoginController::$submitValue

protected

Definition at line 78 of file LoginController.php.

$view

TYPO3\CMS\Backend\Controller\LoginController::$view

protected

Definition at line 83 of file LoginController.php.

Referenced by TYPO3\CMS\Backend\Controller\LoginController\isLoginInProgress().