TYPO3\CMS\Backend\Template\Components\Menu\Menu Class Reference

Public Member Functions
	getLabel ()
	setLabel ($label)
	setIdentifier ($identifier)
	addMenuItem (MenuItem $menuItem)
	getMenuItems ()
	getIdentifier ()
	makeMenuItem ()
	isValid (Menu $menu)

Protected Attributes
	$identifier = ''
	$label = ''
	$menuItems = []

Detailed Description

Menu

Definition at line 22 of file Menu.php.

Member Function Documentation

addMenuItem()

TYPO3\CMS\Backend\Template\Components\Menu\Menu::addMenuItem

(

MenuItem

$menuItem

)

Adds a new menuItem

Parameters

MenuItem

$menuItem

The menuItem to add to the menu

Exceptions

Definition at line 90 of file Menu.php.

References TYPO3\CMS\Backend\Template\Components\AbstractControl\getTitle(), and TYPO3\CMS\Backend\Template\Components\Menu\MenuItem\isValid().

getIdentifier()

TYPO3\CMS\Backend\Template\Components\Menu\Menu::getIdentifier

(

)

Get identifier

Returns

string

Definition at line 115 of file Menu.php.

References TYPO3\CMS\Backend\Template\Components\Menu\Menu\$identifier.

Referenced by TYPO3\CMS\Backend\Template\Components\MenuRegistry\addMenu(), and TYPO3\CMS\Backend\Template\Components\Menu\Menu\isValid().

getLabel()

TYPO3\CMS\Backend\Template\Components\Menu\Menu::getLabel

(

)

Get the label

Returns

string

Definition at line 50 of file Menu.php.

References TYPO3\CMS\Backend\Template\Components\Menu\Menu\$label.

getMenuItems()

TYPO3\CMS\Backend\Template\Components\Menu\Menu::getMenuItems

(

)

Get menu items

Returns

array

Definition at line 105 of file Menu.php.

References TYPO3\CMS\Backend\Template\Components\Menu\Menu\$menuItems.

isValid()

TYPO3\CMS\Backend\Template\Components\Menu\Menu::isValid

(

Menu

$menu

)

Validation function

Parameters

Menu

$menu

The menu to validate

Returns

bool

Definition at line 138 of file Menu.php.

References TYPO3\CMS\Backend\Template\Components\Menu\Menu\getIdentifier().

Referenced by TYPO3\CMS\Backend\Template\Components\MenuRegistry\addMenu().

makeMenuItem()

TYPO3\CMS\Backend\Template\Components\Menu\Menu::makeMenuItem

(

)

MenuItem Factory Method

Returns

MenuItem

Definition at line 125 of file Menu.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

setIdentifier()

TYPO3\CMS\Backend\Template\Components\Menu\Menu::setIdentifier

(

$identifier

)

Set identifier

Parameters

string

$identifier

Menu Identifier

Returns

Menu

Definition at line 75 of file Menu.php.

References TYPO3\CMS\Backend\Template\Components\Menu\Menu\$identifier.

setLabel()

TYPO3\CMS\Backend\Template\Components\Menu\Menu::setLabel

(

$label

)

Set label

Parameters

string

$label

LabelText for the menu (accepts LLL syntax)

Returns

Menu

Definition at line 62 of file Menu.php.

References TYPO3\CMS\Backend\Template\Components\Menu\Menu\$label.

Member Data Documentation

$identifier

TYPO3\CMS\Backend\Template\Components\Menu\Menu::$identifier = ''

protected

Definition at line 29 of file Menu.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Menu\Menu\getIdentifier(), and TYPO3\CMS\Backend\Template\Components\Menu\Menu\setIdentifier().

$label

TYPO3\CMS\Backend\Template\Components\Menu\Menu::$label = ''

protected

Definition at line 36 of file Menu.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Menu\Menu\getLabel(), and TYPO3\CMS\Backend\Template\Components\Menu\Menu\setLabel().

$menuItems

TYPO3\CMS\Backend\Template\Components\Menu\Menu::$menuItems = []

protected

Definition at line 43 of file Menu.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Menu\Menu\getMenuItems().