ModuleInterface¶
The registered backend modules are stored as objects in a registry and can be
fetched using the \TYPO3\CMS\Backend\Module\ModuleProvider.
All module objects implement the \TYPO3\CMS\Backend\Module\ModuleInterface.
The ModuleInterface basically provides getters for the options
defined in the module registration and additionally provides methods for
relation handling (main modules and sub modules).
Table of contents
ModuleInterface API¶
- interface ModuleInterface ¶
-
- Fully qualified name
- \TYPO3\CMS\Backend\Module\ModuleInterface
An interface representing a TYPO3 Backend module.
- getIdentifier ( ) ¶
-
The internal name of the module, used for referencing in permissions etc
- Returns
-
string
- getPath ( ) ¶
-
Return the main route path
- Returns
-
string
- getIconIdentifier ( ) ¶
-
The icon identifier for the module
- Returns
-
string
- getTitle ( ) ¶
-
The title of the module, used in the menu
- Returns
-
string
- getDescription ( ) ¶
-
A longer description, common for the "About" section with a long explanation
- Returns
-
string
- getShortDescription ( ) ¶
-
A shorter description, used when hovering over a module in the menu as title attribute
- Returns
-
string
- isStandalone ( ) ¶
-
Useful for main modules that are also "clickable" such as the dashboard module
- Returns
-
bool
- getComponent ( ) ¶
-
Returns the view component responsible for rendering the module (iFrame or name of the web component)
- Returns
-
string
-
The web component to be rendering the navigation area
- Returns
-
string
- getPosition ( ) ¶
-
The position of the module, such as [top] or [bottom] or [after => anotherModule] or [before => anotherModule]
- Returns
-
array
- getAppearance ( ) ¶
-
Returns a modules appearance options, e.g. used for module menu
- Returns
-
array
- getAccess ( ) ¶
-
Can be user (editor permissions), admin, or systemMaintainer
- Returns
-
string
- getWorkspaceAccess ( ) ¶
-
Can be "*" (= empty) or "live" or "offline"
- Returns
-
string
- getParentIdentifier ( ) ¶
-
The identifier of the parent module during registration
- Returns
-
string
- getParentModule ( ) ¶
-
Get the reference to the next upper menu item
- Returns
-
?\TYPO3\CMS\Backend\Module\ModuleInterface
- hasParentModule ( ) ¶
-
Can be checked if the module is a "main module"
- Returns
-
bool
- hasSubModule ( string $identifier) ¶
-
Checks whether this module has a submodule with the given identifier
- param $identifier
-
the identifier
- Returns
-
bool
- hasSubModules ( ) ¶
-
Checks if this module has further submodules
- Returns
-
bool
- getSubModule ( string $identifier) ¶
-
Return a submodule given by its full identifier
- param $identifier
-
the identifier
- Returns
-
?\TYPO3\CMS\Backend\Module\ModuleInterface
- getSubModules ( ) ¶
-
Return all direct descendants of this module
- Returns
-
\ModuleInterface[]
- getDefaultRouteOptions ( ) ¶
-
Returns module related route options - used for the router
- Returns
-
array
- getDefaultModuleData ( ) ¶
-
Get allowed and available module data properties and their default values.
- Returns
-
array
- getAliases ( ) ¶
-
Return a list of identifiers that are aliases to this module
- Returns
-
array