Public Member Functions
	__construct (Typo3Information $typo3Information, EventDispatcherInterface $eventDispatcher, PageRenderer $pageRenderer, UriBuilder $uriBuilder, Features $features, Context $context, ModuleTemplateFactory $moduleTemplateFactory, LoginProviderResolver $loginProviderResolver)

ResponseInterface	formAction (ServerRequestInterface $request)

ResponseInterface	refreshAction (ServerRequestInterface $request)

string	getLoginProviderIdentifier ()

	getCurrentRequest ()

Protected Member Functions
ResponseInterface	appendLoginProviderCookie (NormalizedParams $normalizedParams, ResponseInterface $response)

	init (ServerRequestInterface $request)

	provideCustomLoginStyling ()

string	createLoginLogoutForm (ServerRequestInterface $request)

	renderHtmlViaLoginProvider (ServerRequestInterface $request)

	checkRedirect (ServerRequestInterface $request)

	makeInterfaceSelector (ServerRequestInterface $request)

array	getSystemNews ()

bool	isLoginInProgress (ServerRequestInterface $request)

	redirectToUrl ()

LanguageService	getLanguageService ()

BackendUserAuthentication	getBackendUserAuthentication ()

Protected Attributes
string	$redirectUrl

string	$redirectToURL

string	$loginProviderIdentifier = ''

bool	$loginRefresh

string	$submitValue

StandaloneView	$view

ModuleTemplate	$moduleTemplate

EventDispatcherInterface	$eventDispatcher

Typo3Information	$typo3Information

PageRenderer	$pageRenderer

UriBuilder	$uriBuilder

Features	$features

Context	$context

ModuleTemplateFactory	$moduleTemplateFactory

LoginProviderResolver	$loginProviderResolver

ServerRequestInterface	$currentRequest = null

Detailed Description

Controller responsible for rendering the TYPO3 Backend login form

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

Definition at line 53 of file LoginController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Controller\LoginController::__construct	(	Typo3Information	$typo3Information,
		EventDispatcherInterface	$eventDispatcher,
		PageRenderer	$pageRenderer,
		UriBuilder	$uriBuilder,
		Features	$features,
		Context	$context,
		ModuleTemplateFactory	$moduleTemplateFactory,
		LoginProviderResolver	$loginProviderResolver
	)

Definition at line 107 of file LoginController.php.

Member Function Documentation

◆ appendLoginProviderCookie()

ResponseInterface TYPO3\CMS\Backend\Controller\LoginController::appendLoginProviderCookie	(	NormalizedParams	$normalizedParams,
		ResponseInterface	$response
	)

protected

If a login provider was chosen in the previous request, which is not the default provider, it is stored in a Cookie and appended to the HTTP Response.

Parameters

NormalizedParams	$normalizedParams
ResponseInterface	$response

Returns: ‪ResponseInterface

Definition at line 163 of file LoginController.php.

References $GLOBALS, TYPO3\CMS\Core\Http\NormalizedParams\getSitePath(), and TYPO3\CMS\Core\Http\NormalizedParams\isHttps().

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

◆ 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 352 of file LoginController.php.

References TYPO3\CMS\Backend\Routing\RouteRedirect\createFromRequest(), TYPO3\CMS\Core\FormProtection\FormProtectionFactory\get(), TYPO3\CMS\Backend\Controller\LoginController\getBackendUserAuthentication(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getCookieName(), 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

Definition at line 280 of file LoginController.php.

References TYPO3\CMS\Backend\Controller\LoginController\checkRedirect(), TYPO3\CMS\Backend\Routing\RouteRedirect\createFromRequest(), TYPO3\CMS\Backend\Controller\LoginController\getBackendUserAuthentication(), TYPO3\CMS\Backend\Controller\LoginController\isLoginInProgress(), TYPO3\CMS\Backend\Controller\LoginController\makeInterfaceSelector(), and TYPO3\CMS\Backend\Controller\LoginController\renderHtmlViaLoginProvider().

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

◆ 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 134 of file LoginController.php.

References TYPO3\CMS\Backend\Controller\LoginController\appendLoginProviderCookie(), TYPO3\CMS\Backend\Controller\LoginController\createLoginLogoutForm(), and TYPO3\CMS\Backend\Controller\LoginController\init().

◆ getBackendUserAuthentication()

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

protected

Returns: ‪BackendUserAuthentication

Definition at line 508 of file LoginController.php.

References $GLOBALS.

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

◆ getCurrentRequest()

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

Definition at line 513 of file LoginController.php.

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

Referenced by TYPO3\CMS\Backend\LoginProvider\UsernamePasswordLoginProvider\render().

◆ getLanguageService()

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

protected

Returns LanguageService

Returns: ‪LanguageService

Definition at line 500 of file LoginController.php.

References $GLOBALS.

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

◆ getLoginProviderIdentifier()

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

This can be called by single login providers, they receive an instance of $this

Returns: ‪string

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

References $GLOBALS.

◆ init()

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

protected

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

Parameters

ServerRequestInterface $request ‪the current request

Definition at line 198 of file LoginController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\LoginController\$redirectUrl, TYPO3\CMS\Backend\Routing\RouteRedirect\createFromRequest(), TYPO3\CMS\Backend\Controller\LoginController\getBackendUserAuthentication(), 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\provideCustomLoginStyling(), and TYPO3\CMS\Backend\Controller\LoginController\redirectToUrl().

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

◆ 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().

◆ makeInterfaceSelector()

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

protected

Making interface selector

Parameters

ServerRequestInterface $request

Definition at line 414 of file LoginController.php.

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

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

◆ provideCustomLoginStyling()

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

protected

Definition at line 247 of file LoginController.php.

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

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

◆ redirectToUrl()

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

protected

Wrapper method to redirect to configured redirect URL

Definition at line 490 of file LoginController.php.

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

◆ 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 147 of file LoginController.php.

References TYPO3\CMS\Backend\Controller\LoginController\appendLoginProviderCookie(), TYPO3\CMS\Backend\Controller\LoginController\createLoginLogoutForm(), and TYPO3\CMS\Backend\Controller\LoginController\init().

◆ renderHtmlViaLoginProvider()

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

protected

Definition at line 325 of file LoginController.php.

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

Member Data Documentation

◆ $context

Context TYPO3\CMS\Backend\Controller\LoginController::$context

protected

Definition at line 101 of file LoginController.php.

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

◆ $currentRequest

ServerRequestInterface TYPO3\CMS\Backend\Controller\LoginController::$currentRequest = null

protected

Definition at line 105 of file LoginController.php.

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

◆ $eventDispatcher

EventDispatcherInterface TYPO3\CMS\Backend\Controller\LoginController::$eventDispatcher

protected

Definition at line 96 of file LoginController.php.

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

◆ $features

Features TYPO3\CMS\Backend\Controller\LoginController::$features

protected

Definition at line 100 of file LoginController.php.

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

◆ $loginProviderIdentifier

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

protected

Definition at line 72 of file LoginController.php.

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

◆ $loginProviderResolver

LoginProviderResolver TYPO3\CMS\Backend\Controller\LoginController::$loginProviderResolver

protected

Definition at line 103 of file LoginController.php.

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

◆ $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 80 of file LoginController.php.

◆ $moduleTemplate

ModuleTemplate TYPO3\CMS\Backend\Controller\LoginController::$moduleTemplate

protected

Definition at line 94 of file LoginController.php.

◆ $moduleTemplateFactory

ModuleTemplateFactory TYPO3\CMS\Backend\Controller\LoginController::$moduleTemplateFactory

protected

Definition at line 102 of file LoginController.php.

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

◆ $pageRenderer

PageRenderer TYPO3\CMS\Backend\Controller\LoginController::$pageRenderer

protected

Definition at line 98 of file LoginController.php.

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

◆ $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 65 of file LoginController.php.

◆ $redirectUrl

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

protected

The URL to redirect to after login.

Definition at line 59 of file LoginController.php.

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

◆ $submitValue

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

protected

Value of forms submit button for login.

Definition at line 86 of file LoginController.php.

◆ $typo3Information

Typo3Information TYPO3\CMS\Backend\Controller\LoginController::$typo3Information

protected

Definition at line 97 of file LoginController.php.

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

◆ $uriBuilder

UriBuilder TYPO3\CMS\Backend\Controller\LoginController::$uriBuilder

protected

Definition at line 99 of file LoginController.php.

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

◆ $view

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

protected

Definition at line 90 of file LoginController.php.

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ appendLoginProviderCookie()

◆ checkRedirect()

◆ createLoginLogoutForm()

◆ formAction()

◆ getBackendUserAuthentication()

◆ getCurrentRequest()

◆ getLanguageService()

◆ getLoginProviderIdentifier()

◆ getSystemNews()

◆ init()

◆ isLoginInProgress()

◆ makeInterfaceSelector()

◆ provideCustomLoginStyling()

◆ redirectToUrl()

◆ refreshAction()

◆ renderHtmlViaLoginProvider()

Member Data Documentation

◆ $context

◆ $currentRequest

◆ $eventDispatcher

◆ $features

◆ $loginProviderIdentifier

◆ $loginProviderResolver

◆ $loginRefresh

◆ $moduleTemplate

◆ $moduleTemplateFactory

◆ $pageRenderer

◆ $redirectToURL

◆ $redirectUrl

◆ $submitValue

◆ $typo3Information

◆ $uriBuilder

◆ $view