Class AbstractMenu

A Basic Menu

Abstract implementation of Charcoal\Ui\Menu\MenuInterface.

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\Menu\AbstractMenu implements Charcoal\Ui\Menu\MenuInterface

Direct known subclasses

Charcoal\Ui\Menu\GenericMenu

Abstract
Namespace: Charcoal\Ui\Menu
Located at Charcoal/Ui/Menu/AbstractMenu.php

Methods summary
`public`	# `__construct( array\|ArrayAccess $data )` Return a new menu. Return a new menu. Parameters `$data` Class dependencies. Overrides `Charcoal\Ui\AbstractUiItem::__construct()`
`public AsbtractMenu`	# `setMenuItemBuilder( Charcoal\Ui\MenuItem\MenuItemBuilder $menuItemBuilder )` Parameters `$menuItemBuilder` The Menu Item Builder that will be used to create new items. Returns AsbtractMenu Chainable
`public Charcoal\Ui\Menu\AbstractMenu`	# `setItemCallback( callable $cb )` Parameters `$cb` The item callback. Returns `Charcoal\Ui\Menu\AbstractMenu` Chainable
`public Charcoal\Ui\Menu\AbstractMenu`	# `setItems( array $items )` Parameters `$items` The menu items. Returns `Charcoal\Ui\Menu\AbstractMenu` Chainable Implementation of `Charcoal\Ui\Menu\MenuInterface::setItems()`
`public MenuItem`	# `addItem( array\|Charcoal\Ui\MenuItem\MenuItemInterface $item )` Parameters `$item` A menu item structure or object. Returns MenuItem Chainable Throws InvalidArgumentException If the item argument is not a structure or object. Implementation of `Charcoal\Ui\Menu\MenuInterface::addItem()`
`public Charcoal\Ui\MenuItem\MenuItemInterface[]`	# `items( callable $itemCallback = null )` Menu Item generator. Menu Item generator. Parameters `$itemCallback` Optional. Item callback. Returns `Charcoal\Ui\MenuItem\MenuItemInterface[]` Implementation of `Charcoal\Ui\Menu\MenuInterface::items()`
`public boolean`	# `hasItems( )` Returns boolean Implementation of `Charcoal\Ui\Menu\MenuInterface::hasItems()`
`public integer`	# `numItems( )` Returns integer Implementation of `Charcoal\Ui\Menu\MenuInterface::numItems()`
`protected static integer`	# `sortItemsByPriority( Charcoal\Ui\MenuItem\MenuItemInterface $a, Charcoal\Ui\MenuItem\MenuItemInterface $b )` Static comparison function used by uasort(). Static comparison function used by uasort(). Parameters `$a` Menu A. `$b` Menu B. Returns integer Sorting value: -1, 0, or 1

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()`

Namespaces

Classes

Interfaces

Class AbstractMenu

Direct known subclasses

Parameters

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns