SetupModuleController

Script class for the User Settings module

Internal

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

Attributes
#[AsController]

Table of Contents

Constants

DISALLOWED_FIELD_NAMES  = ['password', 'password2', 'email', 'realName', 'admin', 'avatar']
PASSWORD_NOT_THE_SAME  = 2
PASSWORD_NOT_UPDATED  = 0
PASSWORD_OLD_WRONG  = 3
PASSWORD_POLICY_FAILED  = 4
PASSWORD_UPDATED  = 1

Properties

$backendTitleFormatChanged  : bool
$colorSchemeChanged  : bool
$componentFactory  : ComponentFactory
$dateFormatter  : DateFormatter
$dateTimeFirstDayOfWeekChanged  : bool
$eventDispatcher  : EventDispatcherInterface
$formDataCompiler  : FormDataCompiler
$formProtectionFactory  : FormProtectionFactory
$formResultFactory  : FormResultFactory
$formResultHandler  : FormResultHandler
$iconFactory  : IconFactory
$languageServiceFactory  : LanguageServiceFactory
$languageUpdate  : bool
$locales  : Locales
$mfaProviderRegistry  : MfaProviderRegistry
$moduleProvider  : ModuleProvider
$moduleTemplateFactory  : ModuleTemplateFactory
$nodeFactory  : NodeFactory
$overrideConf  : array<string|int, mixed>
$pageRenderer  : PageRenderer
$pagetreeNeedsRefresh  : bool
$passwordIsSubmitted  : bool
$passwordIsUpdated  : int
$passwordPolicyValidator  : PasswordPolicyValidator
$persistentUpdate  : array<string|int, mixed>
$settingsAreResetToDefault  : bool
$setupIsUpdated  : bool
$tcaSchemaBuilder  : TcaSchemaBuilder
$themeChanged  : bool
$tsFieldConf  : array<string|int, mixed>
$typo3Information  : Typo3Information
$uriBuilder  : UriBuilder
$userSettingsSchema  : UserSettingsSchema

Methods

__construct()  : mixed
mainAction()  : ResponseInterface
Injects the request object, checks if data should be saved, and prepares a HTML page
addFlashMessages()  : void
Add FlashMessages for various actions
checkAccess()  : bool
Returns access check (currently only "admin" is supported)
compileFormData()  : array<string|int, mixed>
Compile form data for FormEngine rendering.
extractPartitionData()  : array<string, scalar>
extractShowitemFieldName()  : string
Extracts `field_name` from a showitem field `field_name;field_label`.
getAvatarFileUid()  : int
Get Avatar fileUid
getBackendUser()  : BackendUserAuthentication
getFieldsFromShowItem()  : array<int, string>
Returns array with fields defined in TCA user settings showitem.
getLanguageService()  : LanguageService
initialize()  : ModuleTemplate
Initializes the module for display of the settings form.
processAdditionalJavaScriptModules()  : void
registerResetButtonToButtonBar()  : void
Register the reset configuration button to the button bar.
setAvatarFileUid()  : void
Set avatar fileUid for backend user
storeIncomingData()  : void
If settings are submitted via POST, store them

Constants

DISALLOWED_FIELD_NAMES

protected mixed DISALLOWED_FIELD_NAMES = ['password', 'password2', 'email', 'realName', 'admin', 'avatar']

PASSWORD_NOT_THE_SAME

protected mixed PASSWORD_NOT_THE_SAME = 2

PASSWORD_NOT_UPDATED

protected mixed PASSWORD_NOT_UPDATED = 0

PASSWORD_OLD_WRONG

protected mixed PASSWORD_OLD_WRONG = 3

PASSWORD_POLICY_FAILED

protected mixed PASSWORD_POLICY_FAILED = 4

PASSWORD_UPDATED

protected mixed PASSWORD_UPDATED = 1

Properties

$backendTitleFormatChanged

protected bool $backendTitleFormatChanged = false

$colorSchemeChanged

protected bool $colorSchemeChanged = false

$dateTimeFirstDayOfWeekChanged

protected bool $dateTimeFirstDayOfWeekChanged = false

$eventDispatcher read-only

protected EventDispatcherInterface $eventDispatcher

$languageUpdate

protected bool $languageUpdate = false

$overrideConf

protected array<string|int, mixed> $overrideConf = []

$pagetreeNeedsRefresh

protected bool $pagetreeNeedsRefresh = false

$passwordIsSubmitted

protected bool $passwordIsSubmitted = false

$passwordIsUpdated

protected int $passwordIsUpdated = self::PASSWORD_NOT_UPDATED

$persistentUpdate

protected array<string|int, mixed> $persistentUpdate = []

$settingsAreResetToDefault

protected bool $settingsAreResetToDefault = false

$setupIsUpdated

protected bool $setupIsUpdated = false

$themeChanged

protected bool $themeChanged = false

$tsFieldConf

protected array<string|int, mixed> $tsFieldConf = []

Methods

__construct()

public __construct(Typo3Information $typo3Information, EventDispatcherInterface $eventDispatcher, MfaProviderRegistry $mfaProviderRegistry, IconFactory $iconFactory, PageRenderer $pageRenderer, ModuleTemplateFactory $moduleTemplateFactory, LanguageServiceFactory $languageServiceFactory, ModuleProvider $moduleProvider, UriBuilder $uriBuilder, FormProtectionFactory $formProtectionFactory, Locales $locales, ComponentFactory $componentFactory, DateFormatter $dateFormatter, FormDataCompiler $formDataCompiler, NodeFactory $nodeFactory, FormResultFactory $formResultFactory, FormResultHandler $formResultHandler, UserSettingsSchema $userSettingsSchema, TcaSchemaBuilder $tcaSchemaBuilder) : mixed
Parameters
$typo3Information : Typo3Information
$eventDispatcher : EventDispatcherInterface
$mfaProviderRegistry : MfaProviderRegistry
$iconFactory : IconFactory
$pageRenderer : PageRenderer
$moduleTemplateFactory : ModuleTemplateFactory
$languageServiceFactory : LanguageServiceFactory
$moduleProvider : ModuleProvider
$uriBuilder : UriBuilder
$formProtectionFactory : FormProtectionFactory
$locales : Locales
$componentFactory : ComponentFactory
$dateFormatter : DateFormatter
$formDataCompiler : FormDataCompiler
$nodeFactory : NodeFactory
$formResultFactory : FormResultFactory
$formResultHandler : FormResultHandler
$userSettingsSchema : UserSettingsSchema
$tcaSchemaBuilder : TcaSchemaBuilder

mainAction()

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

public mainAction(ServerRequestInterface $request) : ResponseInterface
Parameters
$request : ServerRequestInterface
Return values
ResponseInterface

checkAccess()

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

protected checkAccess(array<string|int, mixed> $config) : bool
Parameters
$config : array<string|int, mixed>

Configuration of the field, access mode is defined in key 'access'

Return values
bool —

Whether it is allowed to modify the given field

compileFormData()

Compile form data for FormEngine rendering.

protected compileFormData(ServerRequestInterface $request, array<string|int, mixed> $userSettingsTca) : array<string|int, mixed>
Parameters
$request : ServerRequestInterface
$userSettingsTca : array<string|int, mixed>
Return values
array<string|int, mixed>

extractPartitionData()

protected extractPartitionData(array<string, scalar> $data, string $partition) : array<string, scalar>
Parameters
$data : array<string, scalar>
$partition : string
Return values
array<string, scalar>

extractShowitemFieldName()

Extracts `field_name` from a showitem field `field_name;field_label`.

protected extractShowitemFieldName(string $fieldName) : string
Parameters
$fieldName : string
Return values
string

getAvatarFileUid()

Get Avatar fileUid

protected getAvatarFileUid(int $beUserId) : int
Parameters
$beUserId : int
Return values
int

getFieldsFromShowItem()

Returns array with fields defined in TCA user settings showitem.

protected getFieldsFromShowItem() : array<int, string>

Remove fields which are disabled by user TSconfig

Return values
array<int, string> —

Array with field names visible in form

initialize()

Initializes the module for display of the settings form.

protected initialize(ServerRequestInterface $request) : ModuleTemplate
Parameters
$request : ServerRequestInterface
Return values
ModuleTemplate

processAdditionalJavaScriptModules()

protected processAdditionalJavaScriptModules(ServerRequestInterface $request) : void
Parameters
$request : ServerRequestInterface

registerResetButtonToButtonBar()

Register the reset configuration button to the button bar.

protected registerResetButtonToButtonBar(ModuleTemplate $view) : void
Parameters
$view : ModuleTemplate

setAvatarFileUid()

Set avatar fileUid for backend user

protected setAvatarFileUid(int $beUserId, numeric-string|""|"delete"|null $fileUid, array<string|int, mixed> &$storeRec) : void
Parameters
$beUserId : int
$fileUid : numeric-string|""|"delete"|null

either null, a file UID, an empty string, or delete

$storeRec : array<string|int, mixed>

storeIncomingData()

If settings are submitted via POST, store them

protected storeIncomingData(ServerRequestInterface $request) : void
Parameters
$request : ServerRequestInterface 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results