\Charcoal\UiUiGroupingTrait

Provides an implementation of {@see \Charcoal\Ui\UiGroupingInterface}.

Summary

Methods

Properties

Constants

setIdent()
ident()
setPriority()
priority()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$ident
$priority

N/A

File: UiGroupingTrait.php
Package: Default
Class hierarchy: \Charcoal\Ui\UiGroupingTrait

Properties

$ident

$ident : string

The group's identifier.

Type

string

$priority

$priority : integer

The group's priority.

Type

integer

Methods

setIdent()

setIdent(string  $ident) : self

Set the identifier of the group.

Parameters

string

$ident

The group identifier.

Returns

self

ident()

ident() : string

Retrieve the idenfitier of the group.

Returns

string

setPriority()

setPriority(integer  $priority) : self

Set the group's priority or sorting index.

Parameters

integer

$priority

An index, for sorting.

Throws

\InvalidArgumentException: If the priority is not an integer.

Returns

self

priority()

priority() : integer

Retrieve the group's priority or sorting index.

Returns

integer