Overview

Namespaces

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

Classes

  • AbstractUiItem
  • UiItemConfig

Interfaces

  • UiGroupingInterface
  • UiItemInterface

Traits

  • UiGroupingTrait
  • UiItemTrait
  • Overview
  • Namespace
  • Class

Trait UiGroupingTrait

Provides an implementation of Charcoal\Ui\UiGroupingInterface.

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

Set the identifier of the group.

Set the identifier of the group.

Parameters

$ident
The group identifier.

Returns

Charcoal\Ui\UiGroupingTrait
public string
# ident( )

Retrieve the idenfitier of the group.

Retrieve the idenfitier of the group.

Returns

string
public Charcoal\Ui\UiGroupingTrait
# 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\UiGroupingTrait

Throws

InvalidArgumentException
If the priority is not an integer.
public integer
# priority( )

Retrieve the group's priority or sorting index.

Retrieve the group's priority or sorting index.

Returns

integer
API documentation generated by ApiGen