BackendModule
Model for menu entries
Table of Contents
Properties
- $children : SplObjectStorage
- $collapsed : bool
- $component : string
- $description : string
- $icon : string
- $link : string
- $name : string
- $navigationComponentId : string
- $navigationFrameScript : string
- $navigationFrameScriptParameters : string
- $onClick : string
- $standalone : bool
- Standalone modules are top-level modules without a group
- $title : string
Methods
- __construct() : mixed
- construct
- addChild() : mixed
- Add Child
- getChildren() : SplObjectStorage
- Get children
- getCollapsed() : bool
- getComponent() : string
- Get Component
- getDescription() : string
- Get Description
- getIcon() : string
- Get icon
- getLink() : string
- Get Link
- getName() : string
- Get name
- getNavigationComponentId() : string
- Get Navigation Component Id
- getNavigationFrameScript() : string
- getNavigationFrameScriptParameters() : string
- getOnClick() : string
- Get onClick
- getTitle() : string
- Get Title
- isStandalone() : bool
- setChildren() : mixed
- Set children
- setCollapsed() : void
- setComponent() : mixed
- Set Component
- setDescription() : mixed
- Set Description
- setIcon() : mixed
- Set icon
- setLink() : mixed
- Set Link
- setName() : mixed
- Set name
- setNavigationComponentId() : mixed
- Set Navigation Component Id
- setNavigationFrameScript() : mixed
- setNavigationFrameScriptParameters() : mixed
- setOnClick() : mixed
- Set onClick
- setStandalone() : void
- setTitle() : mixed
- Set title
Properties
$children
protected
SplObjectStorage
$children
$collapsed
protected
bool
$collapsed
= false
$component
protected
string
$component
= ''
$description
protected
string
$description
= ''
$icon
protected
string
$icon
= ''
$link
protected
string
$link
= ''
$name
protected
string
$name
= ''
$navigationComponentId
protected
string
$navigationComponentId
= ''
$navigationFrameScript
since TYPO3 v11, will be removed in TYPO3 v12.0
protected
string
$navigationFrameScript
= ''
$navigationFrameScriptParameters
since TYPO3 v11, will be removed in TYPO3 v12.0
protected
string
$navigationFrameScriptParameters
= ''
$onClick
using inline JavaScript is deprecated, will be removed in TYPO3 v12.0
protected
string
$onClick
= ''
$standalone
Standalone modules are top-level modules without a group
protected
bool
$standalone
= false
$title
protected
string
$title
= ''
Methods
__construct()
construct
public
__construct() : mixed
addChild()
Add Child
public
addChild(BackendModule $child) : mixed
Parameters
- $child : BackendModule
getChildren()
Get children
public
getChildren() : SplObjectStorage
Return values
SplObjectStoragegetCollapsed()
public
getCollapsed() : bool
Return values
boolgetComponent()
Get Component
public
getComponent() : string
Return values
stringgetDescription()
Get Description
public
getDescription() : string
Return values
stringgetIcon()
Get icon
public
getIcon() : string
Return values
stringgetLink()
Get Link
public
getLink() : string
Return values
stringgetName()
Get name
public
getName() : string
Return values
stringgetNavigationComponentId()
Get Navigation Component Id
public
getNavigationComponentId() : string
Return values
stringgetNavigationFrameScript()
public
getNavigationFrameScript() : string
since TYPO3 v11, will be removed in TYPO3 v12.0
Return values
stringgetNavigationFrameScriptParameters()
public
getNavigationFrameScriptParameters() : string
since TYPO3 v11, will be removed in TYPO3 v12.0
Return values
stringgetOnClick()
Get onClick
public
getOnClick() : string
using inline JavaScript is deprecated, will be removed in TYPO3 v12.0
Return values
stringgetTitle()
Get Title
public
getTitle() : string
Return values
stringisStandalone()
public
isStandalone() : bool
Return values
boolsetChildren()
Set children
public
setChildren(SplObjectStorage $children) : mixed
Parameters
- $children : SplObjectStorage
setCollapsed()
public
setCollapsed(bool $collapsed) : void
Parameters
- $collapsed : bool
setComponent()
Set Component
public
setComponent(string $component) : mixed
Parameters
- $component : string
setDescription()
Set Description
public
setDescription(string $description) : mixed
Parameters
- $description : string
setIcon()
Set icon
public
setIcon(string $icon) : mixed
Parameters
- $icon : string
setLink()
Set Link
public
setLink(string $link) : mixed
Parameters
- $link : string
setName()
Set name
public
setName(string $name) : mixed
Parameters
- $name : string
setNavigationComponentId()
Set Navigation Component Id
public
setNavigationComponentId(string $navigationComponentId) : mixed
Parameters
- $navigationComponentId : string
setNavigationFrameScript()
public
setNavigationFrameScript(string $navigationFrameScript) : mixed
since TYPO3 v11, will be removed in TYPO3 v12.0
Parameters
- $navigationFrameScript : string
setNavigationFrameScriptParameters()
public
setNavigationFrameScriptParameters(string $navigationFrameScriptParameters) : mixed
since TYPO3 v11, will be removed in TYPO3 v12.0
Parameters
- $navigationFrameScriptParameters : string
setOnClick()
Set onClick
public
setOnClick(string $onClick) : mixed
using inline JavaScript is deprecated, will be removed in TYPO3 v12.0
Parameters
- $onClick : string
setStandalone()
public
setStandalone(bool $standalone) : void
Parameters
- $standalone : bool
setTitle()
Set title
public
setTitle(string $title) : mixed
Parameters
- $title : string