‪TYPO3CMS  ‪main
Public Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Backend\Module\MenuModule Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Module\MenuModule:
TYPO3\CMS\Backend\Module\ModuleInterface

Public Member Functions

 __construct (protected readonly ModuleInterface $module, protected $isCollapsed=false)
 
 getIdentifier ()
 
 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 ()
 
 getPath ()
 
 getDefaultRouteOptions ()
 
 getDefaultModuleData ()
 
 getAliases ()
 
 isCollapsed ()
 
 getIsCollapsed ()
 
 getShouldBeLinked ()
 

Protected Attributes

array $subModules = []
 

Detailed Description

A representation for a module used for the menu generation.

only to be used by TYPO3 Core.

Definition at line 25 of file MenuModule.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Module\MenuModule::__construct ( protected readonly ModuleInterface  $module,
protected  $isCollapsed = false 
)

Definition at line 32 of file MenuModule.php.

Member Function Documentation

◆ addSubModule()

TYPO3\CMS\Backend\Module\MenuModule::addSubModule ( ModuleInterface  $module)

Used to set another module as part of the parent module

Might vanish soon

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 114 of file MenuModule.php.

References TYPO3\CMS\Backend\Module\ModuleInterface\getIdentifier().

◆ getAccess()

TYPO3\CMS\Backend\Module\MenuModule::getAccess ( )

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

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 84 of file MenuModule.php.

◆ getAliases()

TYPO3\CMS\Backend\Module\MenuModule::getAliases ( )

Return a list of identifiers that are aliases to this module

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 162 of file MenuModule.php.

◆ getAppearance()

TYPO3\CMS\Backend\Module\MenuModule::getAppearance ( )

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

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 79 of file MenuModule.php.

◆ getComponent()

TYPO3\CMS\Backend\Module\MenuModule::getComponent ( )

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

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 64 of file MenuModule.php.

◆ getDefaultModuleData()

TYPO3\CMS\Backend\Module\MenuModule::getDefaultModuleData ( )

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

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 157 of file MenuModule.php.

◆ getDefaultRouteOptions()

TYPO3\CMS\Backend\Module\MenuModule::getDefaultRouteOptions ( )

Returns module related route options - used for the router

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 152 of file MenuModule.php.

◆ getDescription()

TYPO3\CMS\Backend\Module\MenuModule::getDescription ( )

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

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 49 of file MenuModule.php.

◆ getIconIdentifier()

TYPO3\CMS\Backend\Module\MenuModule::getIconIdentifier ( )

The icon identifier for the module

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 39 of file MenuModule.php.

◆ getIdentifier()

TYPO3\CMS\Backend\Module\MenuModule::getIdentifier ( )

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

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 34 of file MenuModule.php.

◆ getIsCollapsed()

TYPO3\CMS\Backend\Module\MenuModule::getIsCollapsed ( )

Definition at line 172 of file MenuModule.php.

References TYPO3\CMS\Backend\Module\MenuModule\isCollapsed().

◆ getNavigationComponent()

TYPO3\CMS\Backend\Module\MenuModule::getNavigationComponent ( )

The web component to be rendering the navigation area

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 69 of file MenuModule.php.

◆ getParentIdentifier()

TYPO3\CMS\Backend\Module\MenuModule::getParentIdentifier ( )

The identifier of the parent module during registration

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 94 of file MenuModule.php.

◆ getParentModule()

TYPO3\CMS\Backend\Module\MenuModule::getParentModule ( )

Get the reference to the next upper menu item

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 104 of file MenuModule.php.

References TYPO3\CMS\Backend\Module\ModuleInterface\getParentModule().

◆ getPath()

TYPO3\CMS\Backend\Module\MenuModule::getPath ( )

Return the main route path

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 147 of file MenuModule.php.

◆ getPosition()

TYPO3\CMS\Backend\Module\MenuModule::getPosition ( )

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

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 74 of file MenuModule.php.

◆ getShortDescription()

TYPO3\CMS\Backend\Module\MenuModule::getShortDescription ( )

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

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 54 of file MenuModule.php.

◆ getShouldBeLinked()

TYPO3\CMS\Backend\Module\MenuModule::getShouldBeLinked ( )

Definition at line 177 of file MenuModule.php.

◆ getSubModule()

TYPO3\CMS\Backend\Module\MenuModule::getSubModule ( string  $identifier)

Return a submodule given by its full identifier

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 134 of file MenuModule.php.

References TYPO3\CMS\Webhooks\Message\$identifier.

◆ getSubModules()

ModuleInterface [] TYPO3\CMS\Backend\Module\MenuModule::getSubModules ( )
Returns
‪ModuleInterface[]

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 142 of file MenuModule.php.

References TYPO3\CMS\Backend\Module\MenuModule\$subModules.

◆ getTitle()

TYPO3\CMS\Backend\Module\MenuModule::getTitle ( )

The title of the module, used in the menu

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 44 of file MenuModule.php.

◆ getWorkspaceAccess()

TYPO3\CMS\Backend\Module\MenuModule::getWorkspaceAccess ( )

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

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 89 of file MenuModule.php.

◆ hasParentModule()

TYPO3\CMS\Backend\Module\MenuModule::hasParentModule ( )

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

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 109 of file MenuModule.php.

◆ hasSubModule()

TYPO3\CMS\Backend\Module\MenuModule::hasSubModule ( string  $identifier)

Checks whether this module has a submodule with the given identifier

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 124 of file MenuModule.php.

References TYPO3\CMS\Webhooks\Message\$identifier.

◆ hasSubModules()

TYPO3\CMS\Backend\Module\MenuModule::hasSubModules ( )

Checks if this module has further submodules

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 129 of file MenuModule.php.

Referenced by TYPO3\CMS\Backend\Backend\ToolbarItems\HelpToolbarItem\__construct().

◆ isCollapsed()

TYPO3\CMS\Backend\Module\MenuModule::isCollapsed ( )

Definition at line 167 of file MenuModule.php.

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

◆ isStandalone()

TYPO3\CMS\Backend\Module\MenuModule::isStandalone ( )

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

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 59 of file MenuModule.php.

◆ removeSubModule()

TYPO3\CMS\Backend\Module\MenuModule::removeSubModule ( string  $identifier)

Remove a submodule

Might vanish soon

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 119 of file MenuModule.php.

References TYPO3\CMS\Webhooks\Message\$identifier.

◆ setParentModule()

TYPO3\CMS\Backend\Module\MenuModule::setParentModule ( ModuleInterface  $module)

Set a reference to the next upper menu item

Might vanish soon

Implements TYPO3\CMS\Backend\Module\ModuleInterface.

Definition at line 99 of file MenuModule.php.

Member Data Documentation

◆ $subModules

array TYPO3\CMS\Backend\Module\MenuModule::$subModules = []
protected

Definition at line 30 of file MenuModule.php.

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