InfoModuleController

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

Table of Contents

Properties

$MOD_MENU  : array<string|int, mixed>

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

$MOD_SETTINGS  : array<string|int, mixed>

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

$pageinfo  : array<string|int, mixed>

$container  : ContainerInterface

$content  : string

Generally used for accumulating the output content of backend modules

$extClassConf  : array<string|int, mixed>

$extObj  : object

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

$flashMessageService  : FlashMessageService

$iconFactory  : IconFactory

$id  : int

$modMenu_dontValidateList  : string

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.

$modMenu_setDefaultList  : string

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.

$modMenu_type  : string

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.

$modTSconfig  : array<string|int, mixed>

Module TSconfig based on PAGE TSconfig / USER TSconfig

$moduleName  : string

The name of the module

$moduleTemplate  : ModuleTemplate

ModuleTemplate Container

$moduleTemplateFactory  : ModuleTemplateFactory

$pageRenderer  : PageRenderer

$perms_clause  : string

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

$uriBuilder  : UriBuilder

$view  : StandaloneView

Methods

__construct()  : mixed

mainAction()  : ResponseInterface

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

checkExtObj()  : mixed

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.

extObjContent()  : mixed

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

generateMenu()  : mixed

Generate the ModuleMenu

getBackendUser()  : BackendUserAuthentication

getButtons()  : mixed

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

getExternalItemConfig()  : mixed

Returns configuration values from the global variable $TBE_MODULES_EXT for the module given.

getFluidTemplateObject()  : StandaloneView

returns a new standalone view, shorthand function

getLanguageService()  : LanguageService

handleExternalFunctionValue()  : mixed

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

init()  : mixed

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

main()  : mixed

Initialize module header etc and call extObjContent function

menuConfig()  : mixed

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.

mergeExternalItems()  : array<string|int, mixed>

Merges menu items from global array $TBE_MODULES_EXT