Class CountrySelect

Responsibility: init, pre-dispatch and render <select> HTML element as roll-out menu for single option select or as options list for multiple selection with options as all existing world states or only filtered world states. CountrySelect 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

MvcCore\Ext\Forms\Fields\CountrySelect

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

Methods summary
`public string`	# `GetValue( )` Return country code in upper case. Return country code in upper case. Returns string Overrides `MvcCore\Ext\Forms\Fields\Select::GetValue()`
`public MvcCore\Ext\Forms\Fields\CountrySelect`	# `SetValue( string $countryCode )` Set country code value. Given country code will be automatically converted to upper case. Set country code value. Given country code will be automatically converted to upper case. Parameters `$countryCode` Returns `MvcCore\Ext\Forms\Fields\CountrySelect` Overrides `MvcCore\Ext\Forms\Fields\Select::SetValue()`
`public static array &`	# `GetAllOptions( )` Get all existing country codes as array with keys as upper cased country codes and values as not translated English state names. Get all existing country codes as array with keys as upper cased country codes and values as not translated English state names. Returns array
`public static`	# `SetAllOptions( array $allOptions = [] )` Set all existing country codes as array with keys as upper cased country codes and values as not translated English state names. Given value will be automatically used as select options, if there will not be configured any filtering to filter displayed countries. Set all existing country codes as array with keys as upper cased country codes and values as not translated English state names. Given value will be automatically used as select options, if there will not be configured any filtering to filter displayed countries. Parameters `$allOptions`
`public MvcCore\Ext\Forms\Fields\CountrySelect`	# `FilterOptions( string[] $countryCodes = [] )` Filter displayed countries to not show every time all existing countries in the world. Given country codes will be automatically converted to upper case. Filter displayed countries to not show every time all existing countries in the world. Given country codes will be automatically converted to upper case. Parameters `$countryCodes` Array of country codes strings to rendered only, not to render all existing states. Returns `MvcCore\Ext\Forms\Fields\CountrySelect`
`public`	# `__construct( array $cfg = [] )` Create new form country `<select>` control instance. If there is record under `filter` key in `$cfg` array argument, it's used for method $field->FilterOptions();` method. Create new form country `<select>` control instance. If there is record under `filter` key in `$cfg` array argument, it's used for method $field->FilterOptions();` method. Parameters `$cfg` Config array with protected properties and it's values which you want to configure, presented in camel case properties names syntax. Throws InvalidArgumentException Overrides `MvcCore\Ext\Forms\Fields\Select::__construct()`
`public MvcCore\Ext\Forms\Fields\CountrySelect`	# `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\CountrySelect` Throws InvalidArgumentException Overrides `MvcCore\Ext\Forms\Fields\Select::SetForm()`
`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 Overrides `MvcCore\Ext\Forms\Fields\Select::RenderControlOptions()`

Methods inherited from MvcCore\Ext\Forms\Fields\Select
`GetValidatorData(), PreDispatch(), RenderControl(), preDispatchTranslateOptionOptGroup(), renderControlOptionKeyValue(), renderControlOptionsAdvanced(), renderControlOptionsGroup()`

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

Methods inherited from MvcCore\Ext\Forms\Fields\IMinMaxOptions
`GetMaxOptions(), GetMaxOptionsBubbleMessage(), GetMinOptions(), GetMinOptionsBubbleMessage(), GetRequiredBubbleMessage(), SetMaxOptions(), SetMaxOptionsBubbleMessage(), SetMinOptions(), SetMinOptionsBubbleMessage(), SetRequiredBubbleMessage()`

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

Methods inherited from MvcCore\Ext\Forms\Fields\IMultiple
`GetMultiple(), SetMultiple()`

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(), RenderControlInsideLabel(), RenderErrors(), RenderLabel(), RenderLabelAndControl(), RenderNaturally(), RenderTemplate(), SetControlAttr(), SetControlAttrs(), SetCssClasses(), SetCssSupportingFile(), SetId(), SetJsClassName(), SetJsSupportingFile(), SetName(), SetTemplate(), SetTemplates(), SetTitle(), SetTranslate(), SetType(), SetValidators(), SetViewScript()

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 inherited from MvcCore\Ext\Forms\Fields\Select
`VERSION`

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: `country-select`, not used in HTML code for this field. Possible value: `country-select`, not used in HTML code for this field.	# `'country-select'`
`protected boolean`	`$translate` Translate English state names. Default value is `FALSE`. Translate English state names. Default value is `FALSE`.	# `FALSE`
`protected static array`	`$allOptions` All existing country codes and English state names. Keys are country codes in upper case, values are English state names. this array is automatically used to render all select options. If there is configured any filtering to filter displayed countries, only selected states are rendered. Use method `$field->FilterOptions();` or constructor `$cfg` array with record `filter` as array with upper case country codes array to render only. All existing country codes and English state names. Keys are country codes in upper case, values are English state names. this array is automatically used to render all select options. If there is configured any filtering to filter displayed countries, only selected states are rendered. Use method `$field->FilterOptions();` or constructor `$cfg` array with record `filter` as array with upper case country codes array to render only.	# [ 'AF' => 'Afghanistan', 'AX' => 'Åland Islands', 'AL' => 'Albania', 'DZ' => 'Algeria', 'AS' => 'American Samoa', 'AD' => 'Andorra', 'AO' => 'Angola', 'AI' => 'Anguilla', 'AQ' => 'Antarctica', 'AG' => 'Antigua and Barbuda', 'AR' => 'Argentina', 'AM' => 'Armenia', 'AW' => 'Aruba', 'AU' => 'Australia', 'AT' => 'Austria', 'AZ' => 'Azerbaijan', 'BS' => 'Bahamas', 'BH' => 'Bahrain', 'BD' => 'Bangladesh', 'BB' => 'Barbados', 'BY' => 'Belarus', 'BE' => 'Belgium', 'BZ' => 'Belize', 'BJ' => 'Benin', 'BM' => 'Bermuda', 'BT' => 'Bhutan', 'BO' => 'Bolivia, Plurinational State of', 'BQ' => 'Bonaire, Sint Eustatius and Saba','BA' => 'Bosnia and Herzegovina','BW' => 'Botswana', 'BV' => 'Bouvet Island', 'BR' => 'Brazil', 'IO' => 'British Indian Ocean Territory', 'BN' => 'Brunei Darussalam', 'BG' => 'Bulgaria', 'BF' => 'Burkina Faso', 'BI' => 'Burundi', 'KH' => 'Cambodia', 'CM' => 'Cameroon', 'CA' => 'Canada', 'CV' => 'Cape Verde', 'KY' => 'Cayman Islands', 'CF' => 'Central African Republic', 'TD' => 'Chad', 'CL' => 'Chile', 'CN' => 'China', 'CX' => 'Christmas Island', 'CC' => 'Cocos (Keeling) Islands', 'CO' => 'Colombia', 'KM' => 'Comoros', 'CG' => 'Congo', 'CD' => 'Congo, the Democratic Republic of the','CK' => 'Cook Islands','CR' => 'Costa Rica', 'CI' => 'Côte d\'Ivoire', 'HR' => 'Croatia', 'CU' => 'Cuba', 'CW' => 'Curaçao', 'CY' => 'Cyprus', 'CZ' => 'Czech Republic', 'DK' => 'Denmark', 'DJ' => 'Djibouti', 'DM' => 'Dominica', 'DO' => 'Dominican Republic', 'EC' => 'Ecuador', 'EG' => 'Egypt', 'SV' => 'El Salvador', 'GQ' => 'Equatorial Guinea', 'ER' => 'Eritrea', 'EE' => 'Estonia', 'ET' => 'Ethiopia', 'FK' => 'Falkland Islands (Malvinas)', 'FO' => 'Faroe Islands', 'FJ' => 'Fiji', 'FI' => 'Finland', 'FR' => 'France', 'GF' => 'French Guiana', 'PF' => 'French Polynesia', 'TF' => 'French Southern Territories', 'GA' => 'Gabon', 'GM' => 'Gambia', 'GE' => 'Georgia', 'DE' => 'Germany', 'GH' => 'Ghana', 'GI' => 'Gibraltar', 'GR' => 'Greece', 'GL' => 'Greenland', 'GD' => 'Grenada', 'GP' => 'Guadeloupe', 'GU' => 'Guam', 'GT' => 'Guatemala', 'GG' => 'Guernsey', 'GN' => 'Guinea', 'GW' => 'Guinea-Bissau', 'GY' => 'Guyana', 'HT' => 'Haiti', 'HM' => 'Heard Island and McDonald Islands','VA' => 'Holy See (Vatican City State)','HN' => 'Honduras', 'HK' => 'Hong Kong', 'HU' => 'Hungary', 'IS' => 'Iceland', 'IN' => 'India', 'ID' => 'Indonesia', 'IR' => 'Iran, Islamic Republic of', 'IQ' => 'Iraq', 'IE' => 'Ireland', 'IM' => 'Isle of Man', 'IL' => 'Israel', 'IT' => 'Italy', 'JM' => 'Jamaica', 'JP' => 'Japan', 'JE' => 'Jersey', 'JO' => 'Jordan', 'KZ' => 'Kazakhstan', 'KE' => 'Kenya', 'KI' => 'Kiribati', 'KP' => 'Korea, Democratic People\'s Republic of','KR' => 'Korea, Republic of','KW' => 'Kuwait', 'KG' => 'Kyrgyzstan', 'LA' => 'Lao People\'s Democratic Republic','LV' => 'Latvia', 'LB' => 'Lebanon', 'LS' => 'Lesotho', 'LR' => 'Liberia', 'LY' => 'Libya', 'LI' => 'Liechtenstein', 'LT' => 'Lithuania', 'LU' => 'Luxembourg', 'MO' => 'Macao', 'MK' => 'Macedonia, the former Yugoslav Republic of', 'MG' => 'Madagascar', 'MW' => 'Malawi', 'MY' => 'Malaysia', 'MV' => 'Maldives', 'ML' => 'Mali', 'MT' => 'Malta', 'MH' => 'Marshall Islands', 'MQ' => 'Martinique', 'MR' => 'Mauritania', 'MU' => 'Mauritius', 'YT' => 'Mayotte', 'MX' => 'Mexico', 'FM' => 'Micronesia, Federated States of','MD' => 'Moldova, Republic of','MC' => 'Monaco', 'MN' => 'Mongolia', 'ME' => 'Montenegro', 'MS' => 'Montserrat', 'MA' => 'Morocco', 'MZ' => 'Mozambique', 'MM' => 'Myanmar', 'NA' => 'Namibia', 'NR' => 'Nauru', 'NP' => 'Nepal', 'NL' => 'Netherlands', 'NC' => 'New Caledonia', 'NZ' => 'New Zealand', 'NI' => 'Nicaragua', 'NE' => 'Niger', 'NG' => 'Nigeria', 'NU' => 'Niue', 'NF' => 'Norfolk Island', 'MP' => 'Northern Mariana Islands', 'NO' => 'Norway', 'OM' => 'Oman', 'PK' => 'Pakistan', 'PW' => 'Palau', 'PS' => 'Palestinian Territory, Occupied','PA' => 'Panama', 'PG' => 'Papua New Guinea', 'PY' => 'Paraguay', 'PE' => 'Peru', 'PH' => 'Philippines', 'PN' => 'Pitcairn', 'PL' => 'Poland', 'PT' => 'Portugal', 'PR' => 'Puerto Rico', 'QA' => 'Qatar', 'RE' => 'Réunion', 'RO' => 'Romania', 'RU' => 'Russian Federation', 'RW' => 'Rwanda', 'BL' => 'Saint Barthélemy', 'SH' => 'Saint Helena, Ascension and Tristan da Cunha', 'KN' => 'Saint Kitts and Nevis','LC' => 'Saint Lucia', 'MF' => 'Saint Martin (French part)', 'PM' => 'Saint Pierre and Miquelon','VC' => 'Saint Vincent and the Grenadines','WS' => 'Samoa', 'SM' => 'San Marino', 'ST' => 'Sao Tome and Principe','SA' => 'Saudi Arabia', 'SN' => 'Senegal', 'RS' => 'Serbia', 'SC' => 'Seychelles', 'SL' => 'Sierra Leone', 'SG' => 'Singapore', 'SX' => 'Sint Maarten (Dutch part)', 'SK' => 'Slovakia', 'SI' => 'Slovenia', 'SB' => 'Solomon Islands', 'SO' => 'Somalia', 'ZA' => 'South Africa', 'GS' => 'South Georgia and the South Sandwich Islands', 'SS' => 'South Sudan', 'ES' => 'Spain', 'LK' => 'Sri Lanka', 'SD' => 'Sudan', 'SR' => 'Suriname', 'SJ' => 'Svalbard and Jan Mayen', 'SZ' => 'Swaziland', 'SE' => 'Sweden', 'CH' => 'Switzerland', 'SY' => 'Syrian Arab Republic', 'TW' => 'Taiwan, Province of China','TJ' => 'Tajikistan', 'TZ' => 'Tanzania, United Republic of','TH' => 'Thailand', 'TL' => 'Timor-Leste', 'TG' => 'Togo', 'TK' => 'Tokelau', 'TO' => 'Tonga', 'TT' => 'Trinidad and Tobago', 'TN' => 'Tunisia', 'TR' => 'Turkey', 'TM' => 'Turkmenistan', 'TC' => 'Turks and Caicos Islands','TV' => 'Tuvalu', 'UG' => 'Uganda', 'UA' => 'Ukraine', 'AE' => 'United Arab Emirates', 'GB' => 'United Kingdom', 'US' => 'United States', 'UM' => 'United States Minor Outlying Islands', 'UY' => 'Uruguay', 'UZ' => 'Uzbekistan', 'VU' => 'Vanuatu', 'VE' => 'Venezuela, Bolivarian Republic of','VN' => 'Viet Nam', 'VG' => 'Virgin Islands, British', 'VI' => 'Virgin Islands, U.S.', 'WF' => 'Wallis and Futuna', 'EH' => 'Western Sahara', 'YE' => 'Yemen', 'ZM' => 'Zambia', 'ZW' => 'Zimbabwe', ]

Properties inherited from MvcCore\Ext\Forms\Fields\Select
`$templates, $validators, $value`

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

Returns

Overrides

Parameters

Returns

Overrides

Returns

Parameters

Parameters

Returns

Parameters

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

Overrides