ModuleInterface

interface \TYPO3\CMS\Backend\Module\ModuleInterface

An interface representing a TYPO3 Backend module.

Table of Contents

Methods

addSubModule()  : void
Used to set another module as part of the parent module
getAccess()  : string
Can be user (editor permissions), admin, or systemMaintainer
getAliases()  : array
Return a list of identifiers that are aliases to this module
getAppearance()  : array
Returns a modules appearance options, e.g. used for module menu
getComponent()  : string
Returns the view component responsible for rendering the module (iFrame or name of the web component)
getDefaultModuleData()  : array
Get allowed and available module data properties and their default values.
getDefaultRouteOptions()  : array
Returns module related route options - used for the router
getDescription()  : string
A longer description, common for the "About" section with a long explanation
getIconIdentifier()  : string
The icon identifier for the module
getIdentifier()  : string
The internal name of the module, used for referencing in permissions etc
getNavigationComponent()  : string
The web component to be rendering the navigation area
getParentIdentifier()  : string
The identifier of the parent module during registration
getParentModule()  : ModuleInterface|null
Get the reference to the next upper menu item
getPath()  : string
Return the main route path
getPosition()  : array
The position of the module, such as [top] or [bottom] or [after => anotherModule] or [before => anotherModule]
getShortDescription()  : string
A shorter description, used when hovering over a module in the menu as title attribute
getSubModule()  : ModuleInterface|null
Return a submodule given by its full identifier
getSubModules()  : ModuleInterface[]
Return all direct descendants of this module
getTitle()  : string
The title of the module, used in the menu
getWorkspaceAccess()  : string
Can be "*" (= empty) or "live" or "offline"
hasParentModule()  : bool
Can be checked if the module is a "main module"
hasSubModule()  : bool
Checks whether this module has a submodule with the given identifier
hasSubmoduleOverview()  : bool
Whether this module should display a card-based overview of its submodules instead of automatically routing to the first available submodule.
hasSubModules()  : bool
Checks if this module has further submodules
isStandalone()  : bool
Useful for main modules that are also "clickable" such as the dashboard module
removeSubModule()  : void
Remove a submodule
setParentModule()  : void
Set a reference to the next upper menu item

Methods

getAccess()

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

public getAccess() : string

Return values

string

getAliases()

Return a list of identifiers that are aliases to this module

public getAliases() : array

Return values

array

getAppearance()

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

public getAppearance() : array

Return values

array

getComponent()

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

public getComponent() : string

Return values

string

getDefaultModuleData()

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

public getDefaultModuleData() : array

Return values

array

getDefaultRouteOptions()

Returns module related route options - used for the router

public getDefaultRouteOptions() : array

Return values

array

getDescription()

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

public getDescription() : string

Return values

string

getIconIdentifier()

The icon identifier for the module

public getIconIdentifier() : string

Return values

string

getIdentifier()

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

public getIdentifier() : string

Return values

string

getNavigationComponent()

The web component to be rendering the navigation area

public getNavigationComponent() : string

Return values

string

getParentIdentifier()

The identifier of the parent module during registration

public getParentIdentifier() : string

Return values

string

getPath()

Return the main route path

public getPath() : string

Return values

string

getPosition()

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

public getPosition() : array

Return values

array

getShortDescription()

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

public getShortDescription() : string

Return values

string

getSubModule()

Return a submodule given by its full identifier

public getSubModule(string $identifier) : ModuleInterface|null

Parameters

$identifier : string

Return values

ModuleInterface|null

getTitle()

The title of the module, used in the menu

public getTitle() : string

Return values

string

getWorkspaceAccess()

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

public getWorkspaceAccess() : string

Return values

string

hasParentModule()

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

public hasParentModule() : bool

Return values

bool

hasSubModule()

Checks whether this module has a submodule with the given identifier

public hasSubModule(string $identifier) : bool

Parameters

$identifier : string

Return values

bool

hasSubmoduleOverview()

Whether this module should display a card-based overview of its submodules instead of automatically routing to the first available submodule.

public hasSubmoduleOverview() : bool

Return values

bool

hasSubModules()

Checks if this module has further submodules

public hasSubModules() : bool

Return values

bool

isStandalone()

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

public isStandalone() : bool

Return values

bool

removeSubModule()

Remove a submodule

public removeSubModule(string $identifier) : void

Parameters

$identifier : string
On this page