Inheritance diagram for TYPO3\CMS\Backend\Controller\LoginController:

Public Member Functions
	__construct ()

ResponseInterface	formAction (ServerRequestInterface $request)

ResponseInterface	refreshAction (ServerRequestInterface $request)

string	main ()

	makeInterfaceSelectorBox ()

string	getLoginProviderIdentifier ()

Protected Member Functions
string	createLoginLogoutForm (ServerRequestInterface $request)

	checkRedirect (ServerRequestInterface $request)

	makeInterfaceSelector (ServerRequestInterface $request)

array	getSystemNews ()

bool	isLoginInProgress (ServerRequestInterface $request)

StandaloneView	getFluidTemplateObject ()

	redirectToUrl ()

	validateAndSortLoginProviders ()

string	detectLoginProvider (ServerRequestInterface $request)

LanguageService	getLanguageService ()

BackendUserAuthentication	getBackendUserAuthentication ()

DocumentTemplate	getDocumentTemplate ()

Protected Attributes
string	$redirectUrl

string	$redirectToURL

string	$loginProviderIdentifier

array	$loginProviders = array( )

bool	$loginRefresh

string	$submitValue

StandaloneView	$view

Private Member Functions
string	getUriForFileName ($filename)

Detailed Description

Script Class for rendering the login form

This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.

Definition at line 48 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 97 of file LoginController.php.

References $GLOBALS, $locales, TYPO3\CMS\Backend\Controller\LoginController\$redirectUrl, TYPO3\CMS\Backend\Controller\LoginController\detectLoginProvider(), TYPO3\CMS\Backend\Controller\LoginController\getBackendUserAuthentication(), TYPO3\CMS\Backend\Controller\LoginController\getFluidTemplateObject(), TYPO3\CMS\Backend\Controller\LoginController\getLanguageService(), TYPO3\CMS\Core\Localization\LanguageService\includeLLFile(), TYPO3\CMS\Core\Localization\LanguageService\init(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\logoff(), TYPO3\CMS\Backend\Controller\LoginController\redirectToUrl(), and TYPO3\CMS\Backend\Controller\LoginController\validateAndSortLoginProviders().

Member Function Documentation

◆ checkRedirect()

TYPO3\CMS\Backend\Controller\LoginController::checkRedirect ( ServerRequestInterface $request )

protected

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

Do a redirect if a user is logged in

Parameters

ServerRequestInterface $request

Exceptions

Definition at line 308 of file LoginController.php.

References TYPO3\CMS\Core\FormProtection\FormProtectionFactory\get(), TYPO3\CMS\Backend\Controller\LoginController\getBackendUserAuthentication(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getCookieName(), TYPO3\CMS\Backend\Controller\LoginController\getDocumentTemplate(), and TYPO3\CMS\Backend\Controller\LoginController\redirectToUrl().

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

◆ createLoginLogoutForm()

string TYPO3\CMS\Backend\Controller\LoginController::createLoginLogoutForm ( ServerRequestInterface $request )

protected

Main function - creating the login/logout form

Parameters

ServerRequestInterface $request

Returns: ‪string $content

Exceptions

Exception

Definition at line 189 of file LoginController.php.

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

◆ detectLoginProvider()

string TYPO3\CMS\Backend\Controller\LoginController::detectLoginProvider ( ServerRequestInterface $request )

protected

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

Parameters

ServerRequestInterface $request

Returns: ‪string

Definition at line 554 of file LoginController.php.

References $GLOBALS.

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

◆ formAction()

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

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

Returns: ‪ResponseInterface the finished response with the content

Definition at line 152 of file LoginController.php.

References TYPO3\CMS\Backend\Controller\LoginController\createLoginLogoutForm().

◆ getBackendUserAuthentication()

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

protected

Returns: ‪BackendUserAuthentication

Definition at line 608 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\createLoginLogoutForm().

◆ getDocumentTemplate()

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

protected

Returns an instance of DocumentTemplate

Returns: ‪DocumentTemplate

Definition at line 618 of file LoginController.php.

References $GLOBALS.

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

◆ getFluidTemplateObject()

StandaloneView TYPO3\CMS\Backend\Controller\LoginController::getFluidTemplateObject ( )

protected

returns a new standalone view, shorthand function

Returns: ‪StandaloneView

Definition at line 492 of file LoginController.php.

References TYPO3\CMS\Backend\Controller\LoginController\$view, TYPO3\CMS\Fluid\View\StandaloneView\getRequest(), TYPO3\CMS\Fluid\View\AbstractTemplateView\setLayoutRootPaths(), TYPO3\CMS\Fluid\View\AbstractTemplateView\setPartialRootPaths(), and TYPO3\CMS\Fluid\View\AbstractTemplateView\setTemplateRootPaths().

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

◆ getLanguageService()

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

protected

Returns LanguageService

Returns: ‪LanguageService

Definition at line 600 of file LoginController.php.

References $GLOBALS.

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

◆ getLoginProviderIdentifier()

string TYPO3\CMS\Backend\Controller\LoginController::getLoginProviderIdentifier ( )

Returns: ‪string

Definition at line 590 of file LoginController.php.

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

◆ getSystemNews()

array 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 428 of file LoginController.php.

References $GLOBALS.

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

◆ getUriForFileName()

string 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 project root 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 459 of file LoginController.php.

References TYPO3\CMS\Core\Utility\PathUtility\getAbsoluteWebPath().

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

◆ isLoginInProgress()

bool TYPO3\CMS\Backend\Controller\LoginController::isLoginInProgress ( ServerRequestInterface $request )

protected

Checks if login credentials are currently submitted

Parameters

ServerRequestInterface $request

Returns: ‪bool

Definition at line 479 of file LoginController.php.

Referenced by TYPO3\CMS\Backend\Controller\LoginController\createLoginLogoutForm(), and TYPO3\CMS\Backend\Controller\LoginController\makeInterfaceSelector().

◆ main()

string TYPO3\CMS\Backend\Controller\LoginController::main ( )

Main function - creating the login/logout form

Exceptions

Exception

Returns: ‪string The content to output

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 176 of file LoginController.php.

References $GLOBALS, and TYPO3\CMS\Backend\Controller\LoginController\createLoginLogoutForm().

◆ makeInterfaceSelector()

TYPO3\CMS\Backend\Controller\LoginController::makeInterfaceSelector ( ServerRequestInterface $request )

protected

Making interface selector

Parameters

ServerRequestInterface $request

Definition at line 391 of file LoginController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\LoginController\getLanguageService(), TYPO3\CMS\Core\Localization\LanguageService\getLL(), and TYPO3\CMS\Backend\Controller\LoginController\isLoginInProgress().

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

◆ makeInterfaceSelectorBox()

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

Making interface selector

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 381 of file LoginController.php.

References $GLOBALS, and TYPO3\CMS\Backend\Controller\LoginController\makeInterfaceSelector().

◆ redirectToUrl()

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

protected

Wrapper method to redirect to configured redirect URL

Definition at line 507 of file LoginController.php.

References TYPO3\CMS\Core\Utility\HttpUtility\redirect().

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

◆ refreshAction()

ResponseInterface TYPO3\CMS\Backend\Controller\LoginController::refreshAction ( ServerRequestInterface $request )

Calls the main function but with loginRefresh enabled at any time

Parameters

ServerRequestInterface $request ‪the current request

Returns: ‪ResponseInterface the finished response with the content

Definition at line 163 of file LoginController.php.

References TYPO3\CMS\Backend\Controller\LoginController\createLoginLogoutForm().

◆ validateAndSortLoginProviders()

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

protected

Validates the registered login providers

Exceptions

Definition at line 517 of file LoginController.php.

References $GLOBALS.

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

Member Data Documentation

◆ $loginProviderIdentifier

string TYPO3\CMS\Backend\Controller\LoginController::$loginProviderIdentifier

protected

the active login provider identifier

Definition at line 68 of file LoginController.php.

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

◆ $loginProviders

array TYPO3\CMS\Backend\Controller\LoginController::$loginProviders = array( )

protected

List of registered and sorted login providers

Definition at line 74 of file LoginController.php.

◆ $loginRefresh

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

protected

Login-refresh bool; The backend will call this script with this value set when the login is close to being expired and the form needs to be redrawn.

Definition at line 82 of file LoginController.php.

◆ $redirectToURL

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

protected

Set to the redirect URL of the form (may be redirect_url or "index.php?M=main")

Definition at line 62 of file LoginController.php.

◆ $redirectUrl

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

protected

The URL to redirect to after login.

Definition at line 56 of file LoginController.php.

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

◆ $submitValue

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

protected

Value of forms submit button for login.

Definition at line 88 of file LoginController.php.

◆ $view

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

protected

Definition at line 92 of file LoginController.php.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkRedirect()

◆ createLoginLogoutForm()

◆ detectLoginProvider()

◆ formAction()

◆ getBackendUserAuthentication()

◆ getDocumentTemplate()

◆ getFluidTemplateObject()

◆ getLanguageService()

◆ getLoginProviderIdentifier()

◆ getSystemNews()

◆ getUriForFileName()

◆ isLoginInProgress()

◆ main()

◆ makeInterfaceSelector()

◆ makeInterfaceSelectorBox()

◆ redirectToUrl()

◆ refreshAction()

◆ validateAndSortLoginProviders()

Member Data Documentation

◆ $loginProviderIdentifier

◆ $loginProviders

◆ $loginRefresh

◆ $redirectToURL

◆ $redirectUrl

◆ $submitValue

◆ $view