TYPO3 CMS  TYPO3_7-6
Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Install\Controller\AbstractController Class Reference
Inheritance diagram for TYPO3\CMS\Install\Controller\AbstractController:
TYPO3\CMS\Install\Controller\AjaxController TYPO3\CMS\Install\Controller\StepController TYPO3\CMS\Install\Controller\ToolController

Protected Member Functions

 checkSessionLifetime ()
 
 outputLoginFormIfNotAuthorized ()
 
 addSessionMessages (array $messages)
 
 isDbalEnabled ()
 
 validateAuthenticationAction ($action)
 
 getAction ()
 
 getPostValues ()
 
 redirect ($controller='', $action='')
 
 output ($content='')
 
 getSenderEmailAddress ()
 
 getSenderEmailName ()
 

Protected Attributes

 $objectManager = null
 
 $session = null
 
 $authenticationActions = []
 

Detailed Description

Controller abstract for shared parts of Tool, Step and Ajax controller

Definition at line 24 of file AbstractController.php.

Member Function Documentation

◆ addSessionMessages()

TYPO3\CMS\Install\Controller\AbstractController::addSessionMessages ( array  $messages)
protected

Add status messages to session. Used to output messages between requests, especially in step controller

Parameters
array<

Definition at line 401 of file AbstractController.php.

References $GLOBALS, TYPO3\CMS\Install\Controller\AbstractController\$objectManager, TYPO3\CMS\Install\Controller\AbstractController\isDbalEnabled(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Install\Controller\StepController\executeSpecificStep().

◆ checkSessionLifetime()

TYPO3\CMS\Install\Controller\AbstractController::checkSessionLifetime ( )
protected

Check if session expired.

Returns
void

Definition at line 165 of file AbstractController.php.

References $GLOBALS, TYPO3\CMS\Install\Controller\AbstractController\getAction(), TYPO3\CMS\Install\Controller\AbstractController\getPostValues(), TYPO3\CMS\Saltedpasswords\Salt\SaltFactory\getSaltingInstance(), TYPO3\CMS\Install\Controller\AbstractController\output(), and TYPO3\CMS\Install\Controller\AbstractController\redirect().

Referenced by TYPO3\CMS\Install\Controller\StepController\execute(), TYPO3\CMS\Install\Controller\ToolController\execute(), and TYPO3\CMS\Install\Controller\AjaxController\execute().

◆ getAction()

TYPO3\CMS\Install\Controller\AbstractController::getAction ( )
protected

Retrieve parameter from GET or POST and sanitize

Exceptions
Exception
Returns
string Empty string if no action is given or sanitized action string

Definition at line 490 of file AbstractController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\_GP().

Referenced by TYPO3\CMS\Install\Controller\AbstractController\checkSessionLifetime(), TYPO3\CMS\Install\Controller\ToolController\execute(), TYPO3\CMS\Install\Controller\StepController\executeSpecificStep(), TYPO3\CMS\Install\Controller\ToolController\getLastError(), TYPO3\CMS\Install\Controller\AjaxController\handleSessionLifeTimeExpired(), TYPO3\CMS\Install\Controller\AbstractController\outputLoginFormIfNotAuthorized(), and TYPO3\CMS\Install\Controller\StepController\outputSpecificStep().

◆ getPostValues()

TYPO3\CMS\Install\Controller\AbstractController::getPostValues ( )
protected

Get POST form values of install tool. All POST data is secured by form token protection, except in very installation step.

Returns
array

Definition at line 517 of file AbstractController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\_POST().

Referenced by TYPO3\CMS\Install\Controller\AbstractController\checkSessionLifetime(), TYPO3\CMS\Install\Controller\StepController\executeSpecificStep(), TYPO3\CMS\Install\Controller\ToolController\getLastError(), TYPO3\CMS\Install\Controller\AjaxController\handleSessionLifeTimeExpired(), TYPO3\CMS\Install\Controller\StepController\outputSpecificStep(), and TYPO3\CMS\Install\Controller\StepController\redirectToTool().

◆ getSenderEmailAddress()

TYPO3\CMS\Install\Controller\AbstractController::getSenderEmailAddress ( )
protected

Get sender address from configuration ['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'] If this setting is empty fall back to 'no-re.nosp@m.ply@.nosp@m.examp.nosp@m.le.c.nosp@m.om'

Returns
string Returns an email address

Definition at line 610 of file AbstractController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Install\Controller\AbstractController\outputLoginFormIfNotAuthorized().

◆ getSenderEmailName()

TYPO3\CMS\Install\Controller\AbstractController::getSenderEmailName ( )
protected

Gets sender name from configuration ['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'] If this setting is empty, it falls back to a default string.

Returns
string

Definition at line 624 of file AbstractController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Install\Controller\AbstractController\outputLoginFormIfNotAuthorized().

◆ isDbalEnabled()

TYPO3\CMS\Install\Controller\AbstractController::isDbalEnabled ( )
protected

Return TRUE if dbal and adodb extension is loaded.

Returns
bool TRUE if dbal and adodb is loaded

Definition at line 458 of file AbstractController.php.

Referenced by TYPO3\CMS\Install\Controller\AbstractController\addSessionMessages().

◆ output()

TYPO3\CMS\Install\Controller\AbstractController::output (   $content = '')
protected

Output content. WARNING: This exits the script execution!

Parameters
string$contentContent to output

Definition at line 594 of file AbstractController.php.

Referenced by TYPO3\CMS\Install\Controller\AbstractController\checkSessionLifetime(), TYPO3\CMS\Install\Controller\ToolController\getLastError(), TYPO3\CMS\Install\Controller\AbstractController\outputLoginFormIfNotAuthorized(), TYPO3\CMS\Install\Controller\StepController\outputSpecificStep(), and TYPO3\CMS\Install\Controller\StepController\redirectToTool().

◆ outputLoginFormIfNotAuthorized()

TYPO3\CMS\Install\Controller\AbstractController::outputLoginFormIfNotAuthorized ( )
protected

Show login for if user is not authorized yet and if not in first installation process.

Returns
void

Definition at line 271 of file AbstractController.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Core\FormProtection\FormProtectionFactory\get(), TYPO3\CMS\Install\Controller\AbstractController\getAction(), TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\Install\Controller\AbstractController\getSenderEmailAddress(), TYPO3\CMS\Install\Controller\AbstractController\getSenderEmailName(), and TYPO3\CMS\Install\Controller\AbstractController\output().

Referenced by TYPO3\CMS\Install\Controller\StepController\execute(), and TYPO3\CMS\Install\Controller\ToolController\execute().

◆ redirect()

TYPO3\CMS\Install\Controller\AbstractController::redirect (   $controller = '',
  $action = '' 
)
protected

HTTP redirect to self, preserving allowed GET variables. WARNING: This exits the script execution!

Parameters
string$controllerCan be set to 'tool' to redirect from step to tool controller
string$actionSet specific action for next request, used in step controller to specify next step
Returns
void

Definition at line 534 of file AbstractController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), and TYPO3\CMS\Core\Utility\HttpUtility\redirect().

Referenced by TYPO3\CMS\Install\Controller\AbstractController\checkSessionLifetime(), TYPO3\CMS\Install\Controller\ToolController\execute(), TYPO3\CMS\Install\Controller\StepController\executeSpecificStep(), TYPO3\CMS\Install\Controller\StepController\outputSpecificStep(), and TYPO3\CMS\Install\Controller\StepController\redirectToTool().

◆ validateAuthenticationAction()

TYPO3\CMS\Install\Controller\AbstractController::validateAuthenticationAction (   $action)
protected

Check given action name is one of the allowed actions.

Parameters
string$actionGiven action to validate
Exceptions
Exception

Definition at line 474 of file AbstractController.php.

Referenced by TYPO3\CMS\Install\Controller\ToolController\getLastError(), TYPO3\CMS\Install\Controller\AjaxController\handleSessionLifeTimeExpired(), and TYPO3\CMS\Install\Controller\StepController\outputSpecificStep().

Member Data Documentation

◆ $authenticationActions

TYPO3\CMS\Install\Controller\AbstractController::$authenticationActions = []
protected

Definition at line 39 of file AbstractController.php.

◆ $objectManager

TYPO3\CMS\Install\Controller\AbstractController::$objectManager = null
protected

Definition at line 29 of file AbstractController.php.

Referenced by TYPO3\CMS\Install\Controller\AbstractController\addSessionMessages().

◆ $session

TYPO3\CMS\Install\Controller\AbstractController::$session = null
protected

Definition at line 34 of file AbstractController.php.