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: CountrySelectViewHelper.php (GitHub).

Arguments¶

The following arguments are available for <f:form.countrySelect>:

Name	Type	Default
additionalAttributes	mixed
data	mixed
aria	mixed
name	string
value	mixed
property	string
class	string
dir	string
id	string
lang	string
style	string
title	string
accesskey	string
tabindex	integer
onclick	string
size	string
disabled	string
excludeCountries	mixed	`array ()`
onlyCountries	mixed	`array ()`
optionLabelField	string	`'localizedName'`
sortByOptionLabel	boolean
errorClass	string	`'f3-form-error'`
prependOptionLabel	string
prependOptionValue	string
multiple	boolean
required	boolean
prioritizedCountries	mixed	`array ()`
alternativeLanguage	string

additionalAttributes ¶

Type: mixed

Additional tag attributes. They will be added directly to the resulting HTML tag.

data ¶

Type: mixed

Additional data-* attributes. They will each be added with a "data-" prefix.

aria ¶

Type: mixed

Additional aria-* attributes. They will each be added with a "aria-" prefix.

name ¶

Type: string

Name of input tag

value ¶

Type: mixed

Value of input tag

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.

class ¶

Type: string

CSS class(es) for this element

dir ¶

Type: string

Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left)

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

style ¶

Type: string

Individual CSS styles for this element

title ¶

Type: string

Tooltip text of element

accesskey ¶

Type: string

Keyboard shortcut to access this element

tabindex ¶

Type: integer

Specifies the tab order of this element

onclick ¶

Type: string

JavaScript evaluated for the onclick event

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

disabled ¶

Type: string

Specifies that the input element should be disabled when the page loads

excludeCountries ¶

Type: mixed
Default: array ()

Array with country codes that should not be shown.

onlyCountries ¶

Type: mixed
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"

sortByOptionLabel ¶

Type: boolean

If true, List will be sorted by label.

errorClass ¶

Type: string
Default: 'f3-form-error'

CSS class to set if there are errors for this ViewHelper

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.

multiple ¶

Type: boolean

If set multiple options may be selected.

required ¶

Type: boolean

If set no empty value is allowed.

prioritizedCountries ¶

Type: mixed
Default: array ()

A list of country codes which should be listed on top of the list.

alternativeLanguage ¶

Type: string

If specified, the country list will be shown in the given language.

Form.countrySelect ViewHelper <f:form.countrySelect>¶