Class AbstractMenuItem

A Basic Menu Item

Abstract implementation of Charcoal\Ui\MenuItem\MenuItemInterface.

Charcoal\Config\AbstractEntity

Charcoal\Ui\AbstractUiItem implements Charcoal\User\AuthAwareInterface, Psr\Log\LoggerAwareInterface, Charcoal\Ui\UiItemInterface uses Charcoal\User\AuthAwareTrait (not available) Psr\Log\LoggerAwareTrait (not available) Charcoal\Translator\TranslatorAwareTrait (not available) Charcoal\Ui\UiItemTrait, Charcoal\View\ViewableTrait (not available)

Charcoal\Ui\MenuItem\AbstractMenuItem implements Charcoal\Ui\MenuItem\MenuItemInterface

Direct known subclasses

Charcoal\Ui\MenuItem\GenericMenuItem

Abstract
Namespace: Charcoal\Ui\MenuItem
Located at Charcoal/Ui/MenuItem/AbstractMenuItem.php

Methods summary
`public`	# `__construct( array\|ArrayAccess $data )` Return a new menu item. Return a new menu item. Parameters `$data` Class dependencies. Overrides `Charcoal\Ui\AbstractUiItem::__construct()`
`protected Charcoal\Ui\MenuItem\MenuItemInterface`	# `setMenu( Charcoal\Ui\Menu\MenuInterface $menu )` Set the parent (menu) object. Set the parent (menu) object. Parameters `$menu` The parent menu object. Returns `Charcoal\Ui\MenuItem\MenuItemInterface` Chainable
`public Charcoal\Ui\MenuItem\MenuItemInterface`	# `setMenuItemBuilder( Charcoal\Ui\MenuItem\MenuItemBuilder $menuItemBuilder )` Parameters `$menuItemBuilder` The Menu Item Builder that will be used to create new items. Returns `Charcoal\Ui\MenuItem\MenuItemInterface` Chainable
`public Charcoal\Ui\MenuItem\MenuItemInterface`	# `setItemCallback( callable $cb )` Parameters `$cb` The item callback. Returns `Charcoal\Ui\MenuItem\MenuItemInterface` Chainable
`public MenuItem`	# `setIdent( string $ident )` Parameters `$ident` The menu item identifier. Returns MenuItem Chainable Throws InvalidArgumentException If the identifier argument is not a string. Implementation of `Charcoal\Ui\MenuItem\MenuItemInterface::setIdent()`
`public string`	# `ident( )` Returns string Implementation of `Charcoal\Ui\MenuItem\MenuItemInterface::ident()`
`public MenuItem`	# `setLabel( mixed $label )` Parameters `$label` The menu item label. Returns MenuItem Chainable Implementation of `Charcoal\Ui\MenuItem\MenuItemInterface::setLabel()`
`public string`	# `label( )` Returns string Implementation of `Charcoal\Ui\MenuItem\MenuItemInterface::label()`
`public MenuItem`	# `setUrl( string $url )` Parameters `$url` The menu item URL. Returns MenuItem Chainable Implementation of `Charcoal\Ui\MenuItem\MenuItemInterface::setUrl()`
`public string`	# `url( )` Returns string Implementation of `Charcoal\Ui\MenuItem\MenuItemInterface::url()`
`public boolean`	# `hasUrl( )` Returns boolean Implementation of `Charcoal\Ui\MenuItem\MenuItemInterface::hasUrl()`
`public MenuItem`	# `setChildren( array $children )` Parameters `$children` The menu item children items structure. Returns MenuItem Chainable Implementation of `Charcoal\Ui\MenuItem\MenuItemInterface::setChildren()`
`public MenuItem`	# `addChild( array\|MenuItem $child )` Parameters `$child` The child menu structure or object. Returns MenuItem Chainable Throws InvalidArgumentException If the child is not a menu object or structure. Implementation of `Charcoal\Ui\MenuItem\MenuItemInterface::addChild()`
`public Charcoal\Ui\MenuItem\MenuItemInterface[]`	# `children( callable $childCallback = null )` Children (menu item) generator Children (menu item) generator Parameters `$childCallback` Optional callback. Returns `Charcoal\Ui\MenuItem\MenuItemInterface[]` Implementation of `Charcoal\Ui\MenuItem\MenuItemInterface::children()`
`public boolean`	# `hasChildren( )` Returns boolean Implementation of `Charcoal\Ui\MenuItem\MenuItemInterface::hasChildren()`
`public integer`	# `numChildren( )` Returns integer Implementation of `Charcoal\Ui\MenuItem\MenuItemInterface::numChildren()`

Methods inherited from Charcoal\Ui\AbstractUiItem
`active(), setActive(), setDependencies()`

Methods inherited from Charcoal\Ui\UiItemInterface
`description(), notes(), setDescription(), setNotes(), setShowDescription(), setShowFooter(), setShowHeader(), setShowNotes(), setShowSubtitle(), setShowTitle(), setSubtitle(), setTemplate(), setTitle(), setType(), showDescription(), showFooter(), showHeader(), showNotes(), showSubtitle(), showTitle(), subtitle(), template(), title(), type()`

Methods used from Charcoal\Ui\UiItemTrait
`description(), icon(), notes(), setDescription(), setIcon(), setNotes(), setShowDescription(), setShowFooter(), setShowHeader(), setShowNotes(), setShowSubtitle(), setShowTitle(), setSubtitle(), setTemplate(), setTitle(), setType(), showDescription(), showFooter(), showHeader(), showNotes(), showSubtitle(), showTitle(), subtitle(), template(), title(), translator(), type()`

Properties summary
`protected string`	`$ident` $ident $ident	#
`protected Charcoal\Translator\Translation\|null`	`$label` $label $label	#
`protected string`	`$url` $url $url	#
`protected Charcoal\Ui\MenuItem\MenuItemInterface[]`	`$children` $children $children	#

Namespaces

Classes

Interfaces

Class AbstractMenuItem

Direct known subclasses

Parameters

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of