TYPO3 CMS  TYPO3_6-2
Public Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Backend\Domain\Model\Module\BackendModule Class Reference

Public Member Functions

 __construct ()
 
 setChildren ($children)
 
 getChildren ()
 
 addChild (\TYPO3\CMS\Backend\Domain\Model\Module\BackendModule $child)
 
 setIcon (array $icon)
 
 getIcon ()
 
 setName ($name)
 
 getName ()
 
 setTitle ($title)
 
 getTitle ()
 
 setLink ($link)
 
 getLink ()
 
 setDescription ($description)
 
 getDescription ()
 
 setNavigationComponentId ($navigationComponentId)
 
 getNavigationComponentId ()
 
 setOnClick ($onClick)
 
 getOnClick ()
 

Protected Attributes

 $title = ''
 
 $name = ''
 
 $icon = array()
 
 $link = ''
 
 $onClick = ''
 
 $description = ''
 
 $navigationComponentId = ''
 
 $children
 

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! Model for menu entries

Author
Susanne Moog typo3.nosp@m.@sus.nosp@m.annem.nosp@m.oog..nosp@m.de

Definition at line 22 of file BackendModule.php.

Constructor & Destructor Documentation

◆ __construct()

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

construct

Definition at line 67 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
Returns
void

Definition at line 96 of file BackendModule.php.

◆ getChildren()

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

Get children

Returns

Definition at line 86 of file BackendModule.php.

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

◆ getDescription()

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

Get Description

Returns
string

Definition at line 191 of file BackendModule.php.

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

◆ getIcon()

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

Get icon

Returns
array

Definition at line 115 of file BackendModule.php.

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

◆ getLink()

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

Get Link

Returns
string

Definition at line 172 of file BackendModule.php.

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

◆ getName()

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

Get name

Returns
string

Definition at line 134 of file BackendModule.php.

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

◆ getNavigationComponentId()

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

Get Navigation Component Id

Returns
string

Definition at line 210 of file BackendModule.php.

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

◆ getOnClick()

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

Get onClick

Returns
string

Definition at line 229 of file BackendModule.php.

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

◆ getTitle()

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

Get Title

Returns
string

Definition at line 153 of file BackendModule.php.

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

◆ setChildren()

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

Set children

Parameters
\SplObjectStorage$children
Returns
void

Definition at line 77 of file BackendModule.php.

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

◆ setDescription()

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

Set Description

Parameters
string$description
Returns
void

Definition at line 182 of file BackendModule.php.

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

◆ setIcon()

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

Set icon

Parameters
array$icon
Returns
void

Definition at line 106 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
Returns
void

Definition at line 163 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
Returns
void

Definition at line 125 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
Returns
void

Definition at line 201 of file BackendModule.php.

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

◆ setOnClick()

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

Set onClick

Parameters
string$onClick
Returns
void

Definition at line 220 of file BackendModule.php.

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

◆ setTitle()

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

Set title

Parameters
string$title
Returns
void

Definition at line 144 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 62 of file BackendModule.php.

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

◆ $description

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

Definition at line 52 of file BackendModule.php.

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

◆ $icon

array TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::$icon = array()
protected

Definition at line 37 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 42 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 32 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 57 of file BackendModule.php.

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

◆ $onClick

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

Definition at line 47 of file BackendModule.php.

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

◆ $title

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

Definition at line 27 of file BackendModule.php.

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