ExtbaseModule extends BaseModule implements ModuleInterface

An extbase built backend module

Internal

only for use within TYPO3 Core.

Table of Contents

Interfaces

ModuleInterface
An interface representing a TYPO3 Backend module.

Properties

$absolutePackagePath  : string
$access  : string
Access is restricted to "admin" by default for extbase modules
$aliases  : array<string|int, mixed>
$appearance  : array<string|int, mixed>
$component  : string
$controllerActions  : array<string|int, mixed>
$defaultModuleData  : array<string|int, mixed>
$description  : string
$extensionName  : string
$iconIdentifier  : string
$identifier  : string
$inheritNavigationComponent  : bool
$navigationComponent  : string
$packageName  : string
$parent  : string
Extbase modules always need a parent, use "web" as default
$parentModule  : ModuleInterface|null
$path  : string
$position  : array<string|int, mixed>
$routeOptions  : 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
getControllerActions()  : array<string|int, mixed>
getDefaultModuleData()  : array<string|int, mixed>
getDefaultRouteOptions()  : array<string|int, mixed>
getDescription()  : string
getExtensionName()  : string
getIconIdentifier()  : string
getIdentifier()  : string
getNavigationComponent()  : string
getParentIdentifier()  : string
getParentModule()  : ModuleInterface|null
getPath()  : string
getPosition()  : 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
sanitizeControllerActions()  : array<string|int, mixed>
sanitizeExtensionName()  : string

Properties

$absolutePackagePath

protected string $absolutePackagePath = ''

$access

Access is restricted to "admin" by default for extbase modules

protected string $access = 'admin'

$aliases

protected array<string|int, mixed> $aliases = []

$appearance

protected array<string|int, mixed> $appearance = []

$component

protected string $component = '@typo3/backend/module/iframe'

$controllerActions

protected array<string|int, mixed> $controllerActions

$defaultModuleData

protected array<string|int, mixed> $defaultModuleData = []

$description

protected string $description = ''

$extensionName

protected string $extensionName

$iconIdentifier

protected string $iconIdentifier = ''

$inheritNavigationComponent

protected bool $inheritNavigationComponent = true

$navigationComponent

protected string $navigationComponent = ''

$packageName

protected string $packageName = ''

$parent

Extbase modules always need a parent, use "web" as default

protected string $parent = 'web'

$position

protected array<string|int, mixed> $position = []

$routeOptions

protected array<string|int, mixed> $routeOptions = []

$shortDescription

protected string $shortDescription = ''

$standalone

protected bool $standalone = false

$workspaceAccess

protected string $workspaceAccess = ''

Methods

createFromConfiguration()

public static createFromConfiguration(string $identifier, array<string|int, mixed> $configuration) : static
Parameters
$identifier : string
$configuration : array<string|int, mixed>
Return values
static

getAccess()

public getAccess() : string
Return values
string

getAliases()

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
string

getControllerActions()

public getControllerActions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDefaultModuleData()

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
string

getExtensionName()

public getExtensionName() : string
Return values
string

getIconIdentifier()

public getIconIdentifier() : string
Return values
string

getIdentifier()

public getIdentifier() : string
Return values
string

getNavigationComponent()

public getNavigationComponent() : string
Return values
string

getParentIdentifier()

public getParentIdentifier() : string
Return values
string

getPath()

public getPath() : string
Return values
string

getPosition()

public getPosition() : array<string|int, mixed>
Return values
array<string|int, mixed>

getShortDescription()

public getShortDescription() : string
Return values
string

getTitle()

public getTitle() : string
Return values
string

getWorkspaceAccess()

public getWorkspaceAccess() : string
Return values
string

hasParentModule()

public hasParentModule() : bool
Return values
bool

hasSubModule()

public hasSubModule(string $identifier) : bool
Parameters
$identifier : string
Return values
bool

hasSubModules()

public hasSubModules() : bool
Return values
bool

isStandalone()

public isStandalone() : bool
Return values
bool

removeSubModule()

public removeSubModule(string $identifier) : void
Parameters
$identifier : string

__construct()

protected final __construct(string $identifier) : mixed
Parameters
$identifier : string

sanitizeControllerActions()

protected static sanitizeControllerActions(array<string|int, mixed> $controllerActions) : array<string|int, mixed>
Parameters
$controllerActions : array<string|int, mixed>
Return values
array<string|int, mixed>

sanitizeExtensionName()

protected static sanitizeExtensionName(string $extensionName) : string
Parameters
$extensionName : string
Return values
string 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results