Overview

Namespaces

  • Charcoal
    • Ui
      • Dashboard
      • Form
      • FormGroup
      • FormInput
      • Layout
      • Menu
      • MenuItem
      • ServiceProvider

Classes

  • AbstractMenuItem
  • GenericMenuItem
  • MenuItemBuilder
  • MenuItemConfig
  • MenuItemFactory

Interfaces

  • MenuItemInterface
  • Overview
  • Namespace
  • Class

Interface MenuItemInterface

Defines a menu item.

Direct known implementers

Charcoal\Ui\MenuItem\AbstractMenuItem

Indirect known implementers

Charcoal\Ui\MenuItem\GenericMenuItem
Namespace: Charcoal\Ui\MenuItem
Located at Charcoal/Ui/MenuItem/MenuItemInterface.php
Methods summary
public Charcoal\Ui\MenuItem\MenuItemInterface
# setIdent( string $ident )

Parameters

$ident
The menu item identifier.

Returns

Charcoal\Ui\MenuItem\MenuItemInterface
Chainable
public string
# ident( )

Returns

string
public Charcoal\Ui\MenuItem\MenuItemInterface
# setLabel( string $label )

Parameters

$label
The menu item label.

Returns

Charcoal\Ui\MenuItem\MenuItemInterface
Chainable
public string
# label( )

Returns

string
public Charcoal\Ui\MenuItem\MenuItemInterface
# setUrl( string $url )

Parameters

$url
The menu item URL.

Returns

Charcoal\Ui\MenuItem\MenuItemInterface
Chainable
public string
# url( )

Returns

string
public boolean
# hasUrl( )

Returns

boolean
public Charcoal\Ui\MenuItem\MenuItemInterface
# setChildren( array $children )

Parameters

$children
The menu item children menu structure.

Returns

Charcoal\Ui\MenuItem\MenuItemInterface
Chainable
public Charcoal\Ui\MenuItem\MenuItemInterface
# addChild( array|Charcoal\Ui\MenuItem\MenuItemInterface $child )

Parameters

$child
The child object or structure.

Returns

Charcoal\Ui\MenuItem\MenuItemInterface
Chainable
public Charcoal\Ui\MenuItem\MenuItemInterface[]
# children( )

Returns

Charcoal\Ui\MenuItem\MenuItemInterface[]
public boolean
# hasChildren( )

Returns

boolean
public integer
# numChildren( )

Returns

integer
API documentation generated by ApiGen