PHP Class Bolt\Menu\MenuEntry

Author: Gawain Lynch ([email protected])
Datei anzeigen Open project: bolt/bolt Class Usage Examples

Protected Properties

Property Type Description
$children MenuEntry[]
$icon string
$label string
$name string
$parent MenuEntry
$permission string
$uri string

Public Methods

Method Description
__construct ( string $name, string $uri ) Constructor.
add ( MenuEntry $menu ) : MenuEntry Add child menu entry.
children ( ) : MenuEntry[] Return the menu entry's children.
get ( string $name ) : MenuEntry Return a menu entry's named child.
getIcon ( ) : string Return the menu entry's icon.
getLabel ( ) : string Return the menu entry's label.
getName ( ) : string Return the menu entry's internal name.
getPermission ( ) : string Return the menu entry's required view permission.
getUri ( ) : string Return the menu entry's URI relative to Bolt admin's.
setIcon ( string $icon ) : MenuEntry Set the menu entry's icon.
setLabel ( string $label ) : MenuEntry Set the menu entry's label.
setParent ( MenuEntry $parent ) : MenuEntry Set the menu entry's parent object.
setPermission ( string $permission ) : MenuEntry Set the menu entry's required view permission.

Method Details

__construct() public method

Constructor.
public __construct ( string $name, string $uri )
$name string
$uri string

add() public method

Add child menu entry.
public add ( MenuEntry $menu ) : MenuEntry
$menu MenuEntry
return MenuEntry

children() public method

Return the menu entry's children.
public children ( ) : MenuEntry[]
return MenuEntry[]

get() public method

Return a menu entry's named child.
public get ( string $name ) : MenuEntry
$name string
return MenuEntry

getIcon() public method

Return the menu entry's icon.
public getIcon ( ) : string
return string

getLabel() public method

Return the menu entry's label.
public getLabel ( ) : string
return string

getName() public method

Return the menu entry's internal name.
public getName ( ) : string
return string

getPermission() public method

Return the menu entry's required view permission.
public getPermission ( ) : string
return string

getUri() public method

Return the menu entry's URI relative to Bolt admin's.
public getUri ( ) : string
return string

setIcon() public method

Set the menu entry's icon.
public setIcon ( string $icon ) : MenuEntry
$icon string
return MenuEntry

setLabel() public method

Set the menu entry's label.
public setLabel ( string $label ) : MenuEntry
$label string
return MenuEntry

setParent() public method

Set the menu entry's parent object.
public setParent ( MenuEntry $parent ) : MenuEntry
$parent MenuEntry
return MenuEntry

setPermission() public method

Set the menu entry's required view permission.
public setPermission ( string $permission ) : MenuEntry
$permission string
return MenuEntry

Property Details

$children protected_oe property

protected MenuEntry[],Bolt\Menu $children
return MenuEntry[]

$icon protected_oe property

protected string $icon
return string

$label protected_oe property

protected string $label
return string

$name protected_oe property

protected string $name
return string

$parent protected_oe property

protected MenuEntry,Bolt\Menu $parent
return MenuEntry

$permission protected_oe property

protected string $permission
return string

$uri protected_oe property

protected string $uri
return string