‪TYPO3CMS  10.4
Public Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Backend\Domain\Model\Module\BackendModule Class Reference

Public Member Functions

 __construct ()
 
 setChildren ($children)
 
SplObjectStorage getChildren ()
 
 addChild (\TYPO3\CMS\Backend\Domain\Model\Module\BackendModule $child)
 
 setIcon ($icon)
 
string getIcon ()
 
 setName ($name)
 
string getName ()
 
 setTitle ($title)
 
string getTitle ()
 
 setLink ($link)
 
string getLink ()
 
 setDescription ($description)
 
string getDescription ()
 
 setNavigationComponentId ($navigationComponentId)
 
string getNavigationComponentId ()
 
 setNavigationFrameScript ($navigationFrameScript)
 
string getNavigationFrameScript ()
 
 setNavigationFrameScriptParameters ($navigationFrameScriptParameters)
 
string getNavigationFrameScriptParameters ()
 
 setOnClick ($onClick)
 
string getOnClick ()
 
 setCollapsed (bool $collapsed)
 
 getCollapsed ()
 
bool isStandalone ()
 
 setStandalone (bool $standalone)
 

Protected Attributes

string $title = ''
 
string $name = ''
 
string $icon = ''
 
string $link = ''
 
string $onClick = ''
 
string $description = ''
 
string $navigationComponentId = ''
 
string $navigationFrameScript = ''
 
string $navigationFrameScriptParameters = ''
 
SplObjectStorage $children
 
bool $collapsed = false
 
bool $standalone = false
 

Detailed Description

Model for menu entries

Definition at line 21 of file BackendModule.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::__construct ( )

construct

Definition at line 76 of file BackendModule.php.

Member Function Documentation

◆ addChild()

TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::addChild ( \TYPO3\CMS\Backend\Domain\Model\Module\BackendModule  $child)

Add Child

Parameters
\TYPO3\CMS\Backend\Domain\Model\Module\BackendModule$child

Definition at line 106 of file BackendModule.php.

◆ getChildren()

SplObjectStorage TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::getChildren ( )

Get children

Returns
‪\SplObjectStorage

Definition at line 96 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$children.

Referenced by TYPO3\CMS\Backend\Backend\ToolbarItems\HelpToolbarItem\__construct(), and TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\findByModuleNameInGivenEntries().

◆ getCollapsed()

TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::getCollapsed ( )

Definition at line 288 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$collapsed.

◆ getDescription()

string TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::getDescription ( )

Get Description

Returns
‪string

Definition at line 206 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$description.

◆ getIcon()

string TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::getIcon ( )

Get icon

Returns
‪string

Definition at line 126 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$icon.

◆ getLink()

string TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::getLink ( )

Get Link

Returns
‪string

Definition at line 186 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$link.

◆ getName()

string TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::getName ( )

Get name

Returns
‪string

Definition at line 146 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$name.

◆ getNavigationComponentId()

string TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::getNavigationComponentId ( )

Get Navigation Component Id

Returns
‪string

Definition at line 226 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$navigationComponentId.

◆ getNavigationFrameScript()

string TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::getNavigationFrameScript ( )
Returns
‪string

Definition at line 242 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$navigationFrameScript.

◆ getNavigationFrameScriptParameters()

string TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::getNavigationFrameScriptParameters ( )
Returns
‪string

Definition at line 258 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$navigationFrameScriptParameters.

◆ getOnClick()

string TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::getOnClick ( )

Get onClick

Returns
‪string

Definition at line 278 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$onClick.

◆ getTitle()

string TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::getTitle ( )

Get Title

Returns
‪string

Definition at line 166 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$title.

◆ isStandalone()

bool TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::isStandalone ( )
Returns
‪bool

Definition at line 296 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$standalone.

◆ setChildren()

TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::setChildren (   $children)

Set children

Parameters
\SplObjectStorage$children

Definition at line 86 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$children.

◆ setCollapsed()

TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::setCollapsed ( bool  $collapsed)

Definition at line 283 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$collapsed.

◆ setDescription()

TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::setDescription (   $description)

Set Description

Parameters
string$description

Definition at line 196 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$description.

◆ setIcon()

TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::setIcon (   $icon)

Set icon

Parameters
string$icon

Definition at line 116 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$icon.

◆ setLink()

TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::setLink (   $link)

Set Link

Parameters
string$link

Definition at line 176 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$link.

◆ setName()

TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::setName (   $name)

Set name

Parameters
string$name

Definition at line 136 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$name.

◆ setNavigationComponentId()

TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::setNavigationComponentId (   $navigationComponentId)

Set Navigation Component Id

Parameters
string$navigationComponentId

Definition at line 216 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$navigationComponentId.

◆ setNavigationFrameScript()

TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::setNavigationFrameScript (   $navigationFrameScript)
Parameters
string$navigationFrameScript

Definition at line 234 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$navigationFrameScript.

◆ setNavigationFrameScriptParameters()

TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::setNavigationFrameScriptParameters (   $navigationFrameScriptParameters)
Parameters
string$navigationFrameScriptParameters

Definition at line 250 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$navigationFrameScriptParameters.

◆ setOnClick()

TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::setOnClick (   $onClick)

Set onClick

Parameters
string$onClick

Definition at line 268 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$onClick.

◆ setStandalone()

TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::setStandalone ( bool  $standalone)
Parameters
bool$standalone

Definition at line 304 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$standalone.

◆ setTitle()

TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::setTitle (   $title)

Set title

Parameters
string$title

Definition at line 156 of file BackendModule.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$title.

Member Data Documentation

◆ $children

SplObjectStorage TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::$children
protected

Definition at line 61 of file BackendModule.php.

Referenced by TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getChildren(), and TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setChildren().

◆ $collapsed

bool TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::$collapsed = false
protected

Definition at line 65 of file BackendModule.php.

Referenced by TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getCollapsed(), and TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setCollapsed().

◆ $description

string TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::$description = ''
protected

Definition at line 45 of file BackendModule.php.

Referenced by TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getDescription(), and TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setDescription().

◆ $icon

string TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::$icon = ''
protected

Definition at line 33 of file BackendModule.php.

Referenced by TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getIcon(), and TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setIcon().

◆ $link

string TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::$link = ''
protected

Definition at line 37 of file BackendModule.php.

Referenced by TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getLink(), and TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setLink().

◆ $name

string TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::$name = ''
protected

Definition at line 29 of file BackendModule.php.

Referenced by TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getName(), and TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setName().

◆ $navigationComponentId

string TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::$navigationComponentId = ''
protected

Definition at line 49 of file BackendModule.php.

Referenced by TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getNavigationComponentId(), and TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setNavigationComponentId().

◆ $navigationFrameScript

string TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::$navigationFrameScript = ''
protected

Definition at line 53 of file BackendModule.php.

Referenced by TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getNavigationFrameScript(), and TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setNavigationFrameScript().

◆ $navigationFrameScriptParameters

string TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::$navigationFrameScriptParameters = ''
protected

Definition at line 57 of file BackendModule.php.

Referenced by TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getNavigationFrameScriptParameters(), and TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setNavigationFrameScriptParameters().

◆ $onClick

string TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::$onClick = ''
protected

Definition at line 41 of file BackendModule.php.

Referenced by TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getOnClick(), and TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setOnClick().

◆ $standalone

bool TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::$standalone = false
protected

Standalone modules are top-level modules without a group

Definition at line 71 of file BackendModule.php.

Referenced by TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\isStandalone(), and TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setStandalone().

◆ $title

string TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::$title = ''
protected

Definition at line 25 of file BackendModule.php.

Referenced by TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getTitle(), and TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setTitle().