Skip to main content
Version: 2024.1

Select Options

Select options are predefined sets of options which may be used for (multi)select fields.

Fieldcollection ConfigurationFieldcollection ConfigurationFieldcollection Configuration

The 'Name' column is optional, unless the value can't be converted to a valid PHP enum case. This applies to values starting with a number or certain symbols. A name may contain alphanumeric characters and underscores.

Field configuration​

Set the options source to 'Select Options' and select one of the select options sets.

Fieldcollection ConfigurationFieldcollection ConfigurationFieldcollection Configuration

Working with PHP API​

The configuration in the first screenshot generates the backed enum below.

<?php

namespace Pimcore\Model\DataObject\SelectOptions;

enum TestOptions: string implements \App\SelectOptions\DataInterface, \App\SelectOptions\NameInterface
{
    use \Pimcore\Model\DataObject\SelectOptions\Traits\EnumGetValuesTrait;
    use \Pimcore\Model\DataObject\SelectOptions\Traits\EnumTryFromNullableTrait;
    use \App\SelectOptions\DataTrait;
    use \App\SelectOptions\NameTrait;

    case Ten = 'ten';
    case Twenty = '20';
    case Check = '√';
    case C = '©';
    case Multiple_Word_Value = 'Multiple Word Value';

    public function getLabel(): string
    {
        return match ($this) {
            self::Ten => '10',
            self::Twenty => 'Twenty',
            self::Check => '√',
            self::C => '©',
            self::Multiple_Word_Value => 'Multiple Word Value',
        };
    }
}

Retrieve available option values​

Provided by the EnumGetValuesTrait.

TestOptions::getValues();

Map select value to enum​

Provided by the EnumTryFromNullableTrait.

$value = $product->getSelectField();
$testOption = TestOptions::tryFromNullable($value);
if ($testOption !== null) {
    $label = $testOption->getLabel();
}