Inheritance diagram for TYPO3\CMS\Info\Controller\InfoModuleController:

Public Member Functions
	__construct ()

ResponseInterface	mainAction (ServerRequestInterface $request)

‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Compatibility\PublicPropertyDeprecationTrait
bool	__isset (string $propertyName)

mixed	__get (string $propertyName)

	__set (string $propertyName, $propertyValue)

	__unset (string $propertyName)

‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Compatibility\PublicMethodDeprecationTrait
mixed	__call (string $methodName, array $arguments)

Public Attributes
array	$pageinfo

array	$MOD_MENU

array	$MOD_SETTINGS = array( )

Protected Member Functions
	init ()

	main ()

	getButtons ()

	generateMenu ()

ModuleTemplate	getModuleTemplate ()

StandaloneView	getFluidTemplateObject ()

	menuConfig ()

array	mergeExternalItems ($modName, $menuKey, $menuArr)

	handleExternalFunctionValue ($MM_key='function', $MS_value=null)

mixed	getExternalItemConfig ($modName, $menuKey, $value='')

	checkExtObj ()

	checkSubExtObj ()

	extObjHeader ()

	extObjContent ()

string	getExtObjContent ()

LanguageService	getLanguageService ()

BackendUserAuthentication	getBackendUser ()

Protected Attributes
string	$moduleName = 'web_info'

ModuleTemplate	$moduleTemplate

StandaloneView	$view

array	$MCONF = array( )

	$id

mixed	$CMD

string	$perms_clause

array	$modTSconfig

string	$modMenu_type = ''

string	$modMenu_dontValidateList = ''

string	$modMenu_setDefaultList = ''

array	$extClassConf

string	$content = ''

DocumentTemplate	$doc

object	$extObj

Private Attributes
array	$deprecatedPublicProperties

array	$deprecatedPublicMethods

Detailed Description

Script Class for the Web > Info module This class creates the framework to which other extensions can connect their sub-modules

This class is a specific Backend controller implementation and is not part of the TYPO3's Core API.

Definition at line 41 of file InfoModuleController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Info\Controller\InfoModuleController::__construct ( )

Constructor

Definition at line 189 of file InfoModuleController.php.

References TYPO3\CMS\Info\Controller\InfoModuleController\$moduleName, and TYPO3\CMS\Info\Controller\InfoModuleController\getLanguageService().

Member Function Documentation

◆ checkExtObj()

TYPO3\CMS\Info\Controller\InfoModuleController::checkExtObj ( )

protected

Creates an instance of the class found in $this->extClassConf['name'] in $this->extObj if any (this should hold three keys, "name", "path" and "title" if a "Function menu module" tries to connect...) This value in extClassConf might be set by an extension (in an ext_tables/ext_localconf file) which thus "connects" to a module. The array $this->extClassConf is set in handleExternalFunctionValue() based on the value of MOD_SETTINGS[function] If an instance is created it is initiated with $this passed as value and $this->extClassConf as second argument. Further the $this->MOD_SETTING is cleaned up again after calling the init function.

Definition at line 476 of file InfoModuleController.php.

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

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\mainAction().

◆ checkSubExtObj()

TYPO3\CMS\Info\Controller\InfoModuleController::checkSubExtObj ( )

protected

Calls the checkExtObj function in sub module if present.

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 493 of file InfoModuleController.php.

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\mainAction().

◆ extObjContent()

TYPO3\CMS\Info\Controller\InfoModuleController::extObjContent ( )

protected

Calls the 'main' function inside the "Function menu module" if present

Definition at line 516 of file InfoModuleController.php.

References TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, and TYPO3\CMS\Info\Controller\InfoModuleController\getLanguageService().

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\getExtObjContent().

◆ extObjHeader()

TYPO3\CMS\Info\Controller\InfoModuleController::extObjHeader ( )

protected

Calls the 'header' function inside the "Function menu module" if present. A header function might be needed to add JavaScript or other stuff in the head. This can't be done in the main function because the head is already written.

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 506 of file InfoModuleController.php.

◆ generateMenu()

TYPO3\CMS\Info\Controller\InfoModuleController::generateMenu ( )

protected

Generate the ModuleMenu

Definition at line 334 of file InfoModuleController.php.

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\main().

◆ getBackendUser()

BackendUserAuthentication TYPO3\CMS\Info\Controller\InfoModuleController::getBackendUser ( )

protected

Returns: ‪BackendUserAuthentication

Definition at line 569 of file InfoModuleController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\init(), TYPO3\CMS\Info\Controller\InfoModuleController\main(), and TYPO3\CMS\Info\Controller\InfoModuleController\mergeExternalItems().

◆ getButtons()

TYPO3\CMS\Info\Controller\InfoModuleController::getButtons ( )

protected

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

Definition at line 292 of file InfoModuleController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\BEgetRootLine(), TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_LEFT, TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_RIGHT, TYPO3\CMS\Info\Controller\InfoModuleController\getLanguageService(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Backend\Utility\BackendUtility\viewOnClick().

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\main().

◆ getExternalItemConfig()

mixed TYPO3\CMS\Info\Controller\InfoModuleController::getExternalItemConfig	(	$modName,
		$menuKey,
		$value = `''`
	)

protected

Returns configuration values from the global variable $TBE_MODULES_EXT for the module given. For example if the module is named "web_info" and the "function" key ($menuKey) of MOD_SETTINGS is "stat" ($value) then you will have the values of $TBE_MODULES_EXT['webinfo']['MOD_MENU']['function']['stat'] returned.

Parameters

string	$modName	‪Module name
string	$menuKey	‪Menu key, eg. "function" for the function menu. See $this->MOD_MENU
string	$value	‪Optionally the value-key to fetch from the array that would otherwise have been returned if this value was not set. Look source...

Returns: ‪mixed The value from the TBE_MODULES_EXT array.

Definition at line 460 of file InfoModuleController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\handleExternalFunctionValue().

◆ getExtObjContent()

string TYPO3\CMS\Info\Controller\InfoModuleController::getExtObjContent ( )

protected

Return the content of the 'main' function inside the "Function menu module" if present

Returns: ‪string

Definition at line 548 of file InfoModuleController.php.

References TYPO3\CMS\Info\Controller\InfoModuleController\$content, and TYPO3\CMS\Info\Controller\InfoModuleController\extObjContent().

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\main().

◆ getFluidTemplateObject()

StandaloneView TYPO3\CMS\Info\Controller\InfoModuleController::getFluidTemplateObject ( )

protected

returns a new standalone view, shorthand function

Returns: ‪StandaloneView

Definition at line 378 of file InfoModuleController.php.

References TYPO3\CMS\Info\Controller\InfoModuleController\$view, TYPO3\CMS\Fluid\View\StandaloneView\getRequest(), TYPO3\CMS\Fluid\View\AbstractTemplateView\setLayoutRootPaths(), TYPO3\CMS\Fluid\View\AbstractTemplateView\setPartialRootPaths(), TYPO3\CMS\Fluid\View\AbstractTemplateView\setTemplatePathAndFilename(), and TYPO3\CMS\Fluid\View\AbstractTemplateView\setTemplateRootPaths().

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\main().

◆ getLanguageService()

LanguageService TYPO3\CMS\Info\Controller\InfoModuleController::getLanguageService ( )

protected

Returns: ‪LanguageService

Definition at line 561 of file InfoModuleController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\__construct(), TYPO3\CMS\Info\Controller\InfoModuleController\extObjContent(), TYPO3\CMS\Info\Controller\InfoModuleController\getButtons(), TYPO3\CMS\Info\Controller\InfoModuleController\main(), and TYPO3\CMS\Info\Controller\InfoModuleController\mergeExternalItems().

◆ getModuleTemplate()

ModuleTemplate TYPO3\CMS\Info\Controller\InfoModuleController::getModuleTemplate ( )

protected

Returns the ModuleTemplate container This is used by PageLayoutView.php

Returns: ‪ModuleTemplate

Definition at line 368 of file InfoModuleController.php.

References TYPO3\CMS\Info\Controller\InfoModuleController\$moduleTemplate.

◆ handleExternalFunctionValue()

TYPO3\CMS\Info\Controller\InfoModuleController::handleExternalFunctionValue	(	$MM_key = `'function'`,
		$MS_value = `null`
	)

protected

Loads $this->extClassConf with the configuration for the CURRENT function of the menu.

Parameters

string	$MM_key	‪The key to MOD_MENU for which to fetch configuration. 'function' is default since it is first and foremost used to get information per "extension object" (I think that is what its called)
string	$MS_value	‪The value-key to fetch from the config array. If NULL (default) MOD_SETTINGS[$MM_key] will be used. This is useful if you want to force another function than the one defined in MOD_SETTINGS[function]. Call this in init() function of your Script Class: handleExternalFunctionValue('function', $forcedSubModKey)

Definition at line 442 of file InfoModuleController.php.

References TYPO3\CMS\Info\Controller\InfoModuleController\getExternalItemConfig().

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\init().

◆ init()

TYPO3\CMS\Info\Controller\InfoModuleController::init ( )

protected

Initializes the backend module by setting internal variables, initializing the menu.

Definition at line 204 of file InfoModuleController.php.

References TYPO3\CMS\Info\Controller\InfoModuleController\getBackendUser(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getPagePermsClause(), TYPO3\CMS\Info\Controller\InfoModuleController\handleExternalFunctionValue(), TYPO3\CMS\Info\Controller\InfoModuleController\menuConfig(), and TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW.

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\mainAction().

◆ main()

TYPO3\CMS\Info\Controller\InfoModuleController::main ( )

protected

Initialize module header etc and call extObjContent function

Definition at line 217 of file InfoModuleController.php.

References TYPO3\CMS\Info\Controller\InfoModuleController\generateMenu(), TYPO3\CMS\Info\Controller\InfoModuleController\getBackendUser(), TYPO3\CMS\Info\Controller\InfoModuleController\getButtons(), TYPO3\CMS\Info\Controller\InfoModuleController\getExtObjContent(), TYPO3\CMS\Info\Controller\InfoModuleController\getFluidTemplateObject(), TYPO3\CMS\Info\Controller\InfoModuleController\getLanguageService(), and TYPO3\CMS\Backend\Utility\BackendUtility\readPageAccess().

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\mainAction().

◆ mainAction()

ResponseInterface TYPO3\CMS\Info\Controller\InfoModuleController::mainAction ( ServerRequestInterface $request )

Injects the request object for the current request or subrequest Then checks for module functions that have hooked in, and renders menu etc.

Parameters

ServerRequestInterface $request ‪the current request

Returns: ‪ResponseInterface the response with the content

Definition at line 270 of file InfoModuleController.php.

References $GLOBALS, TYPO3\CMS\Info\Controller\InfoModuleController\checkExtObj(), TYPO3\CMS\Info\Controller\InfoModuleController\checkSubExtObj(), TYPO3\CMS\Info\Controller\InfoModuleController\init(), and TYPO3\CMS\Info\Controller\InfoModuleController\main().

◆ menuConfig()

TYPO3\CMS\Info\Controller\InfoModuleController::menuConfig ( )

protected

Initializes the internal MOD_MENU array setting and unsetting items based on various conditions. It also merges in external menu items from the global array TBE_MODULES_EXT (see mergeExternalItems()) Then MOD_SETTINGS array is cleaned up (see \TYPO3\CMS\Backend\Utility\BackendUtility::getModuleData()) so it contains only valid values. It's also updated with any SET[] values submitted. Also loads the modTSconfig internal variable.

Definition at line 396 of file InfoModuleController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\getModuleData(), TYPO3\CMS\Backend\Utility\BackendUtility\getPagesTSconfig(), and TYPO3\CMS\Info\Controller\InfoModuleController\mergeExternalItems().

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\init().

◆ mergeExternalItems()

array TYPO3\CMS\Info\Controller\InfoModuleController::mergeExternalItems	(	$modName,
		$menuKey,
		$menuArr
	)

protected

Merges menu items from global array $TBE_MODULES_EXT

Parameters

string	$modName	‪Module name for which to find value
string	$menuKey	‪Menu key, eg. 'function' for the function menu.
array	$menuArr	‪The part of a MOD_MENU array to work on.

Returns: ‪array Modified array part.

Definition at line 419 of file InfoModuleController.php.

References $GLOBALS, TYPO3\CMS\Info\Controller\InfoModuleController\getBackendUser(), TYPO3\CMS\Info\Controller\InfoModuleController\getLanguageService(), and TYPO3\CMS\Core\Localization\LanguageService\sL().

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\menuConfig().

Member Data Documentation

◆ $CMD

mixed TYPO3\CMS\Info\Controller\InfoModuleController::$CMD

protected

The value of GET/POST var, 'CMD'

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 115 of file InfoModuleController.php.

◆ $content

string TYPO3\CMS\Info\Controller\InfoModuleController::$content = ''

protected

Generally used for accumulating the output content of backend modules

Definition at line 174 of file InfoModuleController.php.

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\getExtObjContent().

◆ $deprecatedPublicMethods

array TYPO3\CMS\Info\Controller\InfoModuleController::$deprecatedPublicMethods

private

Initial value:

= array( 
        'main' => 'Using InfoModuleController::main() is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'init' => 'Using InfoModuleController::init() is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'getModuleTemplate' => 'Using InfoModuleController::getModuleTemplate() is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'menuConfig' => 'Using InfoModuleController::menuConfig() is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'handleExternalFunctionValue' => 'Using InfoModuleController::handleExternalFunctionValue() is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'mergeExternalItems' => 'Using InfoModuleController::mergeExternalItems() is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'getExternalItemConfig' => 'Using InfoModuleController::getExternalItemConfig() is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'extObjContent' => 'Using InfoModuleController::extObjContent() is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'getExtObjContent' => 'Using InfoModuleController::getExtObjContent() is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'checkExtObj' => 'Using InfoModuleController::checkExtObj() is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'extObjHeader' => 'Using InfoModuleController::extObjHeader() is deprecated, method will be removed in TYPO3 v10.0.',
        'checkSubExtObj' => 'Using InfoModuleController::checkSubExtObj() is deprecated, method will be removed in TYPO3 v10.0.',
     )

Definition at line 64 of file InfoModuleController.php.

◆ $deprecatedPublicProperties

array TYPO3\CMS\Info\Controller\InfoModuleController::$deprecatedPublicProperties

private

Initial value:

= array( 
        'perms_clause' => 'Using InfoModuleController::$perms_clause is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'modTSconfig' => 'Using InfoModuleController::$modTSconfig is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'modMenu_setDefaultList' => 'Using InfoModuleController::$modMenu_setDefaultList is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'modMenu_dontValidateList' => 'Using InfoModuleController::$modMenu_dontValidateList is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'modMenu_type' => 'Using InfoModuleController::$modMenu_type$ is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'extClassConf' => 'Using InfoModuleController::extClassConf$ is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'extObj' => 'Using InfoModuleController::$extObj is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'content' => 'Using InfoModuleController::$content is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'pObj' => 'Using InfoModuleController::$pObj is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'id' => 'Using InfoModuleController::id$ is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'CMD' => 'Using InfoModuleController::$CMD is deprecated, property will be removed in TYPO3 v10.0.',
        'doc' => 'Using InfoModuleController::$doc is deprecated, property will be removed in TYPO3 v10.0.',
        'MCONF' => 'Using InfoModuleController::$MCONF is deprecated, property will be removed in TYPO3 v10.0.',
     )

Definition at line 46 of file InfoModuleController.php.

◆ $doc

DocumentTemplate TYPO3\CMS\Info\Controller\InfoModuleController::$doc

protected

Definition at line 178 of file InfoModuleController.php.

◆ $extClassConf

array TYPO3\CMS\Info\Controller\InfoModuleController::$extClassConf

protected

Contains module configuration parts from TBE_MODULES_EXT if found

Definition at line 168 of file InfoModuleController.php.

◆ $extObj

object TYPO3\CMS\Info\Controller\InfoModuleController::$extObj

protected

May contain an instance of a 'Function menu module' which connects to this backend module.

Definition at line 184 of file InfoModuleController.php.

◆ $id

TYPO3\CMS\Info\Controller\InfoModuleController::$id

protected

Definition at line 108 of file InfoModuleController.php.

◆ $MCONF

array TYPO3\CMS\Info\Controller\InfoModuleController::$MCONF = array( )

protected

Loaded with the global array $MCONF which holds some module configuration from the conf.php file of backend modules.

Definition at line 103 of file InfoModuleController.php.

◆ $MOD_MENU

array TYPO3\CMS\Info\Controller\InfoModuleController::$MOD_MENU

Initial value:

= array( 
        'function' => []
     )

The module menu items array. Each key represents a key for which values can range between the items in the array of that key. Written by client classes.

Definition at line 128 of file InfoModuleController.php.

◆ $MOD_SETTINGS

array TYPO3\CMS\Info\Controller\InfoModuleController::$MOD_SETTINGS = array( )

Current settings for the keys of the MOD_MENU array Written by client classes.

Definition at line 137 of file InfoModuleController.php.

◆ $modMenu_dontValidateList

string TYPO3\CMS\Info\Controller\InfoModuleController::$modMenu_dontValidateList = ''

protected

dontValidateList can be used to list variables that should not be checked if their value is found in the MOD_MENU array. Used for dynamically generated menus. Can be set from extension classes of this class before the init() function is called.

Definition at line 157 of file InfoModuleController.php.

◆ $modMenu_setDefaultList

string TYPO3\CMS\Info\Controller\InfoModuleController::$modMenu_setDefaultList = ''

protected

List of default values from $MOD_MENU to set in the output array (only if the values from MOD_MENU are not arrays) Can be set from extension classes of this class before the init() function is called.

Definition at line 164 of file InfoModuleController.php.

◆ $modMenu_type

string TYPO3\CMS\Info\Controller\InfoModuleController::$modMenu_type = ''

protected

If type is 'ses' then the data is stored as session-lasting data. This means that it'll be wiped out the next time the user logs in. Can be set from extension classes of this class before the init() function is called.

Definition at line 150 of file InfoModuleController.php.

◆ $modTSconfig

array TYPO3\CMS\Info\Controller\InfoModuleController::$modTSconfig

protected

Module TSconfig based on PAGE TSconfig / USER TSconfig

Definition at line 143 of file InfoModuleController.php.

◆ $moduleName

string TYPO3\CMS\Info\Controller\InfoModuleController::$moduleName = 'web_info'

protected

The name of the module

Definition at line 87 of file InfoModuleController.php.

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\__construct().

◆ $moduleTemplate

ModuleTemplate TYPO3\CMS\Info\Controller\InfoModuleController::$moduleTemplate

protected

ModuleTemplate Container

Definition at line 93 of file InfoModuleController.php.

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\getModuleTemplate().

◆ $pageinfo

array TYPO3\CMS\Info\Controller\InfoModuleController::$pageinfo

Used by client classes.

Definition at line 81 of file InfoModuleController.php.

◆ $perms_clause

string TYPO3\CMS\Info\Controller\InfoModuleController::$perms_clause

protected

A WHERE clause for selection records from the pages table based on read-permissions of the current backend user.

Definition at line 121 of file InfoModuleController.php.

◆ $view

StandaloneView TYPO3\CMS\Info\Controller\InfoModuleController::$view

protected

Definition at line 97 of file InfoModuleController.php.

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\getFluidTemplateObject().

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkExtObj()

◆ checkSubExtObj()

◆ extObjContent()

◆ extObjHeader()

◆ generateMenu()

◆ getBackendUser()

◆ getButtons()

◆ getExternalItemConfig()

◆ getExtObjContent()

◆ getFluidTemplateObject()

◆ getLanguageService()

◆ getModuleTemplate()

◆ handleExternalFunctionValue()

◆ init()

◆ main()

◆ mainAction()

◆ menuConfig()

◆ mergeExternalItems()

Member Data Documentation

◆ $CMD

◆ $content

◆ $deprecatedPublicMethods

◆ $deprecatedPublicProperties

◆ $doc

◆ $extClassConf

◆ $extObj

◆ $id

◆ $MCONF

◆ $MOD_MENU

◆ $MOD_SETTINGS

◆ $modMenu_dontValidateList

◆ $modMenu_setDefaultList

◆ $modMenu_type

◆ $modTSconfig

◆ $moduleName

◆ $moduleTemplate

◆ $pageinfo

◆ $perms_clause

◆ $view