Module extends BaseModule implements ModuleInterface
A standard backend nodule
Table of Contents
Interfaces
- ModuleInterface
- An interface representing a TYPO3 Backend module.
Properties
- $absolutePackagePath : string
- $access : string
- $aliases : array<string|int, mixed>
- $appearance : array<string|int, mixed>
- $component : string
- $defaultModuleData : array<string|int, mixed>
- $description : string
- $iconIdentifier : string
- $identifier : string
- $inheritNavigationComponent : bool
- $navigationComponent : string
- $packageName : string
- $parent : string
- $parentModule : ModuleInterface|null
- $path : string
- $position : array<string|int, mixed>
- $routeOptions : array<string|int, mixed>
- $routes : array<string|int, mixed>
- $shortDescription : string
- $standalone : bool
- $subModules : array<string, ModuleInterface>
- $title : string
- $workspaceAccess : string
Methods
- addSubModule() : void
- createFromConfiguration() : static
- getAccess() : string
- getAliases() : array<string|int, mixed>
- getAppearance() : array<string|int, mixed>
- getComponent() : string
- getDefaultModuleData() : array<string|int, mixed>
- getDefaultRouteOptions() : array<string|int, mixed>
- getDescription() : string
- getIconIdentifier() : string
- getIdentifier() : string
- getNavigationComponent() : string
- getParentIdentifier() : string
- getParentModule() : ModuleInterface|null
- getPath() : string
- getPosition() : array<string|int, mixed>
- getRoutes() : array<string|int, mixed>
- getShortDescription() : string
- getSubModule() : ModuleInterface|null
- getSubModules() : array<string, ModuleInterface>
- getTitle() : string
- getWorkspaceAccess() : string
- hasParentModule() : bool
- hasSubModule() : bool
- hasSubModules() : bool
- isStandalone() : bool
- removeSubModule() : void
- setParentModule() : void
- __construct() : mixed
Properties
$absolutePackagePath
protected
string
$absolutePackagePath
= ''
$access
protected
string
$access
= ''
$aliases
protected
array<string|int, mixed>
$aliases
= []
$appearance
protected
array<string|int, mixed>
$appearance
= []
$component
protected
string
$component
= '@typo3/backend/module/iframe'
$defaultModuleData
protected
array<string|int, mixed>
$defaultModuleData
= []
$description
protected
string
$description
= ''
$iconIdentifier
protected
string
$iconIdentifier
= ''
$identifier
protected
string
$identifier
$inheritNavigationComponent
protected
bool
$inheritNavigationComponent
= true
$navigationComponent
protected
string
$navigationComponent
= ''
$packageName
protected
string
$packageName
= ''
$parent
protected
string
$parent
= ''
$parentModule
protected
ModuleInterface|null
$parentModule
= null
$path
protected
string
$path
= ''
$position
protected
array<string|int, mixed>
$position
= []
$routeOptions
protected
array<string|int, mixed>
$routeOptions
= []
$routes
protected
array<string|int, mixed>
$routes
$shortDescription
protected
string
$shortDescription
= ''
$standalone
protected
bool
$standalone
= false
$subModules
protected
array<string, ModuleInterface>
$subModules
= []
$title
protected
string
$title
= ''
$workspaceAccess
protected
string
$workspaceAccess
= ''
Methods
addSubModule()
public
addSubModule(ModuleInterface $module) : void
Parameters
- $module : ModuleInterface
createFromConfiguration()
public
static createFromConfiguration(string $identifier, array<string|int, mixed> $configuration) : static
Parameters
- $identifier : string
- $configuration : array<string|int, mixed>
Return values
staticgetAccess()
public
getAccess() : string
Return values
stringgetAliases()
public
getAliases() : array<string|int, mixed>
Return values
array<string|int, mixed>getAppearance()
public
getAppearance() : array<string|int, mixed>
Return values
array<string|int, mixed>getComponent()
public
getComponent() : string
Return values
stringgetDefaultModuleData()
public
getDefaultModuleData() : array<string|int, mixed>
Return values
array<string|int, mixed>getDefaultRouteOptions()
public
getDefaultRouteOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getDescription()
public
getDescription() : string
Return values
stringgetIconIdentifier()
public
getIconIdentifier() : string
Return values
stringgetIdentifier()
public
getIdentifier() : string
Return values
stringgetNavigationComponent()
public
getNavigationComponent() : string
Return values
stringgetParentIdentifier()
public
getParentIdentifier() : string
Return values
stringgetParentModule()
public
getParentModule() : ModuleInterface|null
Return values
ModuleInterface|nullgetPath()
public
getPath() : string
Return values
stringgetPosition()
public
getPosition() : array<string|int, mixed>
Return values
array<string|int, mixed>getRoutes()
public
getRoutes() : array<string|int, mixed>
Return values
array<string|int, mixed>getShortDescription()
public
getShortDescription() : string
Return values
stringgetSubModule()
public
getSubModule(string $identifier) : ModuleInterface|null
Parameters
- $identifier : string
Return values
ModuleInterface|nullgetSubModules()
public
getSubModules() : array<string, ModuleInterface>
Return values
array<string, ModuleInterface>getTitle()
public
getTitle() : string
Return values
stringgetWorkspaceAccess()
public
getWorkspaceAccess() : string
Return values
stringhasParentModule()
public
hasParentModule() : bool
Return values
boolhasSubModule()
public
hasSubModule(string $identifier) : bool
Parameters
- $identifier : string
Return values
boolhasSubModules()
public
hasSubModules() : bool
Return values
boolisStandalone()
public
isStandalone() : bool
Return values
boolremoveSubModule()
public
removeSubModule(string $identifier) : void
Parameters
- $identifier : string
setParentModule()
public
setParentModule(ModuleInterface $module) : void
Parameters
- $module : ModuleInterface
__construct()
protected
final __construct(string $identifier) : mixed
Parameters
- $identifier : string