TYPO3\CMS\FrontendLogin\Controller\LoginController Class Reference

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

Public Member Functions
	__construct (RedirectHandler $redirectHandler, ServerRequestHandler $requestHandler, UserService $userService, EventDispatcherInterface $eventDispatcher)
	initializeAction ()
	loginAction ()
	overviewAction (bool $showLoginMessage=false)
	logoutAction (int $redirectPageLogout=0)
bool	isRedirectDisabled ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	injectConfigurationManager (ConfigurationManagerInterface $configurationManager)
	injectObjectManager (ObjectManagerInterface $objectManager)
	injectSignalSlotDispatcher (Dispatcher $signalSlotDispatcher)
	injectValidatorResolver (ValidatorResolver $validatorResolver)
	injectViewResolver (ViewResolverInterface $viewResolver)
	injectReflectionService (ReflectionService $reflectionService)
	injectCacheService (CacheService $cacheService)
	injectHashService (HashService $hashService)
	injectMvcPropertyMappingConfigurationService (MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService)
	injectEventDispatcher (EventDispatcherInterface $eventDispatcher)
	initializeControllerArgumentsBaseValidators ()
	processRequest (RequestInterface $request, ResponseInterface $response)
ControllerContext	getControllerContext ()
	addFlashMessage ($messageBody, $messageTitle='', $severity=AbstractMessage::OK, $storeInSession=true)
bool	canProcessRequest (RequestInterface $request)
	forward ($actionName, $controllerName=null, $extensionName=null, array $arguments=null)
	throwStatus ($statusCode, $statusMessage=null, $content=null)

Public Attributes
const	MESSAGEKEY_DEFAULT = 'welcome'
const	MESSAGEKEY_ERROR = 'error'
const	MESSAGEKEY_LOGOUT = 'logout'

Protected Member Functions
	handleRedirect ()
	handleLoginForwards ()
int	getPermaloginStatus ()
	isPermaloginDisabled (int $permaLogin)
bool	shouldRedirectToOverview ()
string	getStatusMessageKey ()
	isLoginOrLogoutInProgress ()
	isLogoutSuccessful ()
	hasLoginErrorOccurred ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\FrontendLogin\Controller\AbstractLoginFormController
array	getStorageFolders ()
	getSignedStorageFolders ()
	shallEnforceLoginSigning ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	initializeView (ViewInterface $view)
	initializeActionMethodArguments ()
	initializeActionMethodValidators ()
	renderAssetsForRequest ($request)
string	resolveActionMethodName ()
	callActionMethod ()
	emitBeforeCallActionMethodSignal (array $preparedArguments)
ViewInterface	resolveView ()
	setViewConfiguration (ViewInterface $view)
array	getViewProperty ($extbaseFrameworkConfiguration, $setting)
string	errorAction ()
	clearCacheOnError ()
	addErrorFlashMessage ()
string	getErrorFlashMessage ()
	forwardToReferringRequest ()
string	getFlattenedValidationErrorMessage ()
TYPO3 CMS Extbase Mvc Controller ControllerContext	buildControllerContext ()
	redirect ($actionName, $controllerName=null, $extensionName=null, array $arguments=null, $pageUid=null, $delay=0, $statusCode=303)
	redirectToUri ($uri, $delay=0, $statusCode=303)
string	addBaseUriIfNecessary ($uri)
	mapRequestArgumentsToControllerArguments ()

Protected Attributes
RedirectHandler	$redirectHandler
string	$loginType = ''
string	$redirectUrl = ''
ServerRequestHandler	$requestHandler
UserService	$userService
RedirectConfiguration	$configuration
EventDispatcherInterface	$eventDispatcher
UserAspect	$userAspect
bool	$showCookieWarning = false
‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
TYPO3 CMS Extbase Reflection ReflectionService	$reflectionService
TYPO3 CMS Extbase Service CacheService	$cacheService
HashService	$hashService
ViewInterface	$view
string	$defaultViewObjectName = \TYPO3\CMS\Fluid\View\TemplateView::class
string	$actionMethodName = 'indexAction'
string	$errorMethodName = 'errorAction'
TYPO3 CMS Extbase Mvc Controller MvcPropertyMappingConfigurationService	$mvcPropertyMappingConfigurationService
EventDispatcherInterface	$eventDispatcher
TYPO3 CMS Extbase Mvc Request	$request
TYPO3 CMS Extbase Mvc Response	$response
TYPO3 CMS Extbase SignalSlot Dispatcher	$signalSlotDispatcher
TYPO3 CMS Extbase Object ObjectManagerInterface	$objectManager
TYPO3 CMS Extbase Mvc Web Routing UriBuilder	$uriBuilder
array	$settings
TYPO3 CMS Extbase Validation ValidatorResolver	$validatorResolver
TYPO3 CMS Extbase Mvc Controller Arguments	$arguments
array	$supportedRequestTypes = array( Request::class )
TYPO3 CMS Extbase Mvc Controller ControllerContext	$controllerContext
ConfigurationManagerInterface	$configurationManager

Detailed Description

Used for plugin login

Definition at line 39 of file LoginController.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\FrontendLogin\Controller\LoginController::__construct	(	RedirectHandler	$redirectHandler,
		ServerRequestHandler	$requestHandler,
		UserService	$userService,
		EventDispatcherInterface	$eventDispatcher
	)

Definition at line 92 of file LoginController.php.

References TYPO3\CMS\FrontendLogin\Controller\LoginController\$eventDispatcher, TYPO3\CMS\FrontendLogin\Controller\LoginController\$redirectHandler, TYPO3\CMS\FrontendLogin\Controller\LoginController\$requestHandler, and TYPO3\CMS\FrontendLogin\Controller\LoginController\$userService.

Member Function Documentation

getPermaloginStatus()

int TYPO3\CMS\FrontendLogin\Controller\LoginController::getPermaloginStatus ( )

protected

The permanent login checkbox should only be shown if permalogin is not deactivated (-1), not forced to be always active (2) and lifetime is greater than 0

Returns

‪int

Definition at line 231 of file LoginController.php.

References $GLOBALS, and TYPO3\CMS\FrontendLogin\Controller\LoginController\isPermaloginDisabled().

Referenced by TYPO3\CMS\FrontendLogin\Controller\LoginController\loginAction().

getStatusMessageKey()

string TYPO3\CMS\FrontendLogin\Controller\LoginController::getStatusMessageKey ( )

protected

Return message key based on user login status

Returns

‪string

Definition at line 262 of file LoginController.php.

References TYPO3\CMS\FrontendLogin\Controller\LoginController\hasLoginErrorOccurred(), TYPO3\CMS\Core\Authentication\LoginType\LOGOUT, TYPO3\CMS\FrontendLogin\Controller\LoginController\MESSAGEKEY_DEFAULT, TYPO3\CMS\FrontendLogin\Controller\LoginController\MESSAGEKEY_ERROR, and TYPO3\CMS\FrontendLogin\Controller\LoginController\MESSAGEKEY_LOGOUT.

Referenced by TYPO3\CMS\FrontendLogin\Controller\LoginController\loginAction().

handleLoginForwards()

TYPO3\CMS\FrontendLogin\Controller\LoginController::handleLoginForwards ( )

protected

Handle forwards to overview and logout actions from login action

Definition at line 214 of file LoginController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\ActionController\forward(), and TYPO3\CMS\FrontendLogin\Controller\LoginController\shouldRedirectToOverview().

Referenced by TYPO3\CMS\FrontendLogin\Controller\LoginController\loginAction().

handleRedirect()

TYPO3\CMS\FrontendLogin\Controller\LoginController::handleRedirect ( )

protected

Handles the redirect when $this->redirectUrl is not empty

Definition at line 203 of file LoginController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\ActionController\redirectToUri().

Referenced by TYPO3\CMS\FrontendLogin\Controller\LoginController\loginAction(), TYPO3\CMS\FrontendLogin\Controller\LoginController\logoutAction(), and TYPO3\CMS\FrontendLogin\Controller\LoginController\overviewAction().

hasLoginErrorOccurred()

TYPO3\CMS\FrontendLogin\Controller\LoginController::hasLoginErrorOccurred ( )

protected

Definition at line 297 of file LoginController.php.

References TYPO3\CMS\Core\Authentication\LoginType\LOGIN.

Referenced by TYPO3\CMS\FrontendLogin\Controller\LoginController\getStatusMessageKey(), and TYPO3\CMS\FrontendLogin\Controller\LoginController\loginAction().

initializeAction()

TYPO3\CMS\FrontendLogin\Controller\LoginController::initializeAction

(

)

Initialize redirects

Reimplemented from TYPO3\CMS\Extbase\Mvc\Controller\ActionController.

Definition at line 108 of file LoginController.php.

References TYPO3\CMS\FrontendLogin\Configuration\RedirectConfiguration\fromSettings(), TYPO3\CMS\FrontendLogin\Controller\LoginController\isLoginOrLogoutInProgress(), and TYPO3\CMS\FrontendLogin\Controller\LoginController\isRedirectDisabled().

isLoginOrLogoutInProgress()

TYPO3\CMS\FrontendLogin\Controller\LoginController::isLoginOrLogoutInProgress ( )

protected

Definition at line 274 of file LoginController.php.

References TYPO3\CMS\Core\Authentication\LoginType\LOGIN, and TYPO3\CMS\Core\Authentication\LoginType\LOGOUT.

Referenced by TYPO3\CMS\FrontendLogin\Controller\LoginController\initializeAction().

isLogoutSuccessful()

TYPO3\CMS\FrontendLogin\Controller\LoginController::isLogoutSuccessful ( )

protected

Definition at line 292 of file LoginController.php.

References TYPO3\CMS\Core\Authentication\LoginType\LOGOUT.

Referenced by TYPO3\CMS\FrontendLogin\Controller\LoginController\loginAction().

isPermaloginDisabled()

TYPO3\CMS\FrontendLogin\Controller\LoginController::isPermaloginDisabled ( int  $permaLogin )

protected

Definition at line 238 of file LoginController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\FrontendLogin\Controller\LoginController\getPermaloginStatus().

isRedirectDisabled()

bool TYPO3\CMS\FrontendLogin\Controller\LoginController::isRedirectDisabled

(

)

Is redirect disabled by setting or noredirect parameter

Returns

‪bool

Definition at line 284 of file LoginController.php.

Referenced by TYPO3\CMS\FrontendLogin\Controller\LoginController\initializeAction(), and TYPO3\CMS\FrontendLogin\Controller\LoginController\logoutAction().

loginAction()

TYPO3\CMS\FrontendLogin\Controller\LoginController::loginAction

(

)

Show login form

Definition at line 130 of file LoginController.php.

References TYPO3\CMS\FrontendLogin\Controller\LoginController\getPermaloginStatus(), TYPO3\CMS\FrontendLogin\Controller\AbstractLoginFormController\getSignedStorageFolders(), TYPO3\CMS\FrontendLogin\Controller\LoginController\getStatusMessageKey(), TYPO3\CMS\FrontendLogin\Controller\AbstractLoginFormController\getStorageFolders(), TYPO3\CMS\FrontendLogin\Controller\LoginController\handleLoginForwards(), TYPO3\CMS\FrontendLogin\Controller\LoginController\handleRedirect(), TYPO3\CMS\FrontendLogin\Controller\LoginController\hasLoginErrorOccurred(), TYPO3\CMS\FrontendLogin\Controller\LoginController\isLogoutSuccessful(), and TYPO3\CMS\FrontendLogin\Controller\AbstractLoginFormController\shallEnforceLoginSigning().

logoutAction()

TYPO3\CMS\FrontendLogin\Controller\LoginController::logoutAction

(

int

$redirectPageLogout = 0

)

Show logout form

Parameters

int

$redirectPageLogout

Definition at line 185 of file LoginController.php.

References TYPO3\CMS\FrontendLogin\Controller\AbstractLoginFormController\getStorageFolders(), TYPO3\CMS\FrontendLogin\Controller\LoginController\handleRedirect(), and TYPO3\CMS\FrontendLogin\Controller\LoginController\isRedirectDisabled().

overviewAction()

TYPO3\CMS\FrontendLogin\Controller\LoginController::overviewAction

(

bool

$showLoginMessage = false

)

User overview for logged in users

Parameters

bool

$showLoginMessage

Exceptions

StopActionException

Definition at line 163 of file LoginController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\ActionController\forward(), and TYPO3\CMS\FrontendLogin\Controller\LoginController\handleRedirect().

shouldRedirectToOverview()

bool TYPO3\CMS\FrontendLogin\Controller\LoginController::shouldRedirectToOverview ( )

protected

Redirect to overview on login successful and setting showLogoutFormAfterLogin disabled

Returns

‪bool

Definition at line 250 of file LoginController.php.

References TYPO3\CMS\Core\Authentication\LoginType\LOGIN.

Referenced by TYPO3\CMS\FrontendLogin\Controller\LoginController\handleLoginForwards().

Member Data Documentation

$configuration

RedirectConfiguration TYPO3\CMS\FrontendLogin\Controller\LoginController::$configuration

protected

Definition at line 78 of file LoginController.php.

$eventDispatcher

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

protected

Definition at line 82 of file LoginController.php.

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

$loginType

string TYPO3\CMS\FrontendLogin\Controller\LoginController::$loginType = ''

protected

Definition at line 62 of file LoginController.php.

$redirectHandler

RedirectHandler TYPO3\CMS\FrontendLogin\Controller\LoginController::$redirectHandler

protected

Definition at line 58 of file LoginController.php.

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

$redirectUrl

string TYPO3\CMS\FrontendLogin\Controller\LoginController::$redirectUrl = ''

protected

Definition at line 66 of file LoginController.php.

$requestHandler

ServerRequestHandler TYPO3\CMS\FrontendLogin\Controller\LoginController::$requestHandler

protected

Definition at line 70 of file LoginController.php.

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

$showCookieWarning

bool TYPO3\CMS\FrontendLogin\Controller\LoginController::$showCookieWarning = false

protected

Definition at line 90 of file LoginController.php.

$userAspect

UserAspect TYPO3\CMS\FrontendLogin\Controller\LoginController::$userAspect

protected

Definition at line 86 of file LoginController.php.

$userService

UserService TYPO3\CMS\FrontendLogin\Controller\LoginController::$userService

protected

Definition at line 74 of file LoginController.php.

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

MESSAGEKEY_DEFAULT

const TYPO3\CMS\FrontendLogin\Controller\LoginController::MESSAGEKEY_DEFAULT = 'welcome'

Definition at line 44 of file LoginController.php.

Referenced by TYPO3\CMS\FrontendLogin\Controller\LoginController\getStatusMessageKey().

MESSAGEKEY_ERROR

const TYPO3\CMS\FrontendLogin\Controller\LoginController::MESSAGEKEY_ERROR = 'error'

Definition at line 49 of file LoginController.php.

Referenced by TYPO3\CMS\FrontendLogin\Controller\LoginController\getStatusMessageKey().

MESSAGEKEY_LOGOUT

const TYPO3\CMS\FrontendLogin\Controller\LoginController::MESSAGEKEY_LOGOUT = 'logout'

Definition at line 54 of file LoginController.php.

Referenced by TYPO3\CMS\FrontendLogin\Controller\LoginController\getStatusMessageKey().