Class Select

Responsibility: init, pre-dispatch and render <select> HTML element as roll-out menu for single option select or as options list for multiple selection. Select field has it's own validator to check if submitted value is presented in configured options by default.

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

Direct known subclasses

MvcCore\Ext\Forms\Fields\CountrySelect, MvcCore\Ext\Forms\Fields\LocalizationSelect

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

Methods summary
`public array\|string\|null`	# `GetValue( )` If select has `multiple` boolean attribute defined, this function returns `\string[]` array. If select has no `multiple` attribute, this function returns `string`. If there is no value selected or configured, function returns `NULL`. If select has `multiple` boolean attribute defined, this function returns `\string[]` array. If select has no `multiple` attribute, this function returns `string`. If there is no value selected or configured, function returns `NULL`. Returns array\|string\|null Overrides `MvcCore\Ext\Forms\Field\Getters::GetValue()`
`public MvcCore\Ext\Forms\Fields\Select`	# `SetValue( array\|string\|null $value )` If select has `multiple` boolean attribute, set to this function `\string[]` array. If select has not `multiple` attribute, set to this function `string`. If you don't want any selected value, set `NULL`. If select has `multiple` boolean attribute, set to this function `\string[]` array. If select has not `multiple` attribute, set to this function `string`. If you don't want any selected value, set `NULL`. Parameters `$value` Returns `MvcCore\Ext\Forms\Fields\Select` Overrides `MvcCore\Ext\Forms\Field\Setters::SetValue()`
`public`	# `__construct( array $cfg = [] )` Create new form `<select>` control instance. Create new form `<select>` 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 instance by `$form->AddField();` method. Do not use this method even if you don't develop any form field. - 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. - Set up translate boolean property. - Check if there are any select options in `$this->options`. - Set up select minimum/maximum options to select if necessary. This INTERNAL method is called from `\MvcCore\Ext\Form` after field is added into form instance by `$form->AddField();` method. Do not use this method even if you don't develop any form field. - 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. - Set up translate boolean property. - Check if there are any select options in `$this->options`. - Set up select minimum/maximum options to select if necessary. Parameters `$form` Returns `MvcCore\Ext\Forms\Fields\Select` Throws InvalidArgumentException Overrides `MvcCore\Ext\Forms\Field::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 if not defined. - Translate label text if necessary. - Set up tab-index if necessary. - Translate all options if necessary, including null option text 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 if not defined. - Translate label text if necessary. - Set up tab-index if necessary. - Translate all options if necessary, including null option text if necessary. Overrides `MvcCore\Ext\Forms\Field::PreDispatch()`
`protected`	# `preDispatchTranslateOptionOptGroup( array & $optionsGroup )` Translate select option item if option item is configured as array for option group. Translate select option item if option item is configured as array for option group. Parameters `$optionsGroup` $optionsGroup
`public string`	# `RenderControl( )` 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 control tag only without label or specific errors, including all select `<option>` tags or `<optgroup>` tags if there are options configured for. Returns string Overrides `MvcCore\Ext\Forms\Field\Rendering::RenderControl()`
`public string`	# `RenderControlOptions( )` 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 inner select control `<option>` tags or `<optgroup>` tags if there are options configured for. Returns string
`protected string`	# `renderControlOptionKeyValue( string\|null $value, string & $text, boolean $valueTypeIsArray )` Render select `<option>` tag with inner visible text and attributes: `value` and `selected` (optionally) by given `$value` string for value to select and `$text` string for visible text. Render select `<option>` tag with inner visible text and attributes: `value` and `selected` (optionally) by given `$value` string for value to select and `$text` string for visible text. Parameters `$value` `$text` `$valueTypeIsArray` Returns string
`protected string`	# `renderControlOptionsGroup( array & $optionsGroup, boolean $valueTypeIsArray )` Render `<optgroup>` tag including it's rendered `<option>` tags. Render `<optgroup>` tag including it's rendered `<option>` tags. Parameters `$optionsGroup` `$valueTypeIsArray` Returns string
`protected mixed`	# `renderControlOptionsAdvanced( string\|null $value, mixed $optionData, mixed $valueTypeIsArray )` Render select `<option>` tag with inner visible text and attributes: `value`, `selected` (optionally), `class` (optionally) and any other optional attributes if configured by given `$value` string and `$optionData` array with additional option configuration data. Render select `<option>` tag with inner visible text and attributes: `value`, `selected` (optionally), `class` (optionally) and any other optional attributes if configured by given `$value` string and `$optionData` array with additional option configuration data. Parameters `$value` `$optionData` `$valueTypeIsArray` Returns mixed

Methods inherited from MvcCore\Ext\Forms\Field
`AddValidationError(), CreateInstance(), Submit(), __call(), __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(), RenderControlInsideLabel(), RenderErrors(), RenderLabel(), RenderLabelAndControl(), RenderNaturally(), 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\IMultiple
`GetMultiple(), SetMultiple()`

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

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\Label
`AddLabelAttrs(), GetLabel(), GetLabelAttr(), GetLabelAttrs(), GetLabelSide(), GetRenderMode(), SetLabel(), SetLabelAttr(), SetLabelAttrs(), SetLabelSide(), SetRenderMode()`

Methods used from MvcCore\Ext\Forms\Field\Props\AutoComplete
`GetAutoComplete(), SetAutoComplete()`

Methods used from MvcCore\Ext\Forms\Field\Props\Multiple
`GetMultiple(), SetMultiple()`

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

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\NullOptionText
`GetNullOptionText(), SetNullOptionText(), preDispatchNullOptionText()`

Methods used from MvcCore\Ext\Forms\Field\Props\Size
`GetSize(), SetSize()`

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(), RenderControlInsideLabel(), RenderErrors(), RenderLabel(), RenderLabelAndControl(), RenderNaturally(), RenderTemplate(), renderAttrsWithFieldVars(), renderControlAttrsWithFieldVars(), renderLabelAttrsWithFieldVars()`

Constants summary
`string`	`VERSION` MvcCore Extension - Form - Field - Selection - version: Comparison by PHP function version_compare(); MvcCore Extension - Form - Field - Selection - version: Comparison by PHP function version_compare(); See http://php.net/manual/en/function.version-compare.php	# `'5.0.0'`

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`	`$type` Possible value: `select`, not used in HTML code for this field. Possible value: `select`, not used in HTML code for this field.	# `'select'`
`protected string\|array\|null`	`$value` Possible values: a string value, array of strings (for select with `multiple` attribute) or `NULL`. Possible values: a string value, array of strings (for select with `multiple` attribute) or `NULL`.	# `NULL`
`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 static string`	`$templates` Standard field template strings for natural rendering - `control`, `option` and `optionsGroup`. Standard field template strings for natural rendering - `control`, `option` and `optionsGroup`.	# `[ 'control' => '<select id="{id}" name="{name}"{size}{attrs}>{options}</select>', 'option' => '<option value="{value}"{selected}{class}{attrs}>{text}</option>', 'optionsGroup' => '<optgroup{label}{class}{attrs}>{options}</optgroup>', ]`

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

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

Properties used from MvcCore\Ext\Forms\Field\Props\AutoComplete
`$autoComplete`

Properties used from MvcCore\Ext\Forms\Field\Props\Multiple
`$multiple`

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

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

Properties used from MvcCore\Ext\Forms\Field\Props\NullOptionText
`$nullOptionText, $translateNullOptionText`

Properties used from MvcCore\Ext\Forms\Field\Props\Size
`$size`

Classes

Interfaces

Traits

Exceptions

Functions

Class Select

Direct known subclasses

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Throws

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Overrides

Overrides

Parameters

Returns

Overrides

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

See