Interface FormGroupInterface

Defines a form group.

Direct known implementers

Charcoal\Ui\FormGroup\AbstractFormGroup

Indirect known implementers

Charcoal\Ui\FormGroup\GenericFormGroup

Namespace: Charcoal\Ui\FormGroup
Located at Charcoal/Ui/FormGroup/FormGroupInterface.php

Methods summary
`public Charcoal\Ui\FormGroup\FormGroupInterface`	# `setInputCallback( callable $cb )` Parameters `$cb` The input callback. Returns `Charcoal\Ui\FormGroup\FormGroupInterface` Chainable
`public Charcoal\Ui\FormGroup\FormGroupInterface`	# `setForm( Charcoal\Ui\Form\FormInterface $form )` Set the form widget. Set the form widget. Parameters `$form` The related form widget. Returns `Charcoal\Ui\FormGroup\FormGroupInterface` Chainable
`public Charcoal\Ui\Form\FormInterface`	# `form( )` Retrieve the form widget. Retrieve the form widget. Returns `Charcoal\Ui\Form\FormInterface`
`public Charcoal\Ui\FormGroup\FormGroupInterface`	# `setL10nMode( string $mode )` Parameters `$mode` The l10n mode. Returns `Charcoal\Ui\FormGroup\FormGroupInterface` Chainable
`public string`	# `l10nMode( )` Returns string
`public Charcoal\Ui\FormGroup\FormGroupInterface`	# `setInputs( array $inputs )` Parameters `$inputs` The group inputs structure. Returns `Charcoal\Ui\FormGroup\FormGroupInterface` Chainable
`public Charcoal\Ui\Form\FormInterface`	# `addInput( string $inputIdent, array\|FormInputInterface $input )` Parameters `$inputIdent` The input identifier. `$input` The input object or structure. Returns `Charcoal\Ui\Form\FormInterface` Chainable
`public Charcoal\Ui\FormGroup\FormGroupInterface[]`	# `inputs( callable $inputCallback = null )` Form Input generator Form Input generator Parameters `$inputCallback` Optional. Input callback. Returns `Charcoal\Ui\FormGroup\FormGroupInterface[]`
`public boolean`	# `hasInputs( )` Returns boolean
`public integer`	# `numInputs( )` Returns integer
`public UiGroupingInterface`	# `setIdent( string $ident )` Set the identifier of the group. Set the identifier of the group. Parameters `$ident` Sidemenu group identifier. Returns UiGroupingInterface Chainable
`public string`	# `ident( )` Retrieve the idenfitier of the group. Retrieve the idenfitier of the group. Returns string
`public UiItemInterface`	# `setActive( boolean $active )` Activates/deactivates the group. Activates/deactivates the group. Parameters `$active` Activate (TRUE) or deactivate (FALSE) the group. Returns UiItemInterface Chainable
`public boolean`	# `active( )` Determine if the group is active. Determine if the group is active. Returns boolean
`public UiGroupingInterface`	# `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 UiGroupingInterface Chainable
`public integer`	# `priority( )` Retrieve the group's priority or sorting index. Retrieve the group's priority or sorting index. Returns integer