\Charcoal\Ui\MenuItemMenuItemInterface

Defines a menu item.

Summary

Methods

Constants

setIdent()
ident()
setLabel()
label()
setUrl()
url()
hasUrl()
setChildren()
addChild()
children()
hasChildren()
numChildren()

No constants found

No protected methods found

N/A

No private methods found

N/A

Methods

setIdent()

setIdent(string  $ident) : \Charcoal\Ui\MenuItem\MenuItemInterface

Parameters

string

$ident

The menu item identifier.

Returns

\Charcoal\Ui\MenuItem\MenuItemInterface —

Chainable

ident()

ident() : string

Returns

string

setLabel()

setLabel(string  $label) : \Charcoal\Ui\MenuItem\MenuItemInterface

Parameters

string

$label

The menu item label.

Returns

\Charcoal\Ui\MenuItem\MenuItemInterface —

Chainable

label()

label() : string

Returns

string

setUrl()

setUrl(string  $url) : \Charcoal\Ui\MenuItem\MenuItemInterface

Parameters

string

$url

The menu item URL.

Returns

\Charcoal\Ui\MenuItem\MenuItemInterface —

Chainable

url()

url() : string

Returns

string

hasUrl()

hasUrl() : boolean

Returns

boolean

setChildren()

setChildren(array  $children) : \Charcoal\Ui\MenuItem\MenuItemInterface

Parameters

array

$children

The menu item children menu structure.

Returns

\Charcoal\Ui\MenuItem\MenuItemInterface —

Chainable

addChild()

addChild(array|\Charcoal\Ui\MenuItem\MenuItemInterface  $child) : \Charcoal\Ui\MenuItem\MenuItemInterface

Parameters

array|\Charcoal\Ui\MenuItem\MenuItemInterface

$child

The child object or structure.

Returns

\Charcoal\Ui\MenuItem\MenuItemInterface —

Chainable

children()

children() : array<mixed,\Charcoal\Ui\MenuItem\MenuItemInterface>

Returns

array<mixed,\Charcoal\Ui\MenuItem\MenuItemInterface>

hasChildren()

hasChildren() : boolean

Returns

boolean

numChildren()

numChildren() : integer

Returns

integer