TYPO3\CMS\Backend\Module\ModuleInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Backend\Module\ModuleInterface:

Public Member Functions
	getIdentifier ()
	getPath ()
	getIconIdentifier ()
	getTitle ()
	getDescription ()
	getShortDescription ()
	isStandalone ()
	getComponent ()
	getNavigationComponent ()
	getPosition ()
	getAppearance ()
	getAccess ()
	getWorkspaceAccess ()
	getParentIdentifier ()
	setParentModule (ModuleInterface $module)
	getParentModule ()
	hasParentModule ()
	addSubModule (ModuleInterface $module)
	removeSubModule (string $identifier)
	hasSubModule (string $identifier)
	hasSubModules ()
	getSubModule (string $identifier)
ModuleInterface[]	getSubModules ()
	getDefaultRouteOptions ()
	getDefaultModuleData ()
	getAliases ()

Detailed Description

An interface representing a TYPO3 Backend module.

Definition at line 23 of file ModuleInterface.php.

Member Function Documentation

addSubModule()

TYPO3\CMS\Backend\Module\ModuleInterface::addSubModule

(

ModuleInterface

$module

)

Used to set another module as part of the parent module

Might vanish soon

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

getAccess()

TYPO3\CMS\Backend\Module\ModuleInterface::getAccess

(

)

Can be user (editor permissions), admin, or systemMaintainer

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

Referenced by TYPO3\CMS\Backend\Module\ModuleProvider\getUserModules().

getAliases()

TYPO3\CMS\Backend\Module\ModuleInterface::getAliases

(

)

Return a list of identifiers that are aliases to this module

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

getAppearance()

TYPO3\CMS\Backend\Module\ModuleInterface::getAppearance

(

)

Returns a modules appearance options, e.g. used for module menu

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

getComponent()

TYPO3\CMS\Backend\Module\ModuleInterface::getComponent

(

)

Returns the view component responsible for rendering the module (iFrame or name of the web component)

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

getDefaultModuleData()

TYPO3\CMS\Backend\Module\ModuleInterface::getDefaultModuleData

(

)

Get allowed and available module data properties and their default values.

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

Referenced by TYPO3\CMS\Backend\Module\ModuleData\createFromModule().

getDefaultRouteOptions()

TYPO3\CMS\Backend\Module\ModuleInterface::getDefaultRouteOptions

(

)

Returns module related route options - used for the router

Implemented in TYPO3\CMS\Backend\Module\MenuModule, TYPO3\CMS\Backend\Module\ExtbaseModule, and TYPO3\CMS\Backend\Module\Module.

getDescription()

TYPO3\CMS\Backend\Module\ModuleInterface::getDescription

(

)

A longer description, common for the "About" section with a long explanation

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

getIconIdentifier()

TYPO3\CMS\Backend\Module\ModuleInterface::getIconIdentifier

(

)

The icon identifier for the module

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

getIdentifier()

TYPO3\CMS\Backend\Module\ModuleInterface::getIdentifier

(

)

The internal name of the module, used for referencing in permissions etc

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

Referenced by TYPO3\CMS\Backend\Module\ModuleRegistry\addModule(), TYPO3\CMS\Backend\Module\MenuModule\addSubModule(), TYPO3\CMS\Backend\Module\BaseModule\addSubModule(), TYPO3\CMS\Backend\Module\ModuleData\createFromModule(), TYPO3\CMS\Backend\Controller\PageTsConfig\PageTsConfigRecordsOverviewController\getButtons(), TYPO3\CMS\Backend\Module\ModuleProvider\getFirstAccessibleModule(), TYPO3\CMS\Backend\Controller\PageTsConfig\PageTsConfigRecordsOverviewController\getList(), TYPO3\CMS\Backend\Module\ModuleProvider\getModules(), and TYPO3\CMS\Backend\Middleware\BackendModuleValidator\validateModuleAccess().

getNavigationComponent()

TYPO3\CMS\Backend\Module\ModuleInterface::getNavigationComponent

(

)

The web component to be rendering the navigation area

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

getParentIdentifier()

TYPO3\CMS\Backend\Module\ModuleInterface::getParentIdentifier

(

)

The identifier of the parent module during registration

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

Referenced by TYPO3\CMS\Backend\Module\ModuleRegistry\applyHierarchy().

getParentModule()

TYPO3\CMS\Backend\Module\ModuleInterface::getParentModule

(

)

Get the reference to the next upper menu item

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

Referenced by TYPO3\CMS\Backend\Module\MenuModule\getParentModule().

getPath()

TYPO3\CMS\Backend\Module\ModuleInterface::getPath

(

)

Return the main route path

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

getPosition()

TYPO3\CMS\Backend\Module\ModuleInterface::getPosition

(

)

The position of the module, such as [top] or [bottom] or [after => anotherModule] or [before => anotherModule]

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

getShortDescription()

TYPO3\CMS\Backend\Module\ModuleInterface::getShortDescription

(

)

A shorter description, used when hovering over a module in the menu as title attribute

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

getSubModule()

TYPO3\CMS\Backend\Module\ModuleInterface::getSubModule

(

string

$identifier

)

Return a submodule given by its full identifier

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

getSubModules()

ModuleInterface [] TYPO3\CMS\Backend\Module\ModuleInterface::getSubModules

(

)

Return all direct descendants of this module

Returns

‪ModuleInterface[]

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

Referenced by TYPO3\CMS\Backend\Module\Module\getDefaultRouteOptions(), and TYPO3\CMS\Backend\Module\ModuleProvider\getModules().

getTitle()

TYPO3\CMS\Backend\Module\ModuleInterface::getTitle

(

)

The title of the module, used in the menu

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

Referenced by TYPO3\CMS\Backend\Middleware\BackendModuleValidator\enqueueRedirectMessage(), TYPO3\CMS\Backend\Controller\BackendController\enqueueRedirectMessage(), and TYPO3\CMS\Backend\Controller\PageTsConfig\PageTsConfigRecordsOverviewController\getButtons().

getWorkspaceAccess()

TYPO3\CMS\Backend\Module\ModuleInterface::getWorkspaceAccess

(

)

Can be "*" (= empty) or "live" or "offline"

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

hasParentModule()

TYPO3\CMS\Backend\Module\ModuleInterface::hasParentModule

(

)

Can be checked if the module is a "main module"

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

Referenced by TYPO3\CMS\Backend\Module\ModuleProvider\getFirstAccessibleModule(), and TYPO3\CMS\Backend\Module\ModuleProvider\getModules().

hasSubModule()

TYPO3\CMS\Backend\Module\ModuleInterface::hasSubModule

(

string

$identifier

)

Checks whether this module has a submodule with the given identifier

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

hasSubModules()

TYPO3\CMS\Backend\Module\ModuleInterface::hasSubModules

(

)

Checks if this module has further submodules

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

isStandalone()

TYPO3\CMS\Backend\Module\ModuleInterface::isStandalone

(

)

Useful for main modules that are also "clickable" such as the dashboard module

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

Referenced by TYPO3\CMS\Backend\Module\ModuleProvider\getFirstAccessibleModule().

removeSubModule()

TYPO3\CMS\Backend\Module\ModuleInterface::removeSubModule

(

string

$identifier

)

Remove a submodule

Might vanish soon

Implemented in TYPO3\CMS\Backend\Module\MenuModule.

Referenced by TYPO3\CMS\Backend\Module\ModuleProvider\getModule(), and TYPO3\CMS\Backend\Module\ModuleProvider\getModules().

setParentModule()

TYPO3\CMS\Backend\Module\ModuleInterface::setParentModule

(

ModuleInterface

$module

)

Set a reference to the next upper menu item

Might vanish soon

Implemented in TYPO3\CMS\Backend\Module\MenuModule.