API Documentation
\
Charcoal
Ui
Dashboard
Form
FormGroup
FormInput
Layout
Menu
MenuItem
ServiceProvider

\Charcoal\Ui\FormGroupFormGroupTrait

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

Summary

Methods
Properties
Constants
setInputCallback()
setForm()
form()
setL10nMode()
l10nMode()
setInputs()
addInput()
inputs()
hasInputs()
numInputs()
setIdent()
ident()
setPriority()
priority()
setTabCssClasses()
tabCssClasses()
No public properties found
No constants found
setFormInputBuilder()
$form
$formInputBuilder
N/A
No private methods found
$inputs
$inputCallback
$l10nMode
$ident
$priority
$requiredAclPermissions
$tabCssClasses
N/A

Properties

$inputCallback

$inputCallback : callable

The input callback; called on every input.

Callable signature: function(FormInputInterface $input)

Type

callable

$l10nMode

$l10nMode : string

The L10N display mode.

Type

string

$ident

$ident : string

The group's identifier.

Type

string

$priority

$priority : integer

The group's priority.

Type

integer

$requiredAclPermissions

$requiredAclPermissions : array<mixed,string>

The required Acl permissions fetch from form group.

Type

array<mixed,string>

$tabCssClasses

$tabCssClasses : string|array<mixed,string>

Class or Classes for tab form group.

Type

string|array<mixed,string>

Methods

l10nMode()

l10nMode() : string

Returns

string

addInput()

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

Parameters

string $inputIdent

The input identifier.
array|\Charcoal\Ui\FormInput\FormInputInterface $input

The input object or structure.

Throws

\InvalidArgumentException

If the ident argument is not a string or if the input is not valid.

Returns

\Charcoal\Ui\FormGroup\FormGroupInterface —

Chainable

inputs()

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

Form Input generator.

Parameters

callable $inputCallback

Optional. Input callback.

Returns

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

hasInputs()

hasInputs() : boolean

Wether this group contains any inputs.

Returns

boolean

numInputs()

numInputs() : integer

Get the number of inputs in this group.

Returns

integer

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

setTabCssClasses()

setTabCssClasses(string|array<mixed,\string>  $classes) : self

Parameters

string|array<mixed,\string> $classes

Class or Classes for tab form group.

Returns

self

tabCssClasses()

tabCssClasses() : string|array<mixed,\string>

Returns

string|array<mixed,\string>