Form.countrySelect ViewHelper <f:form.countrySelect>
Renders a <select> tag with all available countries as options.
Examples
Basic usage
<f:form.countrySelect name="country" value="{defaultCountry}" />
Output:
<select name="country">
<option value="BE">Belgium</option>
<option value="FR">France</option>
....
</select>
Prioritize countries
Define a list of countries which should be listed as first options in the form element:
<f:form.countrySelect
name="country"
value="AT"
prioritizedCountries="{0: 'DE', 1: 'AT', 2: 'CH'}"
/>
Additionally, Austria is pre-selected.
Display another language
A combination of optionLabelField and alternativeLanguage is possible. For instance, if you want to show the localized official names but not in your default language but in French. You can achieve this by using the following combination:
<f:form.countrySelect
name="country"
optionLabelField="localizedOfficialName"
alternativeLanguage="fr"
sortByOptionLabel="true"
/>
Bind an object
You can also use the "property" attribute if you have bound an object to the form. See <f:form> for more documentation.
Source code
Go to the source code of this ViewHelper: Form\CountrySelectViewHelper.php (GitHub).
Arguments
Allows arbitrary arguments
This ViewHelper allows you to pass arbitrary arguments not defined below directly
to the HTML tag created. This includes custom
data- arguments.
The following arguments are available for the form.countrySelect ViewHelper:
accesskey
-
- Type
- string
Keyboard shortcut to access this element
additionalAttributes
-
- Type
- array
Additional tag attributes. They will be added directly to the resulting HTML tag.
alternativeLanguage
-
- Type
- string
If specified, the country list will be shown in the given language.
aria
-
- Type
- array
Additional aria-* attributes. They will each be added with a "aria-" prefix.
class
-
- Type
- string
CSS class(es) for this element
data
-
- Type
- array
Additional data-* attributes. They will each be added with a "data-" prefix.
dir
-
- Type
- string
Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left)
disabled
-
- Type
- string
Specifies that the input element should be disabled when the page loads
errorClass
-
- Type
- string
- Default
- 'f3-form-error'
CSS class to set if there are errors for this ViewHelper
excludeCountries
-
- Type
- array
- Default
- array ( )
Array with country codes that should not be shown.
id
-
- Type
- string
Unique (in this file) identifier for this HTML element.
lang
-
- Type
- string
Language for this element. Use short names specified in RFC 1766
multiple
-
- Type
- boolean
- Default
- false
If set multiple options may be selected.
name
-
- Type
- string
Name of input tag
onclick
-
- Type
- string
JavaScript evaluated for the onclick event
onlyCountries
-
- Type
- array
- Default
- array ( )
If set, only the country codes in the list are rendered.
optionLabelField
-
- Type
- string
- Default
- 'localizedName'
If specified, will call the appropriate getter on each object to determine the label. Use "name", "localizedName", "officialName" or "localizedOfficialName"
prependOptionLabel
-
- Type
- string
If specified, will provide an option at first position with the specified label.
prependOptionValue
-
- Type
- string
If specified, will provide an option at first position with the specified value.
prioritizedCountries
-
- Type
- array
- Default
- array ( )
A list of country codes which should be listed on top of the list.
property
-
- Type
- string
Name of Object Property. If used in conjunction with <f:form object="...">, the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value.
required
-
- Type
- boolean
- Default
- false
If set no empty value is allowed.
size
-
- Type
- string
Size of select field, a numeric value to show the amount of items to be visible at the same time - equivalent to HTML <select> site attribute
sortByOptionLabel
-
- Type
- boolean
- Default
- false
If true, List will be sorted by label.
style
-
- Type
- string
Individual CSS styles for this element
tabindex
-
- Type
- integer
Specifies the tab order of this element
title
-
- Type
- string
Tooltip text of element
value
-
- Type
- mixed
Value of input tag