Class FieldsGroup

Responsibility: init, pre-dispatch and render group of common form controls, mostly input controls. This class is not possible to instantiate, you need to extend this class to create own specific form control.

MvcCore\Ext\Forms\Field implements MvcCore\Ext\Forms\IField uses MvcCore\Ext\Forms\Field\Props, MvcCore\Ext\Forms\Field\Getters, MvcCore\Ext\Forms\Field\Setters, MvcCore\Ext\Forms\Field\Rendering

MvcCore\Ext\Forms\FieldsGroup implements MvcCore\Ext\Forms\Fields\IVisibleField, MvcCore\Ext\Forms\Fields\ILabel, MvcCore\Ext\Forms\Fields\IOptions, MvcCore\Ext\Forms\Fields\IMultiple, MvcCore\Ext\Forms\IFieldsGroup uses MvcCore\Ext\Forms\Field\Props\VisibleField, MvcCore\Ext\Forms\Field\Props\Label, MvcCore\Ext\Forms\Field\Props\Options, MvcCore\Ext\Forms\Field\Props\GroupLabelCssClasses, MvcCore\Ext\Forms\Field\Props\GroupLabelAttrs

Direct known subclasses

MvcCore\Ext\Forms\Fields\CheckboxGroup, MvcCore\Ext\Forms\Fields\RadioGroup

Abstract
Namespace: MvcCore\Ext\Forms
Located at ext-form/src/MvcCore/Ext/Forms/FieldsGroup.php

Methods summary
`public static MvcCore\Ext\Forms\FieldsGroup`	# `CreateInstance( array $cfg = [] )` Create new form control group instance. Create new form control group instance. Parameters `$cfg` Config array with public properties and it's values which you want to configure, presented in camel case properties names syntax. Returns `MvcCore\Ext\Forms\FieldsGroup` Throws InvalidArgumentException Overrides `MvcCore\Ext\Forms\Field::CreateInstance()` Implementation of `MvcCore\Ext\Forms\IFieldsGroup::CreateInstance()`
`public string[]\|string\|null`	# `GetValue( )` Get form group controls value, in most cases it's an array of strings. For extended class `RadioGroup` - the type is only a `string` or `NULL`. Get form group controls value, in most cases it's an array of strings. For extended class `RadioGroup` - the type is only a `string` or `NULL`. Returns string[]\|string\|null Overrides `MvcCore\Ext\Forms\Field\Getters::GetValue()` Implementation of `MvcCore\Ext\Forms\IFieldsGroup::GetValue()`
`public MvcCore\Ext\Forms\FieldsGroup`	# `SetValue( float[]\|int[]\|string[]\|float\|integer\|string\|null $value )` Set form group controls value, in most cases - it could be an array with types, which are possible simply to convert into array of strings. `NULL` value is then an empty array. For extended class `RadioGroup` - the value type is only a `string` or `NULL`. Set form group controls value, in most cases - it could be an array with types, which are possible simply to convert into array of strings. `NULL` value is then an empty array. For extended class `RadioGroup` - the value type is only a `string` or `NULL`. Parameters `$value` Returns `MvcCore\Ext\Forms\FieldsGroup` Overrides `MvcCore\Ext\Forms\Field\Setters::SetValue()` Implementation of `MvcCore\Ext\Forms\IFieldsGroup::SetValue()`
`public boolean`	# `GetMultiple( )` Field group is always marked as multiple value control. This function always return `TRUE` for field group instance. Field group is always marked as multiple value control. This function always return `TRUE` for field group instance. Returns boolean See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-multiple Implementation of `MvcCore\Ext\Forms\Fields\IMultiple::GetMultiple()`
`public MvcCore\Ext\Forms\FieldsGroup`	# `SetMultiple( boolean $multiple = TRUE )` Field group is always marked as multiple value control. This function does nothing, because multiple option has to be `TRUE` for field group instance all time. Field group is always marked as multiple value control. This function does nothing, because multiple option has to be `TRUE` for field group instance all time. Parameters `$multiple` Returns `MvcCore\Ext\Forms\FieldsGroup` See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-multiple Implementation of `MvcCore\Ext\Forms\Fields\IMultiple::SetMultiple()`
`public MvcCore\Ext\Forms\FieldsGroup`	# `SetForm( MvcCore\Ext\IForm $form )` This INTERNAL method is called from `\MvcCore\Ext\Form` after field is added into form by `$form->AddField();` method. Do not use this method even if you don't develop any form field group. - Check if field has any name, which is required. - Set up form and field id attribute by form id and field name. - Set up required. - Check if there are any options for current controls group. This INTERNAL method is called from `\MvcCore\Ext\Form` after field is added into form by `$form->AddField();` method. Do not use this method even if you don't develop any form field group. - Check if field has any name, which is required. - Set up form and field id attribute by form id and field name. - Set up required. - Check if there are any options for current controls group. Parameters `$form` Returns `MvcCore\Ext\Forms\FieldsGroup` Throws InvalidArgumentException Overrides `MvcCore\Ext\Forms\Field::SetForm()` Implementation of `MvcCore\Ext\Forms\IFieldsGroup::SetForm()`
`public`	# `PreDispatch( )` This INTERNAL method is called from `\MvcCore\Ext\Form` just before field is naturally rendered. It sets up field for rendering process. Do not use this method even if you don't develop any form field. Set up field properties before rendering process. - Set up field render mode. - Set up translation boolean. - Translate label property if any. - Translate all option texts if necessary. This INTERNAL method is called from `\MvcCore\Ext\Form` just before field is naturally rendered. It sets up field for rendering process. Do not use this method even if you don't develop any form field. Set up field properties before rendering process. - Set up field render mode. - Set up translation boolean. - Translate label property if any. - Translate all option texts if necessary. Overrides `MvcCore\Ext\Forms\Field::PreDispatch()` Implementation of `MvcCore\Ext\Forms\IFieldsGroup::PreDispatch()`
`public string`	# `RenderNaturally( )` This INTERNAL method is called from `\MvcCore\Ext\Forms\Field\Rendering` in rendering process. Do not use this method even if you don't develop any form field. This INTERNAL method is called from `\MvcCore\Ext\Forms\Field\Rendering` in rendering process. Do not use this method even if you don't develop any form field. Render field naturally by render mode. Field should be rendered with label beside, label around or without label by local field configuration. Also there could be rendered specific field errors before or after field if field form is configured in that way. Returns string Overrides `MvcCore\Ext\Forms\Field\Rendering::RenderNaturally()` Implementation of `MvcCore\Ext\Forms\IFieldsGroup::RenderNaturally()`
`public string`	# `RenderControlInsideLabel( )` This INTERNAL method is called from `\MvcCore\Ext\Forms\FieldsGroup` in rendering process. Do not use this method even if you don't develop any form field. This INTERNAL method is called from `\MvcCore\Ext\Forms\FieldsGroup` in rendering process. Do not use this method even if you don't develop any form field. Render field naturally by configured property `$field->renderMode` if any or by default render mode without any label. Field should be rendered with label beside, label around or without label by local field configuration. Also there could be rendered specific field errors before or after field if field form is configured in that way. Returns string Overrides `MvcCore\Ext\Forms\Field\Rendering::RenderControlInsideLabel()` Implementation of `MvcCore\Ext\Forms\IFieldsGroup::RenderControlInsideLabel()`
`public string`	# `RenderControl( )` This INTERNAL method is called from `\MvcCore\Ext\Forms\FieldsGroup` in rendering process. Do not use this method even if you don't develop any form field. This INTERNAL method is called from `\MvcCore\Ext\Forms\FieldsGroup` in rendering process. Do not use this method even if you don't develop any form field. Render all sub-controls by multiple calls of `$field->RenderControlItem();`. Returns string Overrides `MvcCore\Ext\Forms\Field\Rendering::RenderControl()` Implementation of `MvcCore\Ext\Forms\IFieldsGroup::RenderControl()`
`public string`	# `RenderLabel( )` This INTERNAL method is called from `\MvcCore\Ext\Forms\FieldsGroup` in rendering process. Do not use this method even if you don't develop any form field. This INTERNAL method is called from `\MvcCore\Ext\Forms\FieldsGroup` in rendering process. Do not use this method even if you don't develop any form field. Render label tag only without control or specific errors. Returns string Overrides `MvcCore\Ext\Forms\Field\Rendering::RenderLabel()` Implementation of `MvcCore\Ext\Forms\IFieldsGroup::RenderLabel()`
`public string`	# `RenderControlItem( string $key, string\|array $option )` This INTERNAL method is called from `\MvcCore\Ext\Forms\FieldsGroup` in rendering process. Do not use this method even if you don't develop any form field. This INTERNAL method is called from `\MvcCore\Ext\Forms\FieldsGroup` in rendering process. Do not use this method even if you don't develop any form field. Render sub-controls with each sub-control label tag and without group label or without group specific errors. Parameters `$key` `$option` Returns string Implementation of `MvcCore\Ext\Forms\IFieldsGroup::RenderControlItem()`
`protected array`	# `renderControlItemCompleteAttrsClassesAndText( string $key, string\|array & $option )` Complete and return semi-finished strings for rendering by field key and option: - Label text string. - Label attributes string. - Control attributes string. Complete and return semi-finished strings for rendering by field key and option: - Label text string. - Label attributes string. - Control attributes string. Parameters `$key` `$option` Returns array

Methods inherited from MvcCore\Ext\Forms\Field
`AddValidationError(), GetValidatorData(), Submit(), __call(), __construct(), __get(), __set(), throwNewInvalidArgumentException(), translateAndFormatValidationError()`

Methods inherited from MvcCore\Ext\Forms\IField
AddControlAttrs(), AddCssClasses(), AddError(), AddValidators(), GetControlAttr(), GetControlAttrs(), GetCssClasses(), GetCssSupportingFile(), GetId(), GetJsClassName(), GetJsSupportingFile(), GetName(), GetTemplates(), GetTitle(), GetType(), GetValidators(), GetViewScript(), HasValidator(), RemoveValidator(), Render(), RenderErrors(), RenderLabelAndControl(), RenderTemplate(), SetControlAttr(), SetControlAttrs(), SetCssClasses(), SetCssSupportingFile(), SetId(), SetJsClassName(), SetJsSupportingFile(), SetName(), SetTemplate(), SetTemplates(), SetTitle(), SetTranslate(), SetType(), SetValidators(), SetViewScript()

Methods inherited from MvcCore\Ext\Forms\Fields\IVisibleField
`GetAccessKey(), GetAutoFocus(), GetDisabled(), GetReadOnly(), GetRequired(), GetTabIndex(), SetAccessKey(), SetAutoFocus(), SetDisabled(), SetReadOnly(), SetRequired(), SetTabIndex()`

Methods inherited from MvcCore\Ext\Forms\Fields\ILabel
`AddLabelAttrs(), GetLabel(), GetLabelAttr(), GetLabelAttrs(), GetLabelSide(), GetRenderMode(), SetLabel(), SetLabelAttr(), SetLabelAttrs(), SetLabelSide(), SetRenderMode()`

Methods inherited from MvcCore\Ext\Forms\Fields\IOptions
`AddOptions(), GetFlattenOptions(), GetOptions(), GetTranslateOptions(), SetOptions(), SetTranslateOptions()`

Methods inherited from MvcCore\Ext\Forms\IFieldsGroup
`AddGroupLabelAttr(), AddGroupLabelCssClasses(), GetGroupLabelAttrs(), GetGroupLabelCssClasses(), SetGroupLabelAttrs(), SetGroupLabelCssClasses()`

Methods used from MvcCore\Ext\Forms\Field\Props\Label
`AddLabelAttrs(), GetLabel(), GetLabelAttr(), GetLabelAttrs(), GetLabelSide(), GetRenderMode(), SetLabel(), SetLabelAttr(), SetLabelAttrs(), SetLabelSide(), SetRenderMode()`

Methods used from MvcCore\Ext\Forms\Field\Props\Options
`AddOptions(), GetFlattenOptions(), GetOptions(), GetTranslateOptions(), SetOptions(), SetTranslateOptions()`

Methods used from MvcCore\Ext\Forms\Field\Props\GroupLabelCssClasses
`AddGroupLabelCssClasses(), GetGroupLabelCssClasses(), SetGroupLabelCssClasses()`

Methods used from MvcCore\Ext\Forms\Field\Props\GroupLabelAttrs
`AddGroupLabelAttr(), GetGroupLabelAttrs(), SetGroupLabelAttrs()`

Methods used from MvcCore\Ext\Forms\Field\Getters
`GetControlAttr(), GetControlAttrs(), GetCssClasses(), GetCssSupportingFile(), GetId(), GetJsClassName(), GetJsSupportingFile(), GetName(), GetTemplates(), GetTitle(), GetTranslate(), GetType(), GetValidators(), GetViewScript(), HasValidator()`

Methods used from MvcCore\Ext\Forms\Field\Setters
`AddControlAttrs(), AddCssClasses(), AddError(), AddValidators(), RemoveValidator(), SetControlAttr(), SetControlAttrs(), SetCssClasses(), SetCssSupportingFile(), SetId(), SetJsClassName(), SetJsSupportingFile(), SetName(), SetTemplate(), SetTemplates(), SetTitle(), SetTranslate(), SetType(), SetValidators(), SetViewScript()`

Methods used from MvcCore\Ext\Forms\Field\Rendering
`Render(), RenderErrors(), RenderLabelAndControl(), RenderTemplate(), renderAttrsWithFieldVars(), renderControlAttrsWithFieldVars(), renderLabelAttrsWithFieldVars()`

Constants inherited from MvcCore\Ext\Forms\IField
`AUTOFOCUS_DUPLICITY_EXCEPTION, AUTOFOCUS_DUPLICITY_QUIETLY_SET_NEW, AUTOFOCUS_DUPLICITY_UNSET_OLD_SET_NEW, LABEL_SIDE_LEFT, LABEL_SIDE_RIGHT`

Properties summary
`protected string\|null`	`$type` Form group pseudo control type, unique type across all form field types. Form group pseudo control type, unique type across all form field types.	# `NULL`
`protected string[]\|null`	`$value` Form group controls value, in most cases it's an array of strings. For extended class `RadioGroup` - the type is only a `string` or `NULL`. Form group controls value, in most cases it's an array of strings. For extended class `RadioGroup` - the type is only a `string` or `NULL`.	# `[]`
`protected static string`	`$templates` Standard field template strings for natural rendering - `label`, `control`, `togetherLabelLeft` and `togetherLabelRight`. Standard field template strings for natural rendering - `label`, `control`, `togetherLabelLeft` and `togetherLabelRight`.	# `[ 'label' => '<label for="{id}"{attrs}>{label}</label>', 'control' => '<input id="{id}" name="{name}" type="{type}" value="{value}"{checked}{attrs} />', 'togetherLabelLeft' => '<label for="{id}"{attrs}><span>{label}</span>{control}</label>', 'togetherLabelRight'=> '<label for="{id}"{attrs}>{control}<span>{label}</span></label>', ]`

Properties used from MvcCore\Ext\Forms\Field\Props
`$controlAttrs, $cssClasses, $cssSupportingFile, $declaredProtectedProperties, $errors, $form, $id, $jsClassName, $jsSupportingFile, $name, $title, $translate, $translateTitle, $validators, $view, $viewScript`

Properties used from MvcCore\Ext\Forms\Field\Props\Label
`$label, $labelAttrs, $labelSide, $renderMode, $translateLabel`

Properties used from MvcCore\Ext\Forms\Field\Props\Options
`$flattenOptions, $options, $translateOptions`

Properties used from MvcCore\Ext\Forms\Field\Props\GroupLabelCssClasses
`$groupLabelCssClasses`

Properties used from MvcCore\Ext\Forms\Field\Props\GroupLabelAttrs
`$groupLabelAttrs`

Classes

Interfaces

Traits

Exceptions

Functions

Class FieldsGroup

Direct known subclasses

Parameters

Returns

Throws

Overrides

Implementation of

Returns

Overrides

Implementation of

Parameters

Returns

Overrides

Implementation of

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

Throws

Overrides

Implementation of

Overrides

Implementation of

Returns

Overrides

Implementation of

Returns

Overrides

Implementation of

Returns

Overrides

Implementation of

Returns

Overrides

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns