\Charcoal\Ui\FormGroupFormGroupInterface

Defines a form group.

Summary

Methods

Constants

setInputCallback()
setForm()
form()
setL10nMode()
l10nMode()
setInputs()
addInput()
inputs()
hasInputs()
numInputs()
setIdent()
ident()
setActive()
active()
setPriority()
priority()

No constants found

No protected methods found

N/A

No private methods found

N/A

Methods

setInputCallback()

setInputCallback(callable  $cb) : \Charcoal\Ui\FormGroup\FormGroupInterface

Parameters

callable

$cb

The input callback.

Returns

\Charcoal\Ui\FormGroup\FormGroupInterface —

Chainable

setForm()

setForm(\Charcoal\Ui\Form\FormInterface  $form) : \Charcoal\Ui\FormGroup\FormGroupInterface

Set the form widget.

Parameters

\Charcoal\Ui\Form\FormInterface

$form

The related form widget.

Returns

\Charcoal\Ui\FormGroup\FormGroupInterface —

Chainable

form()

form() : \Charcoal\Ui\Form\FormInterface

Retrieve the form widget.

Returns

\Charcoal\Ui\Form\FormInterface

setL10nMode()

setL10nMode(string  $mode) : \Charcoal\Ui\FormGroup\FormGroupInterface

Parameters

string

$mode

The l10n mode.

Returns

\Charcoal\Ui\FormGroup\FormGroupInterface —

Chainable

l10nMode()

l10nMode() : string

Returns

string

setInputs()

setInputs(array  $inputs) : \Charcoal\Ui\FormGroup\FormGroupInterface

Parameters

array

$inputs

The group inputs structure.

Returns

\Charcoal\Ui\FormGroup\FormGroupInterface —

Chainable

addInput()

addInput(string  $inputIdent, array|\Charcoal\Ui\FormGroup\FormInputInterface  $input) : \Charcoal\Ui\Form\FormInterface

Parameters

string	$inputIdent	The input identifier.
array\|\Charcoal\Ui\FormGroup\FormInputInterface	$input	The input object or structure.

Returns

\Charcoal\Ui\Form\FormInterface —

Chainable

inputs()

inputs(callable  $inputCallback = null) : array<mixed,\Charcoal\Ui\FormGroup\FormGroupInterface>

Form Input generator

Parameters

callable

$inputCallback

Optional. Input callback.

Returns

array<mixed,\Charcoal\Ui\FormGroup\FormGroupInterface>

hasInputs()

hasInputs() : boolean

Returns

boolean

numInputs()

numInputs() : integer

Returns

integer

setIdent()

setIdent(string  $ident) : \Charcoal\Ui\FormGroup\UiGroupingInterface

Set the identifier of the group.

Parameters

string

$ident

Sidemenu group identifier.

Returns

\Charcoal\Ui\FormGroup\UiGroupingInterface —

Chainable

ident()

ident() : string

Retrieve the idenfitier of the group.

Returns

string

setActive()

setActive(boolean  $active) : \Charcoal\Ui\FormGroup\UiItemInterface

Activates/deactivates the group.

Parameters

boolean

$active

Activate (TRUE) or deactivate (FALSE) the group.

Returns

\Charcoal\Ui\FormGroup\UiItemInterface —

Chainable

active()

active() : boolean

Determine if the group is active.

Returns

boolean

setPriority()

setPriority(integer  $priority) : \Charcoal\Ui\FormGroup\UiGroupingInterface

Set the group's priority or sorting index.

Parameters

integer

$priority

An index, for sorting.

Returns

\Charcoal\Ui\FormGroup\UiGroupingInterface —

Chainable

priority()

priority() : integer

Retrieve the group's priority or sorting index.

Returns

integer