TYPO3 CMS  TYPO3_6-2
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Setup\Controller\SetupModuleController Class Reference
Inheritance diagram for TYPO3\CMS\Setup\Controller\SetupModuleController:
SC_mod_user_setup_index

Public Member Functions

 __construct ()
 
 getFormProtection ()
 
 storeIncomingData ()
 
 init ()
 
 main ()
 
 printContent ()
 
 renderStartModuleSelect ($params, $pObj)
 
 simulateUser ()
 
 renderSimulateUserSelect ($params, $pObj)
 

Public Attributes

 $MCONF = array()
 
 $MOD_MENU = array()
 
 $MOD_SETTINGS = array()
 
 $doc
 
 $content
 
 $overrideConf
 
 $OLD_BE_USER
 
 $languageUpdate
 

Protected Member Functions

 getJavaScript ()
 
 getButtons ()
 
 renderUserSetup ()
 
 getRealScriptUserObj ()
 
 checkAccess (array $config)
 
 getLabel ($str, $key='', $addLabelTag=TRUE, $altLabelTagId='')
 
 getCSH ($str, $label)
 
 getFieldsFromShowItem ()
 

Protected Attributes

 $pagetreeNeedsRefresh = FALSE
 
 $isAdmin
 
 $dividers2tabs
 
 $tsFieldConf
 
 $saveData = FALSE
 
 $passwordIsUpdated = FALSE
 
 $passwordIsSubmitted = FALSE
 
 $setupIsUpdated = FALSE
 
 $tempDataIsCleared = FALSE
 
 $settingsAreResetToDefault = FALSE
 
 $formProtection
 

Detailed Description

Module: User configuration

This module lets users viev and change their individual settings

Author
Kasper Skårhøj kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om Script class for the Setup module
Kasper Skårhøj kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om

Definition at line 32 of file SetupModuleController.php.

Constructor & Destructor Documentation

◆ __construct()

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

Instantiate the form protection before a simulated user is initialized.

Definition at line 116 of file SetupModuleController.php.

References TYPO3\CMS\Core\FormProtection\FormProtectionFactory\get().

Member Function Documentation

◆ checkAccess()

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

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

Parameters
array$configConfiguration of the field, access mode is defined in key 'access'
Returns
boolean Whether it is allowed to modify the given field

Definition at line 695 of file SetupModuleController.php.

References $GLOBALS, TYPO3\CMS\Setup\Controller\SetupModuleController\$isAdmin, and TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj().

Referenced by 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.

Returns
array All available buttons as an assoc. array

Definition at line 407 of file SetupModuleController.php.

References $GLOBALS, TYPO3\CMS\Backend\Utility\BackendUtility\cshItem(), and TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon().

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

◆ getCSH()

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

Returns the CSH Icon for given string

Parameters
string$strLocallang key
string$labelThe label to be used, that should be wrapped in help
Returns
string HTML output.

Definition at line 738 of file SetupModuleController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\inList(), and TYPO3\CMS\Backend\Utility\BackendUtility\wrapInHelp().

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

◆ getFieldsFromShowItem()

TYPO3\CMS\Setup\Controller\SetupModuleController::getFieldsFromShowItem ( )
protected

Returns array with fields defined in $GLOBALS['TYPO3_USER_SETTINGS']['showitem']

Returns
array Array with fieldnames visible in form

Definition at line 757 of file SetupModuleController.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\rmFromList(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

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

◆ getFormProtection()

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

Getter for the form protection instance.

Returns

Definition at line 125 of file SetupModuleController.php.

References TYPO3\CMS\Setup\Controller\SetupModuleController\$formProtection.

◆ getJavaScript()

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

Generate necessary JavaScript

Returns
string

Definition at line 302 of file SetupModuleController.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction().

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

◆ getLabel()

TYPO3\CMS\Setup\Controller\SetupModuleController::getLabel (   $str,
  $key = '',
  $addLabelTag = TRUE,
  $altLabelTagId = '' 
)
protected

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

Parameters
string$strLocallang key
string$keyAlternative override-config key
boolean$addLabelTagDefines whether the string should be wrapped in a <label> tag.
string$altLabelTagIdAlternative id for use in "for" attribute of <label> tag. By default the $str key is used prepended with "field_".
Returns
string HTML output.

Definition at line 716 of file SetupModuleController.php.

References $GLOBALS.

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

◆ getRealScriptUserObj()

TYPO3\CMS\Setup\Controller\SetupModuleController::getRealScriptUserObj ( )
protected

Returns the backend user object, either the global OR the $this->OLD_BE_USER which is set during simulate-user operation. Anyway: The REAL user is returned - the one logged in.

Returns
object The REAL user is returned - the one logged in.

Definition at line 570 of file SetupModuleController.php.

References $GLOBALS, $locales, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

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

◆ init()

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

Initializes the module for display of the settings form.

Returns
void
Todo:
Define visibility

Definition at line 265 of file SetupModuleController.php.

References $GLOBALS, TYPO3\CMS\Setup\Controller\SetupModuleController\getJavaScript(), TYPO3\CMS\Backend\Utility\BackendUtility\getModuleUrl(), TYPO3\CMS\Setup\Controller\SetupModuleController\getRealScriptUserObj(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ main()

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

Generate the main settings formular:

Returns
void
Todo:
Define visibility

Definition at line 319 of file SetupModuleController.php.

References TYPO3\CMS\Setup\Controller\SetupModuleController\$content, $GLOBALS, TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Setup\Controller\SetupModuleController\getButtons(), TYPO3\CMS\Core\Messaging\AbstractMessage\INFO, TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Setup\Controller\SetupModuleController\renderUserSetup(), and TYPO3\CMS\Backend\Utility\BackendUtility\setUpdateSignal().

◆ printContent()

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

Prints the content / ends page

Returns
void
Todo:
Define visibility

Definition at line 398 of file SetupModuleController.php.

References TYPO3\CMS\Setup\Controller\SetupModuleController\$content.

◆ renderSimulateUserSelect()

TYPO3\CMS\Setup\Controller\SetupModuleController::renderSimulateUserSelect (   $params,
  $pObj 
)

Returns a select with simulate users

Returns
string Complete select as HTML string

Definition at line 685 of file SetupModuleController.php.

◆ renderStartModuleSelect()

TYPO3\CMS\Setup\Controller\SetupModuleController::renderStartModuleSelect (   $params,
  $pObj 
)

Returns a select with all modules for startup

Returns
string Complete select as HTML string

Definition at line 619 of file SetupModuleController.php.

References $GLOBALS.

◆ renderUserSetup()

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

Definition at line 432 of file SetupModuleController.php.

References $GLOBALS, $result, TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Setup\Controller\SetupModuleController\checkAccess(), TYPO3\CMS\Setup\Controller\SetupModuleController\getCSH(), TYPO3\CMS\Setup\Controller\SetupModuleController\getFieldsFromShowItem(), and TYPO3\CMS\Setup\Controller\SetupModuleController\getLabel().

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

◆ simulateUser()

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

Will make the simulate-user selector if the logged in user is administrator. It will also set the GLOBAL(!) BE_USER to the simulated user selected if any (and set $this->OLD_BE_USER to logged in user)

Returns
void

Definition at line 644 of file SetupModuleController.php.

References $BE_USER, $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Backend\Utility\BackendUtility\BEenableFields(), TYPO3\CMS\Backend\Utility\BackendUtility\getModuleUrl(), TYPO3\CMS\Backend\Utility\BackendUtility\getUserNames(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ storeIncomingData()

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

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

See also

Definition at line 136 of file SetupModuleController.php.

References $GLOBALS, TYPO3\CMS\Setup\Controller\SetupModuleController\$isAdmin, TYPO3\CMS\Core\Utility\GeneralUtility\_POST(), TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Setup\Controller\SetupModuleController\checkAccess(), TYPO3\CMS\Setup\Controller\SetupModuleController\getFieldsFromShowItem(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Member Data Documentation

◆ $content

TYPO3\CMS\Setup\Controller\SetupModuleController::$content
Todo:
Define visibility

Definition at line 61 of file SetupModuleController.php.

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\main(), and TYPO3\CMS\Setup\Controller\SetupModuleController\printContent().

◆ $dividers2tabs

TYPO3\CMS\Setup\Controller\SetupModuleController::$dividers2tabs
protected

Definition at line 85 of file SetupModuleController.php.

◆ $doc

TYPO3\CMS\Setup\Controller\SetupModuleController::$doc

Definition at line 56 of file SetupModuleController.php.

◆ $formProtection

TYPO3\CMS\Setup\Controller\SetupModuleController::$formProtection
protected

Definition at line 106 of file SetupModuleController.php.

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

◆ $isAdmin

TYPO3\CMS\Setup\Controller\SetupModuleController::$isAdmin
protected

Definition at line 83 of file SetupModuleController.php.

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

◆ $languageUpdate

TYPO3\CMS\Setup\Controller\SetupModuleController::$languageUpdate
Todo:
Define visibility

Definition at line 79 of file SetupModuleController.php.

◆ $MCONF

TYPO3\CMS\Setup\Controller\SetupModuleController::$MCONF = array()
Todo:
Define visibility

Definition at line 38 of file SetupModuleController.php.

◆ $MOD_MENU

TYPO3\CMS\Setup\Controller\SetupModuleController::$MOD_MENU = array()
Todo:
Define visibility

Definition at line 43 of file SetupModuleController.php.

◆ $MOD_SETTINGS

TYPO3\CMS\Setup\Controller\SetupModuleController::$MOD_SETTINGS = array()
Todo:
Define visibility

Definition at line 48 of file SetupModuleController.php.

◆ $OLD_BE_USER

TYPO3\CMS\Setup\Controller\SetupModuleController::$OLD_BE_USER

Definition at line 74 of file SetupModuleController.php.

◆ $overrideConf

TYPO3\CMS\Setup\Controller\SetupModuleController::$overrideConf
Todo:
Define visibility

Definition at line 66 of file SetupModuleController.php.

◆ $pagetreeNeedsRefresh

TYPO3\CMS\Setup\Controller\SetupModuleController::$pagetreeNeedsRefresh = FALSE
protected

Definition at line 81 of file SetupModuleController.php.

◆ $passwordIsSubmitted

TYPO3\CMS\Setup\Controller\SetupModuleController::$passwordIsSubmitted = FALSE
protected

Definition at line 93 of file SetupModuleController.php.

◆ $passwordIsUpdated

TYPO3\CMS\Setup\Controller\SetupModuleController::$passwordIsUpdated = FALSE
protected

Definition at line 91 of file SetupModuleController.php.

◆ $saveData

TYPO3\CMS\Setup\Controller\SetupModuleController::$saveData = FALSE
protected

Definition at line 89 of file SetupModuleController.php.

◆ $settingsAreResetToDefault

TYPO3\CMS\Setup\Controller\SetupModuleController::$settingsAreResetToDefault = FALSE
protected

Definition at line 99 of file SetupModuleController.php.

◆ $setupIsUpdated

TYPO3\CMS\Setup\Controller\SetupModuleController::$setupIsUpdated = FALSE
protected

Definition at line 95 of file SetupModuleController.php.

◆ $tempDataIsCleared

TYPO3\CMS\Setup\Controller\SetupModuleController::$tempDataIsCleared = FALSE
protected

Definition at line 97 of file SetupModuleController.php.

◆ $tsFieldConf

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

Definition at line 87 of file SetupModuleController.php.