Page History

This Field Type represents one or multiple countries.

Table of contents:

Description

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

Input expectations

array(
    "JP" => array(
	    "Name" => "Japan",
        "Alpha2" => "JP",
        "Alpha3" => "JPN",
        "IDC" => 81
    )
);

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:

$settings = array(
	"isMultiple" => true
);

Anchor
ToFromHashFormat ToFromHashFormat

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:

$content->fields["countries"] = array( "JP", "NO" );

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:

$value->countries = array(
    "JP" => array(
        "Name" => "Japan",
        "Alpha2" => "JP",
        "Alpha3" => "JPN",
        "IDC" => 81
    )
)

Constructor

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

// Instantiates a Country Value object
$countryValue = new Country\Value(
	array(
    	"JP" => array(
        	"Name" => "Japan",
        	"Alpha2" => "JP",
        	"Alpha3" => "JPN",
        	"IDC" => 81
		)
	)
);