Public Member Functions
	__construct (EventDispatcherInterface $eventDispatcher)

ResponseInterface	mainAction (ServerRequestInterface $request)

string	renderLanguageSelect ()

string	renderStartModuleSelect ()

Public Attributes
const	PASSWORD_NOT_UPDATED = 0

const	PASSWORD_UPDATED = 1

const	PASSWORD_NOT_THE_SAME = 2

const	PASSWORD_OLD_WRONG = 3

Protected Member Functions
	processAdditionalJavaScriptModules (PageRenderer $pageRenderer)

	initialize ()

	storeIncomingData (array $postData)

string	getJavaScript ()

	buildInstructionDataTag (string $dispatchAction)

	getButtons ()

array	renderUserSetup ()

bool	checkAccess (array $config)

string	getLabel ($str, $key='', $addLabelTag=true)

string	getCSH ($str, $label, $fieldName)

string[]	getFieldsFromShowItem ()

int	getAvatarFileUid ($beUserId)

	setAvatarFileUid ($beUserId, $fileUid, array &$storeRec)

BackendUserAuthentication	getBackendUser ()

LanguageService	getLanguageService ()

	addFlashMessages ()

	enqueueFlashMessages (array $flashMessages)

FlashMessage	getFlashMessage ($message, $title, $severity=FlashMessage::OK)

Protected Attributes
string	$content

array	$overrideConf

bool	$languageUpdate

bool	$pagetreeNeedsRefresh = false

array	$tsFieldConf

bool	$saveData = false

int	$passwordIsUpdated = self::PASSWORD_NOT_UPDATED

bool	$passwordIsSubmitted = false

bool	$setupIsUpdated = false

bool	$settingsAreResetToDefault = false

TYPO3 CMS Core FormProtection BackendFormProtection	$formProtection

string	$moduleName = 'user_setup'

ModuleTemplate	$moduleTemplate

EventDispatcherInterface	$eventDispatcher

Detailed Description

Script class for the Setup module

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

Definition at line 54 of file SetupModuleController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Setup\Controller\SetupModuleController::__construct ( EventDispatcherInterface $eventDispatcher )

Instantiate the form protection before a simulated user is initialized.

Parameters

EventDispatcherInterface $eventDispatcher

Definition at line 145 of file SetupModuleController.php.

References TYPO3\CMS\Setup\Controller\SetupModuleController\$eventDispatcher, TYPO3\CMS\Core\FormProtection\FormProtectionFactory\get(), TYPO3\CMS\Setup\Controller\SetupModuleController\getLanguageService(), and TYPO3\CMS\Setup\Controller\SetupModuleController\processAdditionalJavaScriptModules().

Member Function Documentation

◆ addFlashMessages()

TYPO3\CMS\Setup\Controller\SetupModuleController::addFlashMessages ( )

protected

Add FlashMessages for various actions

Definition at line 998 of file SetupModuleController.php.

References TYPO3\CMS\Setup\Controller\SetupModuleController\enqueueFlashMessages(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Setup\Controller\SetupModuleController\getFlashMessage(), TYPO3\CMS\Core\Messaging\AbstractMessage\INFO, TYPO3\CMS\Setup\Controller\SetupModuleController\PASSWORD_NOT_THE_SAME, TYPO3\CMS\Setup\Controller\SetupModuleController\PASSWORD_OLD_WRONG, and TYPO3\CMS\Setup\Controller\SetupModuleController\PASSWORD_UPDATED.

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\mainAction().

◆ buildInstructionDataTag()

TYPO3\CMS\Setup\Controller\SetupModuleController::buildInstructionDataTag ( string $dispatchAction )

protected

Definition at line 391 of file SetupModuleController.php.

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\mainAction().

◆ checkAccess()

bool TYPO3\CMS\Setup\Controller\SetupModuleController::checkAccess ( array $config )

protected

Returns access check (currently only "admin" is supported)

Parameters

array $config ‪Configuration of the field, access mode is defined in key 'access'

Returns: ‪bool Whether it is allowed to modify the given field

Definition at line 747 of file SetupModuleController.php.

References $GLOBALS, TYPO3\CMS\Setup\Controller\SetupModuleController\getBackendUser(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\isAdmin().

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\renderUserSetup(), and TYPO3\CMS\Setup\Controller\SetupModuleController\storeIncomingData().

◆ enqueueFlashMessages()

TYPO3\CMS\Setup\Controller\SetupModuleController::enqueueFlashMessages ( array $flashMessages )

protected

Parameters

array $flashMessages

Exceptions

Definition at line 1040 of file SetupModuleController.php.

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\addFlashMessages().

◆ getAvatarFileUid()

int TYPO3\CMS\Setup\Controller\SetupModuleController::getAvatarFileUid ( $beUserId )

protected

Get Avatar fileUid

Parameters

int $beUserId

Returns: ‪int

Definition at line 867 of file SetupModuleController.php.

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\renderUserSetup(), and TYPO3\CMS\Setup\Controller\SetupModuleController\setAvatarFileUid().

◆ getBackendUser()

BackendUserAuthentication TYPO3\CMS\Setup\Controller\SetupModuleController::getBackendUser ( )

protected

Returns the current BE user.

Returns: ‪BackendUserAuthentication

Definition at line 982 of file SetupModuleController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\checkAccess(), TYPO3\CMS\Setup\Controller\SetupModuleController\getFieldsFromShowItem(), TYPO3\CMS\Setup\Controller\SetupModuleController\initialize(), TYPO3\CMS\Setup\Controller\SetupModuleController\renderLanguageSelect(), TYPO3\CMS\Setup\Controller\SetupModuleController\renderStartModuleSelect(), TYPO3\CMS\Setup\Controller\SetupModuleController\renderUserSetup(), and TYPO3\CMS\Setup\Controller\SetupModuleController\storeIncomingData().

◆ getButtons()

TYPO3\CMS\Setup\Controller\SetupModuleController::getButtons ( )

protected

Create the panel of buttons for submitting the form or otherwise perform operations.

Definition at line 402 of file SetupModuleController.php.

References TYPO3\CMS\Setup\Controller\SetupModuleController\getLanguageService(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\mainAction().

◆ getCSH()

string TYPO3\CMS\Setup\Controller\SetupModuleController::getCSH	(	$str,
		$label,
		$fieldName
	)

protected

Returns the CSH Icon for given string

Parameters

string	$str	‪Locallang key
string	$label	‪The label to be used, that should be wrapped in help
string	$fieldName	‪field name

Returns: ‪string HTML output.

Definition at line 797 of file SetupModuleController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\wrapInHelp().

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\renderUserSetup().

◆ getFieldsFromShowItem()

string [] TYPO3\CMS\Setup\Controller\SetupModuleController::getFieldsFromShowItem ( )

protected

Returns array with fields defined in $GLOBALS['TYPO3_USER_SETTINGS']['showitem'] Remove fields which are disabled by user TSconfig

Returns: ‪string[] Array with field names visible in form

Definition at line 818 of file SetupModuleController.php.

References $GLOBALS, TYPO3\CMS\Setup\Controller\SetupModuleController\getBackendUser(), if, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\renderUserSetup(), and TYPO3\CMS\Setup\Controller\SetupModuleController\storeIncomingData().

◆ getFlashMessage()

FlashMessage TYPO3\CMS\Setup\Controller\SetupModuleController::getFlashMessage	(	$message,
		$title,
		$severity = `FlashMessage::OK`
	)

protected

Parameters

string	$message
string	$title
int	$severity

Returns: ‪FlashMessage

Definition at line 1055 of file SetupModuleController.php.

References TYPO3\CMS\Setup\Controller\SetupModuleController\getLanguageService(), and TYPO3\CMS\Core\Localization\LanguageService\getLL().

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\addFlashMessages().

◆ getJavaScript()

string TYPO3\CMS\Setup\Controller\SetupModuleController::getJavaScript ( )

protected

Generate necessary JavaScript

Returns: ‪string

Definition at line 331 of file SetupModuleController.php.

References $GLOBALS.

◆ getLabel()

string TYPO3\CMS\Setup\Controller\SetupModuleController::getLabel	(	$str,
		$key = `''`,
		$addLabelTag = `true`
	)

protected

Returns the label $str from getLL() and grays out the value if the $str/$key is found in $this->overrideConf array

Parameters

string	$str	‪Locallang key
string	$key	‪Alternative override-config key
bool	$addLabelTag	‪Defines whether the string should be wrapped in a <label> tag.

Returns: ‪string HTML output.

Definition at line 773 of file SetupModuleController.php.

References TYPO3\CMS\Setup\Controller\SetupModuleController\getLanguageService().

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\renderUserSetup().

◆ getLanguageService()

LanguageService TYPO3\CMS\Setup\Controller\SetupModuleController::getLanguageService ( )

protected

Returns: ‪LanguageService

Definition at line 990 of file SetupModuleController.php.

References $GLOBALS.

◆ initialize()

TYPO3\CMS\Setup\Controller\SetupModuleController::initialize ( )

protected

Initializes the module for display of the settings form.

Definition at line 175 of file SetupModuleController.php.

References TYPO3\CMS\Setup\Controller\SetupModuleController\getBackendUser(), TYPO3\CMS\Setup\Controller\SetupModuleController\getLanguageService(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getTSConfig(), and TYPO3\CMS\Core\Localization\LanguageService\includeLLFile().

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\mainAction().

◆ mainAction()

ResponseInterface TYPO3\CMS\Setup\Controller\SetupModuleController::mainAction ( ServerRequestInterface $request )

Injects the request object, checks if data should be saved, and prepares a HTML page

Parameters

ServerRequestInterface $request ‪the current request

Returns: ‪ResponseInterface the response with the content

Definition at line 347 of file SetupModuleController.php.

References TYPO3\CMS\Setup\Controller\SetupModuleController\addFlashMessages(), TYPO3\CMS\Setup\Controller\SetupModuleController\buildInstructionDataTag(), TYPO3\CMS\Setup\Controller\SetupModuleController\getButtons(), TYPO3\CMS\Setup\Controller\SetupModuleController\getLanguageService(), TYPO3\CMS\Core\Localization\LanguageService\getLL(), TYPO3\CMS\Setup\Controller\SetupModuleController\initialize(), TYPO3\CMS\Setup\Controller\SetupModuleController\renderUserSetup(), TYPO3\CMS\Backend\Utility\BackendUtility\setUpdateSignal(), and TYPO3\CMS\Setup\Controller\SetupModuleController\storeIncomingData().

◆ processAdditionalJavaScriptModules()

TYPO3\CMS\Setup\Controller\SetupModuleController::processAdditionalJavaScriptModules ( PageRenderer $pageRenderer )

protected

Definition at line 162 of file SetupModuleController.php.

References TYPO3\CMS\Setup\Controller\SetupModuleController\$moduleName, and TYPO3\CMS\Core\Page\PageRenderer\loadRequireJsModule().

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\__construct().

◆ renderLanguageSelect()

string TYPO3\CMS\Setup\Controller\SetupModuleController::renderLanguageSelect ( )

Return a select with available languages. This method is called from the setup module fake TCA userFunc.

Returns: ‪string Complete select as HTML string or warning box if something went wrong.

Definition at line 664 of file SetupModuleController.php.

References $GLOBALS, $locales, TYPO3\CMS\Setup\Controller\SetupModuleController\getBackendUser(), TYPO3\CMS\Core\Core\Environment\getLabelsPath(), and TYPO3\CMS\Setup\Controller\SetupModuleController\getLanguageService().

◆ renderStartModuleSelect()

string TYPO3\CMS\Setup\Controller\SetupModuleController::renderStartModuleSelect ( )

Returns a select with all modules for startup. This method is called from the setup module fake TCA userFunc.

Returns: ‪string Complete select as HTML string

Definition at line 709 of file SetupModuleController.php.

References $GLOBALS, TYPO3\CMS\Setup\Controller\SetupModuleController\getBackendUser(), and TYPO3\CMS\Setup\Controller\SetupModuleController\getLanguageService().

◆ renderUserSetup()

array TYPO3\CMS\Setup\Controller\SetupModuleController::renderUserSetup ( )

protected

renders the data for all tabs in the user setup and returns everything that is needed with tabs and dyntab menu

Returns: ‪array Ready to use for the dyntabmenu itemarray

Deprecated:: ‪Will be removed in TYPO3 v12.0

Deprecated:: ‪Will be removed in TYPO3 v12.0

Definition at line 436 of file SetupModuleController.php.

References $GLOBALS, TYPO3\CMS\Setup\Controller\SetupModuleController\checkAccess(), TYPO3\CMS\Setup\Controller\SetupModuleController\getAvatarFileUid(), TYPO3\CMS\Setup\Controller\SetupModuleController\getBackendUser(), TYPO3\CMS\Setup\Controller\SetupModuleController\getCSH(), TYPO3\CMS\Setup\Controller\SetupModuleController\getFieldsFromShowItem(), TYPO3\CMS\Setup\Controller\SetupModuleController\getLabel(), TYPO3\CMS\Setup\Controller\SetupModuleController\getLanguageService(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\mainAction().

◆ setAvatarFileUid()

TYPO3\CMS\Setup\Controller\SetupModuleController::setAvatarFileUid	(		$beUserId,
			$fileUid,
		array &	$storeRec
	)

protected

Set avatar fileUid for backend user

Parameters

int	$beUserId
int	$fileUid
array	$storeRec

Definition at line 903 of file SetupModuleController.php.

References TYPO3\CMS\Setup\Controller\SetupModuleController\getAvatarFileUid().

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\storeIncomingData().

◆ storeIncomingData()

TYPO3\CMS\Setup\Controller\SetupModuleController::storeIncomingData ( array $postData )

protected

If settings are submitted to _POST[DATA], store them NOTICE: This method is called before the \TYPO3\CMS\Backend\Template\ModuleTemplate is included. See bottom of document.

Parameters

array $postData ‪parsed body of the request

Definition at line 197 of file SetupModuleController.php.

References $GLOBALS, TYPO3\CMS\Setup\Controller\SetupModuleController\checkAccess(), TYPO3\CMS\Setup\Controller\SetupModuleController\getBackendUser(), TYPO3\CMS\Setup\Controller\SetupModuleController\getFieldsFromShowItem(), TYPO3\CMS\Setup\Controller\SetupModuleController\PASSWORD_NOT_THE_SAME, TYPO3\CMS\Setup\Controller\SetupModuleController\PASSWORD_OLD_WRONG, TYPO3\CMS\Setup\Controller\SetupModuleController\PASSWORD_UPDATED, TYPO3\CMS\Setup\Controller\SetupModuleController\setAvatarFileUid(), and TYPO3\CMS\Backend\Utility\BackendUtility\setUpdateSignal().

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\mainAction().

Member Data Documentation

◆ $content

string TYPO3\CMS\Setup\Controller\SetupModuleController::$content

protected

Definition at line 80 of file SetupModuleController.php.

◆ $eventDispatcher

EventDispatcherInterface TYPO3\CMS\Setup\Controller\SetupModuleController::$eventDispatcher

protected

Definition at line 138 of file SetupModuleController.php.

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\__construct().

◆ $formProtection

TYPO3 CMS Core FormProtection BackendFormProtection TYPO3\CMS\Setup\Controller\SetupModuleController::$formProtection

protected

Form protection instance

Definition at line 122 of file SetupModuleController.php.

◆ $languageUpdate

bool TYPO3\CMS\Setup\Controller\SetupModuleController::$languageUpdate

protected

Definition at line 88 of file SetupModuleController.php.

◆ $moduleName

string TYPO3\CMS\Setup\Controller\SetupModuleController::$moduleName = 'user_setup'

protected

The name of the module

Definition at line 128 of file SetupModuleController.php.

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\processAdditionalJavaScriptModules().

◆ $moduleTemplate

ModuleTemplate TYPO3\CMS\Setup\Controller\SetupModuleController::$moduleTemplate

protected

ModuleTemplate object

Definition at line 134 of file SetupModuleController.php.

◆ $overrideConf

array TYPO3\CMS\Setup\Controller\SetupModuleController::$overrideConf

protected

Definition at line 84 of file SetupModuleController.php.

◆ $pagetreeNeedsRefresh

bool TYPO3\CMS\Setup\Controller\SetupModuleController::$pagetreeNeedsRefresh = false

protected

Definition at line 92 of file SetupModuleController.php.

◆ $passwordIsSubmitted

bool TYPO3\CMS\Setup\Controller\SetupModuleController::$passwordIsSubmitted = false

protected

Definition at line 108 of file SetupModuleController.php.

◆ $passwordIsUpdated

int TYPO3\CMS\Setup\Controller\SetupModuleController::$passwordIsUpdated = self::PASSWORD_NOT_UPDATED

protected

Definition at line 104 of file SetupModuleController.php.

◆ $saveData

bool TYPO3\CMS\Setup\Controller\SetupModuleController::$saveData = false

protected

Definition at line 100 of file SetupModuleController.php.

◆ $settingsAreResetToDefault

bool TYPO3\CMS\Setup\Controller\SetupModuleController::$settingsAreResetToDefault = false

protected

Definition at line 116 of file SetupModuleController.php.

◆ $setupIsUpdated

bool TYPO3\CMS\Setup\Controller\SetupModuleController::$setupIsUpdated = false

protected

Definition at line 112 of file SetupModuleController.php.

◆ $tsFieldConf

array TYPO3\CMS\Setup\Controller\SetupModuleController::$tsFieldConf

protected

Definition at line 96 of file SetupModuleController.php.

◆ PASSWORD_NOT_THE_SAME

const TYPO3\CMS\Setup\Controller\SetupModuleController::PASSWORD_NOT_THE_SAME = 2

Flag if both new passwords do not match

Definition at line 70 of file SetupModuleController.php.

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\addFlashMessages(), TYPO3\CMS\Setup\Tests\Unit\Controller\SetupModuleControllerTest\addFlashMessagesAddsMessageIfPasswordsNotTheSame(), and TYPO3\CMS\Setup\Controller\SetupModuleController\storeIncomingData().

◆ PASSWORD_NOT_UPDATED

const TYPO3\CMS\Setup\Controller\SetupModuleController::PASSWORD_NOT_UPDATED = 0

Flag if password has not been updated

Definition at line 60 of file SetupModuleController.php.

◆ PASSWORD_OLD_WRONG

const TYPO3\CMS\Setup\Controller\SetupModuleController::PASSWORD_OLD_WRONG = 3

Flag if the current password given was not identical to the real current password

Definition at line 76 of file SetupModuleController.php.

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\addFlashMessages(), TYPO3\CMS\Setup\Tests\Unit\Controller\SetupModuleControllerTest\addFlashMessagesAddsMessageIfOldPasswordWasWrong(), and TYPO3\CMS\Setup\Controller\SetupModuleController\storeIncomingData().

◆ PASSWORD_UPDATED

const TYPO3\CMS\Setup\Controller\SetupModuleController::PASSWORD_UPDATED = 1

Flag if password has been updated

Definition at line 65 of file SetupModuleController.php.

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\addFlashMessages(), TYPO3\CMS\Setup\Tests\Unit\Controller\SetupModuleControllerTest\addFlashMessagesAddsMessageIfPasswordWasSuccessfullyUpdated(), and TYPO3\CMS\Setup\Controller\SetupModuleController\storeIncomingData().

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFlashMessages()

◆ buildInstructionDataTag()

◆ checkAccess()

◆ enqueueFlashMessages()

◆ getAvatarFileUid()

◆ getBackendUser()

◆ getButtons()

◆ getCSH()

◆ getFieldsFromShowItem()

◆ getFlashMessage()

◆ getJavaScript()

◆ getLabel()

◆ getLanguageService()

◆ initialize()

◆ mainAction()

◆ processAdditionalJavaScriptModules()

◆ renderLanguageSelect()

◆ renderStartModuleSelect()

◆ renderUserSetup()

◆ setAvatarFileUid()

◆ storeIncomingData()

Member Data Documentation

◆ $content

◆ $eventDispatcher

◆ $formProtection

◆ $languageUpdate

◆ $moduleName

◆ $moduleTemplate

◆ $overrideConf

◆ $pagetreeNeedsRefresh

◆ $passwordIsSubmitted

◆ $passwordIsUpdated

◆ $saveData

◆ $settingsAreResetToDefault

◆ $setupIsUpdated

◆ $tsFieldConf

◆ PASSWORD_NOT_THE_SAME

◆ PASSWORD_NOT_UPDATED

◆ PASSWORD_OLD_WRONG

◆ PASSWORD_UPDATED