‪TYPO3CMS  ‪main
TYPO3\CMS\FrontendLogin\Controller\LoginController Class Reference
Inheritance diagram for TYPO3\CMS\FrontendLogin\Controller\LoginController:
TYPO3\CMS\Extbase\Mvc\Controller\ActionController TYPO3\CMS\Extbase\Mvc\Controller\ControllerInterface

Public Member Functions

 __construct (protected readonly RedirectHandler $redirectHandler, protected readonly Context $context, protected readonly PageRepository $pageRepository)
 
 initializeAction ()
 
 loginAction ()
 
 overviewAction (bool $showLoginMessage=false)
 
 logoutAction (int $redirectPageLogout=0)
 
 isRedirectDisabled ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 injectResponseFactory (ResponseFactoryInterface $responseFactory)
 
 injectStreamFactory (StreamFactoryInterface $streamFactory)
 
 injectConfigurationManager (ConfigurationManagerInterface $configurationManager)
 
 injectValidatorResolver (ValidatorResolver $validatorResolver)
 
 injectViewResolver (ViewResolverInterface $viewResolver)
 
 injectReflectionService (ReflectionService $reflectionService)
 
 injectHashService (HashService $hashService)
 
 injectMvcPropertyMappingConfigurationService (MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService)
 
 injectEventDispatcher (EventDispatcherInterface $eventDispatcher)
 
 injectPropertyMapper (PropertyMapper $propertyMapper)
 
 injectInternalFlashMessageService (FlashMessageService $flashMessageService)
 
 injectInternalExtensionService (ExtensionService $extensionService)
 
 initializeControllerArgumentsBaseValidators ()
 
 processRequest (RequestInterface $request)
 
 addFlashMessage (string $messageBody, string $messageTitle='', ContextualFeedbackSeverity $severity=ContextualFeedbackSeverity::OK, bool $storeInSession=true)
 
 throwStatus (int $statusCode, string $statusMessage='', ?string $content=null)
 

Public Attributes

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

Protected Member Functions

 handleRedirect ()
 
 handleLoginForwards ()
 
 getPermaloginStatus ()
 
 isPermaloginDisabled (int $permaLogin)
 
 shouldRedirectToOverview ()
 
 getStatusMessageKey ()
 
 isLoginOrLogoutInProgress ()
 
 isLogoutSuccessful ()
 
 hasLoginErrorOccurred ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 initializeActionMethodArguments ()
 
 initializeActionMethodValidators ()
 
 renderAssetsForRequest (RequestInterface $request)
 
 resolveActionMethodName ()
 
 callActionMethod (RequestInterface $request)
 
 resolveView ()
 
 setViewConfiguration (ViewInterface $view)
 
 errorAction ()
 
 addErrorFlashMessage ()
 
 getErrorFlashMessage ()
 
 forwardToReferringRequest ()
 
 getFlattenedValidationErrorMessage ()
 
 getFlashMessageQueue (string $identifier=null)
 
 redirect (?string $actionName, ?string $controllerName=null, ?string $extensionName=null, ?array $arguments=null, ?int $pageUid=null, $_=null, int $statusCode=303)
 
 redirectToUri (string|UriInterface $uri, $_=null, int $statusCode=303)
 
 addBaseUriIfNecessary (string $uri)
 
 mapRequestArgumentsToControllerArguments ()
 
 htmlResponse (string $html=null)
 
 jsonResponse (string $json=null)
 

Protected Attributes

string $loginType = ''
 
string $redirectUrl = ''
 
RedirectConfiguration $configuration
 
UserAspect $userAspect
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
ResponseFactoryInterface $responseFactory
 
StreamFactoryInterface $streamFactory
 
HashService $hashService
 
ReflectionService $reflectionService
 
ViewInterface $view
 
string $defaultViewObjectName = TemplateView::class
 
string $actionMethodName = 'indexAction'
 
string $errorMethodName = 'errorAction'
 
MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService
 
EventDispatcherInterface $eventDispatcher
 
RequestInterface $request
 
UriBuilder $uriBuilder
 
array $settings
 
ValidatorResolver $validatorResolver
 
Arguments $arguments
 
ConfigurationManagerInterface $configurationManager
 

Detailed Description

Used for plugin login

this is a concrete TYPO3 implementation and solely used for EXT:felogin and not part of TYPO3's Core API.

Definition at line 42 of file LoginController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\FrontendLogin\Controller\LoginController::__construct ( protected readonly RedirectHandler  $redirectHandler,
protected readonly Context  $context,
protected readonly PageRepository  $pageRepository 
)

Definition at line 53 of file LoginController.php.

Member Function Documentation

◆ getPermaloginStatus()

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

Definition at line 198 of file LoginController.php.

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

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

◆ getStatusMessageKey()

◆ handleLoginForwards()

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

Handle forwards to overview and logout actions from login action

Definition at line 181 of file LoginController.php.

References TYPO3\CMS\FrontendLogin\Controller\LoginController\shouldRedirectToOverview().

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

◆ handleRedirect()

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

◆ hasLoginErrorOccurred()

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

◆ initializeAction()

◆ isLoginOrLogoutInProgress()

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

◆ isLogoutSuccessful()

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

◆ isPermaloginDisabled()

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

◆ isRedirectDisabled()

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

Is redirect disabled by setting or noredirect parameter

Definition at line 246 of file LoginController.php.

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

◆ loginAction()

◆ logoutAction()

TYPO3\CMS\FrontendLogin\Controller\LoginController::logoutAction ( int  $redirectPageLogout = 0)

◆ overviewAction()

TYPO3\CMS\FrontendLogin\Controller\LoginController::overviewAction ( bool  $showLoginMessage = false)

◆ shouldRedirectToOverview()

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

Redirect to overview on login successful and setting showLogoutFormAfterLogin disabled

Definition at line 215 of file LoginController.php.

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

Member Data Documentation

◆ $configuration

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

Definition at line 50 of file LoginController.php.

◆ $loginType

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

Definition at line 48 of file LoginController.php.

◆ $redirectUrl

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

Definition at line 49 of file LoginController.php.

◆ $userAspect

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

Definition at line 51 of file LoginController.php.

◆ MESSAGEKEY_DEFAULT

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

◆ MESSAGEKEY_ERROR

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

◆ MESSAGEKEY_LOGOUT

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