General

  eZ Systems Website
  Editor documentation


  Developer documentation

  Back to the top

The documentation is moving!

We're moving our developer docs to Github and a new site.
The migration is still in progress, so please contact us in #documentation-contrib on eZ Community Slack if you have any questions or feedback.

This space will not be updated from now on except for critical fixes.

Skip to end of metadata
Go to start of metadata

This Field Type represents one or multiple countries.

NameInternal nameExpected input
Countryezcountryarray

Description

This Field Type makes possible to store and retrieve data representing countries.

PHP API Field Type 

Input expectations

TypeExample
array

Note: When you set an array directly on Content field you don't need to provide all this information, the Field Type will assume it is a hash and in this case will accept a simplified structure described below under To / From Hash format.

Validation

This Field Type validates if the multiple countries are allowed by the field definition, and if the Alpha2 is valid according to the countries configured in eZ Platform.

Settings

The field definition of this Field Type can be configured with one option:

NameTypeDefault valueDescription
isMultiplebooleanfalseThis setting allows (if true) or denies (if false) the selection of multiple countries.
Country FieldType example settings

To / From Hash format

The format used for serialization is simpler than the full format, this is also available when setting value on the content field, by setting the value to an array instead of the Value object. Example of that shown below:

Value object content example

The format used by the toHash method is the Alpha2 value, however the input is capable of accepting either Name, Alpha2 or Alpha3 value as shown below in the Value object section.

Value object

Properties

The Value class of this field type contains the following properties:

PropertyTypeDescription
$countriesarray[]This property will be used for the country selection provided as input, as its attributes.
Value object content example
Constructor

The Country\Value constructor will initialize a new Value object with the value provided. It expects an array as input.

Constructor example