\Charcoal\Admin\Ui\SidemenuSidemenuGroupInterface

Defines an admin sidemenu group

Summary

Methods
Constants
setSidemenu()
sidemenu()
setIdent()
ident()
setActive()
active()
setPriority()
priority()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

setIdent()

setIdent(string  $ident) : \Charcoal\Admin\Ui\Sidemenu\UiGroupingInterface

Set the identifier of the group.

Parameters

string $ident

Sidemenu group identifier.

Returns

\Charcoal\Admin\Ui\Sidemenu\UiGroupingInterface —

Chainable

ident()

ident() : string

Retrieve the idenfitier of the group.

Returns

string

setActive()

setActive(boolean  $active) : self

Set whether the group is active or not.

Parameters

boolean $active

The active flag.

Returns

self

active()

active() : boolean

Determine if the group is active or not.

Returns

boolean

setPriority()

setPriority(integer  $priority) : \Charcoal\Admin\Ui\Sidemenu\UiGroupingInterface

Set the group's priority or sorting index.

Parameters

integer $priority

An index, for sorting.

Returns

\Charcoal\Admin\Ui\Sidemenu\UiGroupingInterface —

Chainable

priority()

priority() : integer

Retrieve the group's priority or sorting index.

Returns

integer