Overview

Namespaces

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

Classes

  • AbstractUiItem
  • UiItemConfig

Interfaces

  • UiGroupingInterface
  • UiItemInterface

Traits

  • UiGroupingTrait
  • UiItemTrait
  • Overview
  • Namespace
  • Class

Interface UiGroupingInterface

Defines a UI Grouping.

Charcoal\Ui\UiGroupingInterface implements Charcoal\Ui\UiItemInterface
Namespace: Charcoal\Ui
Located at Charcoal/Ui/UiGroupingInterface.php
Methods summary
public Charcoal\Ui\UiGroupingInterface
# setIdent( string $ident )

Set the identifier of the sidemenu group.

Set the identifier of the sidemenu group.

Parameters

$ident
Sidemenu group identifier.

Returns

Charcoal\Ui\UiGroupingInterface
Chainable
public string
# ident( )

Retrieve the idenfitier of the sidemenu group.

Retrieve the idenfitier of the sidemenu group.

Returns

string
public Charcoal\Ui\UiGroupingInterface
# setPriority( integer $priority )

Set the group's priority or sorting index.

Set the group's priority or sorting index.

Parameters

$priority
An index, for sorting.

Returns

Charcoal\Ui\UiGroupingInterface
Chainable
public integer
# priority( )

Retrieve the group's priority or sorting index.

Retrieve the group's priority or sorting index.

Returns

integer
Methods inherited from Charcoal\Ui\UiItemInterface
active(), description(), notes(), setActive(), setDescription(), setNotes(), setShowDescription(), setShowFooter(), setShowHeader(), setShowNotes(), setShowSubtitle(), setShowTitle(), setSubtitle(), setTemplate(), setTitle(), setType(), showDescription(), showFooter(), showHeader(), showNotes(), showSubtitle(), showTitle(), subtitle(), template(), title(), type()
API documentation generated by ApiGen