Trait FormGroupTrait

Provides an implementation of Charcoal\Ui\FormGroup\FormGroupInterface.

Direct Known Users

Charcoal\Ui\FormGroup\AbstractFormGroup

Indirect Known Users

Charcoal\Ui\FormGroup\GenericFormGroup

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

Methods summary
`protected Charcoal\Ui\FormGroup\FormGroupInterface`	# `setFormInputBuilder( Charcoal\Ui\FormInput\FormInputBuilder $builder )` Parameters `$builder` The builder, to create customized form input objects. Returns `Charcoal\Ui\FormGroup\FormGroupInterface` Chainable
`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 )` Parameters `$form` The parent form object. Returns `Charcoal\Ui\FormGroup\FormGroupInterface` Chainable
`public Charcoal\Ui\Form\FormInterface`	# `form( )` 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. Returns `Charcoal\Ui\FormGroup\FormGroupInterface` Chainable
`public Charcoal\Ui\FormGroup\FormGroupInterface`	# `addInput( string $inputIdent, array\|Charcoal\Ui\FormInput\FormInputInterface $input )` Parameters `$inputIdent` The input identifier. `$input` The input object or structure. Returns `Charcoal\Ui\FormGroup\FormGroupInterface` Chainable Throws InvalidArgumentException If the ident argument is not a string or if the input is not valid.
`public Charcoal\Ui\FormGroup\FormGroupInterface[]\|Generator`	# `inputs( callable $inputCallback = null )` Form Input generator. Form Input generator. Parameters `$inputCallback` Optional. Input callback. Returns `Charcoal\Ui\FormGroup\FormGroupInterface[]`\|Generator
`public boolean`	# `hasInputs( )` Wether this group contains any inputs. Wether this group contains any inputs. Returns boolean
`public integer`	# `numInputs( )` Get the number of inputs in this group. Get the number of inputs in this group. Returns integer
`public Charcoal\Ui\FormGroup\FormGroupTrait`	# `setIdent( string $ident )` Set the identifier of the group. Set the identifier of the group. Parameters `$ident` The group identifier. Returns `Charcoal\Ui\FormGroup\FormGroupTrait`
`public string`	# `ident( )` Retrieve the idenfitier of the group. Retrieve the idenfitier of the group. Returns string
`public Charcoal\Ui\FormGroup\FormGroupTrait`	# `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 `Charcoal\Ui\FormGroup\FormGroupTrait` Throws InvalidArgumentException If the priority is not an integer.
`public integer`	# `priority( )` Retrieve the group's priority or sorting index. Retrieve the group's priority or sorting index. Returns integer
`public Charcoal\Ui\FormGroup\FormGroupTrait`	# `setTabCssClasses( string\|string[] $classes )` Parameters `$classes` Class or Classes for tab form group. Returns `Charcoal\Ui\FormGroup\FormGroupTrait`
`public string\|string[]`	# `tabCssClasses( )` Returns string\|string[]

Properties summary
`protected Charcoal\Ui\Form\FormInterface`	`$form` Store a reference to the parent form widget. Store a reference to the parent form widget.	#
`protected Charcoal\Ui\FormInput\FormInputBuilder`	`$formInputBuilder` Store the builder instance for the current class. Store the builder instance for the current class.	#