TYPO3\CMS\Backend\Module\BaseModule Class Reference

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

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

Static Public Member Functions
static	createFromConfiguration (string $identifier, array $configuration)

Public Attributes
array< string, function getSubModules():array { return $this->	subModules

Protected Member Functions
	__construct (string $identifier)

Protected Attributes
string	$identifier
string	$packageName = ''
string	$absolutePackagePath = ''
string	$path = ''
string	$iconIdentifier = ''
string	$title = ''
string	$description = ''
string	$shortDescription = ''
array	$position = []
array	$appearance = []
string	$access = ''
string	$workspaceAccess = ''
string	$parent = ''
ModuleInterface	$parentModule = null
array	$subModules = []
bool	$standalone = false
string	$component = '@typo3/backend/module/iframe'
string	$navigationComponent = ''
array	$defaultModuleData = []
array	$aliases = []
bool	$inheritNavigationComponent = true
array	$routeOptions = []

Detailed Description

The basic backend module, to be extended by more detailed implementations (e.g. ExtbaseModule)

Definition at line 25 of file BaseModule.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Module\BaseModule::__construct ( string  $identifier )

finalprotected

Definition at line 51 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$identifier.

Member Function Documentation

addSubModule()

TYPO3\CMS\Backend\Module\BaseModule::addSubModule

(

ModuleInterface

$module

)

Definition at line 141 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\ModuleInterface\getIdentifier(), and TYPO3\CMS\Backend\Module\BaseModule\subModules.

createFromConfiguration()

static TYPO3\CMS\Backend\Module\BaseModule::createFromConfiguration ( string  $identifier, array  $configuration  )

static

Reimplemented in TYPO3\CMS\Backend\Module\ExtbaseModule, and TYPO3\CMS\Backend\Module\Module.

Definition at line 191 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$identifier.

getAccess()

TYPO3\CMS\Backend\Module\BaseModule::getAccess

(

)

Definition at line 111 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$access.

getAliases()

TYPO3\CMS\Backend\Module\BaseModule::getAliases

(

)

Definition at line 179 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$aliases.

getAppearance()

TYPO3\CMS\Backend\Module\BaseModule::getAppearance

(

)

Definition at line 174 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$appearance.

getComponent()

TYPO3\CMS\Backend\Module\BaseModule::getComponent

(

)

Definition at line 101 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$component.

getDefaultModuleData()

TYPO3\CMS\Backend\Module\BaseModule::getDefaultModuleData

(

)

Definition at line 186 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$defaultModuleData.

getDefaultRouteOptions()

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

abstract

Reimplemented in TYPO3\CMS\Backend\Module\ExtbaseModule, and TYPO3\CMS\Backend\Module\Module.

getDescription()

TYPO3\CMS\Backend\Module\BaseModule::getDescription

(

)

Definition at line 76 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$description.

getIconIdentifier()

TYPO3\CMS\Backend\Module\BaseModule::getIconIdentifier

(

)

Definition at line 66 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$iconIdentifier.

getIdentifier()

TYPO3\CMS\Backend\Module\BaseModule::getIdentifier

(

)

Definition at line 56 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$identifier.

getNavigationComponent()

TYPO3\CMS\Backend\Module\BaseModule::getNavigationComponent

(

)

Definition at line 91 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$navigationComponent, TYPO3\CMS\Backend\Module\BaseModule\getParentModule(), and TYPO3\CMS\Backend\Module\BaseModule\hasParentModule().

getParentIdentifier()

TYPO3\CMS\Backend\Module\BaseModule::getParentIdentifier

(

)

Definition at line 121 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$parent.

getParentModule()

TYPO3\CMS\Backend\Module\BaseModule::getParentModule

(

)

Definition at line 131 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$parentModule.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\getNavigationComponent().

getPath()

TYPO3\CMS\Backend\Module\BaseModule::getPath

(

)

Definition at line 61 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$path.

getPosition()

TYPO3\CMS\Backend\Module\BaseModule::getPosition

(

)

Definition at line 106 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$position.

getShortDescription()

TYPO3\CMS\Backend\Module\BaseModule::getShortDescription

(

)

Definition at line 81 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$shortDescription.

getSubModule()

TYPO3\CMS\Backend\Module\BaseModule::getSubModule

(

string

$identifier

)

Definition at line 156 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$identifier, and TYPO3\CMS\Backend\Module\BaseModule\subModules.

getTitle()

TYPO3\CMS\Backend\Module\BaseModule::getTitle

(

)

Definition at line 71 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$title.

getWorkspaceAccess()

TYPO3\CMS\Backend\Module\BaseModule::getWorkspaceAccess

(

)

Definition at line 116 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$workspaceAccess.

hasParentModule()

TYPO3\CMS\Backend\Module\BaseModule::hasParentModule

(

)

Definition at line 136 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\getNavigationComponent().

hasSubModule()

TYPO3\CMS\Backend\Module\BaseModule::hasSubModule

(

string

$identifier

)

Definition at line 146 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\subModules.

hasSubModules()

TYPO3\CMS\Backend\Module\BaseModule::hasSubModules

(

)

Definition at line 151 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\subModules.

Referenced by TYPO3\CMS\Backend\Module\Module\getDefaultRouteOptions().

isStandalone()

TYPO3\CMS\Backend\Module\BaseModule::isStandalone

(

)

Definition at line 86 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\$standalone.

removeSubModule()

TYPO3\CMS\Backend\Module\BaseModule::removeSubModule

(

string

$identifier

)

Definition at line 161 of file BaseModule.php.

References TYPO3\CMS\Backend\Module\BaseModule\subModules.

setParentModule()

TYPO3\CMS\Backend\Module\BaseModule::setParentModule

(

ModuleInterface

$module

)

Definition at line 126 of file BaseModule.php.

Member Data Documentation

$absolutePackagePath

string TYPO3\CMS\Backend\Module\BaseModule::$absolutePackagePath = ''

protected

Definition at line 29 of file BaseModule.php.

$access

string TYPO3\CMS\Backend\Module\BaseModule::$access = ''

protected

Definition at line 37 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\getAccess().

$aliases

array TYPO3\CMS\Backend\Module\BaseModule::$aliases = []

protected

Definition at line 47 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\getAliases().

$appearance

array TYPO3\CMS\Backend\Module\BaseModule::$appearance = []

protected

Definition at line 36 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\getAppearance().

$component

string TYPO3\CMS\Backend\Module\BaseModule::$component = '@typo3/backend/module/iframe'

protected

Definition at line 44 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\getComponent().

$defaultModuleData

array TYPO3\CMS\Backend\Module\BaseModule::$defaultModuleData = []

protected

Definition at line 46 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\getDefaultModuleData().

$description

string TYPO3\CMS\Backend\Module\BaseModule::$description = ''

protected

Definition at line 33 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\getDescription().

$iconIdentifier

string TYPO3\CMS\Backend\Module\BaseModule::$iconIdentifier = ''

protected

Definition at line 31 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\getIconIdentifier().

$identifier

string TYPO3\CMS\Backend\Module\BaseModule::$identifier

protected

Definition at line 27 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\__construct(), TYPO3\CMS\Backend\Module\Module\createFromConfiguration(), TYPO3\CMS\Backend\Module\ExtbaseModule\createFromConfiguration(), TYPO3\CMS\Backend\Module\BaseModule\createFromConfiguration(), TYPO3\CMS\Backend\Module\BaseModule\getIdentifier(), and TYPO3\CMS\Backend\Module\BaseModule\getSubModule().

$inheritNavigationComponent

bool TYPO3\CMS\Backend\Module\BaseModule::$inheritNavigationComponent = true

protected

Definition at line 48 of file BaseModule.php.

$navigationComponent

string TYPO3\CMS\Backend\Module\BaseModule::$navigationComponent = ''

protected

Definition at line 45 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\getNavigationComponent().

$packageName

string TYPO3\CMS\Backend\Module\BaseModule::$packageName = ''

protected

Definition at line 28 of file BaseModule.php.

$parent

string TYPO3\CMS\Backend\Module\BaseModule::$parent = ''

protected

Definition at line 39 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\getParentIdentifier().

$parentModule

ModuleInterface TYPO3\CMS\Backend\Module\BaseModule::$parentModule = null

protected

Definition at line 40 of file BaseModule.php.

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

$path

string TYPO3\CMS\Backend\Module\BaseModule::$path = ''

protected

Definition at line 30 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\getPath().

$position

array TYPO3\CMS\Backend\Module\BaseModule::$position = []

protected

Definition at line 35 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\getPosition().

$routeOptions

array TYPO3\CMS\Backend\Module\BaseModule::$routeOptions = []

protected

Definition at line 49 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\Module\getDefaultRouteOptions().

$shortDescription

string TYPO3\CMS\Backend\Module\BaseModule::$shortDescription = ''

protected

Definition at line 34 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\getShortDescription().

$standalone

bool TYPO3\CMS\Backend\Module\BaseModule::$standalone = false

protected

Definition at line 43 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\isStandalone().

$subModules

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

protected

Definition at line 42 of file BaseModule.php.

$title

string TYPO3\CMS\Backend\Module\BaseModule::$title = ''

protected

Definition at line 32 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\getTitle().

$workspaceAccess

string TYPO3\CMS\Backend\Module\BaseModule::$workspaceAccess = ''

protected

Definition at line 38 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\getWorkspaceAccess().

subModules

array<string, function getSubModules(): array { return $this-> TYPO3\CMS\Backend\Module\BaseModule::subModules

Returns

‪array<string, ModuleInterface>

Definition at line 171 of file BaseModule.php.

Referenced by TYPO3\CMS\Backend\Module\BaseModule\addSubModule(), TYPO3\CMS\Backend\Module\BaseModule\getSubModule(), TYPO3\CMS\Backend\Module\BaseModule\hasSubModule(), TYPO3\CMS\Backend\Module\BaseModule\hasSubModules(), and TYPO3\CMS\Backend\Module\BaseModule\removeSubModule().