Class CheckboxGroup

Responsibility: init, pre-dispatch and render group of inputs with type as checkbox, with configuration to select minimum and maximum count of values and required option. CheckboxGroup has it's own validator to check if submitted values are presented in configured by default and it's own validator to check minimum or maximum count of selected options.

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

MvcCore\Ext\Forms\Fields\CheckboxGroup implements MvcCore\Ext\Forms\Fields\IMinMaxOptions uses MvcCore\Ext\Forms\Field\Props\MinMaxOptions

Namespace: MvcCore\Ext\Forms\Fields
Located at ext-form-field-selection/src/MvcCore/Ext/Forms/Fields/CheckboxGroup.php

Methods summary
`public`	# `__construct( array $cfg = [] )` Create new form `<input type="checkbox" />` group control instance. Create new form `<input type="checkbox" />` group control instance. Parameters `$cfg` Config array with public properties and it's values which you want to configure, presented in camel case properties names syntax. Throws InvalidArgumentException Overrides `MvcCore\Ext\Forms\Field::__construct()`
`public MvcCore\Ext\Forms\Fields\Select`	# `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. - Check if there are defined validators if there are defined minimum or maximum selected options. 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. - Check if there are defined validators if there are defined minimum or maximum selected options. Parameters `$form` Returns `MvcCore\Ext\Forms\Fields\Select` Throws InvalidArgumentException Overrides `MvcCore\Ext\Forms\FieldsGroup::SetForm()`
`public array &`	# `GetValidatorData( array $fieldPropsDefaultValidValues = [] )` Return field specific data for validator. Return field specific data for validator. Parameters `$fieldPropsDefaultValidValues` Returns array Overrides `MvcCore\Ext\Forms\Field::GetValidatorData()`
`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. - Translate browser bubble messages if necessary. - Add supporting javascripts 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. - Translate browser bubble messages if necessary. - Add supporting javascripts if necessary. Overrides `MvcCore\Ext\Forms\FieldsGroup::PreDispatch()`
`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 Overrides `MvcCore\Ext\Forms\FieldsGroup::renderControlItemCompleteAttrsClassesAndText()`

Methods inherited from MvcCore\Ext\Forms\FieldsGroup
`CreateInstance(), GetMultiple(), GetValue(), RenderControl(), RenderControlInsideLabel(), RenderControlItem(), RenderLabel(), RenderNaturally(), SetMultiple(), SetValue()`

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

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

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

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\IVisibleField
`GetAccessKey(), GetAutoFocus(), GetDisabled(), GetReadOnly(), GetRequired(), GetTabIndex(), SetAccessKey(), SetAutoFocus(), SetDisabled(), SetReadOnly(), SetRequired(), SetTabIndex()`

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\IMinMaxOptions
`GetMaxOptions(), GetMaxOptionsBubbleMessage(), GetMinOptions(), GetMinOptionsBubbleMessage(), GetRequiredBubbleMessage(), SetMaxOptions(), SetMaxOptionsBubbleMessage(), SetMinOptions(), SetMinOptionsBubbleMessage(), SetRequiredBubbleMessage()`

Methods used from MvcCore\Ext\Forms\Field\Props\MinMaxOptions
`GetMaxOptions(), GetMaxOptionsBubbleMessage(), GetMinOptions(), GetMinOptionsBubbleMessage(), GetRequiredBubbleMessage(), SetMaxOptions(), SetMaxOptionsBubbleMessage(), SetMinOptions(), SetMinOptionsBubbleMessage(), SetRequiredBubbleMessage(), setFormMinMaxOptions()`

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 summary
`integer`	`ERROR_REQUIRED_BUBBLE` Valid email address error message index. Valid email address error message index.	# `0`
`integer`	`ERROR_MIN_OPTIONS_BUBBLE`	# `1`
`integer`	`ERROR_MAX_OPTIONS_BUBBLE`	# `2`

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 static array`	`$errorMessages` Validation failure message template definitions. Validation failure message template definitions.	# [ self::ERROR_REQUIRED_BUBBLE => "Please tick this box, field is required.", self::ERROR_MIN_OPTIONS_BUBBLE => "Please select at least `{1}` option(s) as minimum.", self::ERROR_MAX_OPTIONS_BUBBLE => "Please select up to `{1}` option(s) at maximum.", ]
`protected string`	`$type` Possible value: `checkbox`, used in HTML code for this fields. Possible value: `checkbox`, used in HTML code for this fields.	# `'checkbox-group'`
`protected string[]\|Closure[]`	`$validators` Validators: - `ValueInOptions` - to validate if submitted string(s) are presented in select options keys. Validators: - `ValueInOptions` - to validate if submitted string(s) are presented in select options keys.	# `["ValueInOptions"]`
`protected string`	`$jsClassName` Supporting javascript full javascript class name. If you want to use any custom supporting javascript prototyped class for any additional purposes for your custom field, you need to use `$field->jsSupportingFile` property to define path to your javascript file relatively from configured `\MvcCore\Ext\Form::SetJsSupportFilesRootDir(...);` value. Than you have to add supporting javascript file path into field form in `$field->PreDispatch();` method to render those files immediately after form (once) or by any external custom assets renderer configured by: `$form->SetJsSupportFilesRenderer(...);` method. Or you can add your custom supporting javascript files into response by your own and also you can run your helper javascripts also by your own. Is up to you. `NULL` by default. Supporting javascript full javascript class name. If you want to use any custom supporting javascript prototyped class for any additional purposes for your custom field, you need to use `$field->jsSupportingFile` property to define path to your javascript file relatively from configured `\MvcCore\Ext\Form::SetJsSupportFilesRootDir(...);` value. Than you have to add supporting javascript file path into field form in `$field->PreDispatch();` method to render those files immediately after form (once) or by any external custom assets renderer configured by: `$form->SetJsSupportFilesRenderer(...);` method. Or you can add your custom supporting javascript files into response by your own and also you can run your helper javascripts also by your own. Is up to you. `NULL` by default.	# `'MvcCoreForm.CheckboxGroup'`
`protected string`	`$jsSupportingFile` Field supporting javascript file relative path. If you want to use any custom supporting javascript file (with prototyped class) for any additional purposes for your custom field, you need to define path to your javascript file relatively from configured `\MvcCore\Ext\Form::SetJsSupportFilesRootDir(...);` value. Than you have to add supporting javascript file path into field form in `$field->PreDispatch();` method to render those files immediately after form (once) or by any external custom assets renderer configured by: `$form->SetJsSupportFilesRenderer(...);` method. Or you can add your custom supporting javascript files into response by your own and also you can run your helper javascripts also by your own. Is up to you. `NULL` by default. Field supporting javascript file relative path. If you want to use any custom supporting javascript file (with prototyped class) for any additional purposes for your custom field, you need to define path to your javascript file relatively from configured `\MvcCore\Ext\Form::SetJsSupportFilesRootDir(...);` value. Than you have to add supporting javascript file path into field form in `$field->PreDispatch();` method to render those files immediately after form (once) or by any external custom assets renderer configured by: `$form->SetJsSupportFilesRenderer(...);` method. Or you can add your custom supporting javascript files into response by your own and also you can run your helper javascripts also by your own. Is up to you. `NULL` by default.	# `\MvcCore\Ext\IForm::FORM_ASSETS_DIR_REPLACEMENT . '/fields/checkbox-group.js'`
`protected string`	`$maxOptionsClassName` Maximum options specific css class for supporting javascript code. Maximum options specific css class for supporting javascript code.	# `'max-selected-options'`
`protected static string`	`$templates` Standard field template strings for natural rendering a `control`. Standard field template strings for natural rendering a `control`.	# `[ 'control' => '<input id="{id}" name="{name}[]" type="checkbox" value="{value}"{checked}{attrs} />', ]`

Properties inherited from MvcCore\Ext\Forms\FieldsGroup
`$value`

Properties used from MvcCore\Ext\Forms\Field\Props
`$controlAttrs, $cssClasses, $cssSupportingFile, $declaredProtectedProperties, $errors, $form, $id, $name, $title, $translate, $translateTitle, $value, $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`

Properties used from MvcCore\Ext\Forms\Field\Props\MinMaxOptions
`$maxOptions, $maxOptionsBubbleMessage, $minOptions, $minOptionsBubbleMessage, $requiredBubbleMessage`

Classes

Interfaces

Traits

Exceptions

Functions

Class CheckboxGroup

Parameters

Throws

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Overrides

Overrides

Parameters

Returns

Overrides