Page History

Selection

This field type represents a single selection or multiple choices from a list of options.

Description

The Selection FieldType stores single selections or multiple choices from a list of options, by populating a hash with the list of selected values.

Validation

This FieldType validates the input, verifying if all selected options exist in the field definition, and, checks if multiple selections are allowed in the field definition.
If any of these validations fail a ValidationError  is thrown, specifying the error message, and for the case of the option validation a list with the invalid options is also presented.

Settings

use eZ\Publish\Core\FieldType\Selection\Type;
 
$settings = array(
    "isMultiple" => true,
    "options" => array(1 => 'One', 2 => 'Two', 3 => 'Three')
);

Value object

Properties

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

// Single selection
$value->selection = 1; 
 
// Multiple selection
$value->selection = array( 1, 4, 5 ); 

Constructor

The Selection\Value constructor accepts an array of selected elements identifiers.

// Instanciates a selection value with items #1 and #2 selected
$selectionValue = new Selection\Value( array( 1, 2 ) );