TYPO3  7.6
Public Member Functions | Protected Attributes | List of all members
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 ( MenuItem  $menuItem)

Adds a new menuItem

Parameters
MenuItem$menuItemThe menuItem to add to the menu
Exceptions
\InvalidArgumentExceptionIn case a menuItem is not valid
Returns
void

Definition at line 90 of file Menu.php.

References AbstractControl\getTitle(), and MenuItem\isValid().

getIdentifier ( )

Get identifier

Returns
string

Definition at line 115 of file Menu.php.

References Menu\$identifier.

Referenced by MenuRegistry\addMenu(), and Menu\isValid().

getLabel ( )

Get the label

Returns
string

Definition at line 50 of file Menu.php.

References Menu\$label.

getMenuItems ( )

Get menu items

Returns
array

Definition at line 105 of file Menu.php.

References Menu\$menuItems.

isValid ( Menu  $menu)

Validation function

Parameters
Menu$menuThe menu to validate
Returns
bool

Definition at line 138 of file Menu.php.

References Menu\getIdentifier().

Referenced by MenuRegistry\addMenu().

makeMenuItem ( )

MenuItem Factory Method

Returns
MenuItem

Definition at line 125 of file Menu.php.

References GeneralUtility\makeInstance().

setIdentifier (   $identifier)

Set identifier

Parameters
string$identifierMenu Identifier
Returns
Menu

Definition at line 75 of file Menu.php.

References Menu\$identifier.

setLabel (   $label)

Set label

Parameters
string$labelLabelText for the menu (accepts LLL syntax)
Returns
Menu

Definition at line 62 of file Menu.php.

References Menu\$label.

Member Data Documentation

$identifier = ''
protected

Definition at line 29 of file Menu.php.

Referenced by Menu\getIdentifier(), and Menu\setIdentifier().

$label = ''
protected

Definition at line 36 of file Menu.php.

Referenced by Menu\getLabel(), and Menu\setLabel().

$menuItems = []
protected

Definition at line 43 of file Menu.php.

Referenced by Menu\getMenuItems().