class.ilDclSelectionFieldRepresentation.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

abstract class ilDclSelectionFieldRepresentation extends ilDclBaseFieldRepresentation
{
    // those should be overwritten by subclasses
    public const PROP_SELECTION_TYPE = '';
    public const PROP_SELECTION_OPTIONS = '';

    protected function buildFieldCreationInput(ilObjDataCollection $dcl, string $mode = 'create'): ilRadioOption
    {
        $opt = parent::buildFieldCreationInput($dcl, $mode);

        $selection_options = $this->buildOptionsInput();
        $opt->addSubItem($selection_options);

        $selection_type = new ilRadioGroupInputGUI(
            $this->lng->txt('dcl_selection_type'),
            'prop_' . static::PROP_SELECTION_TYPE
        );
        $selection_type->setRequired(true);

        $options = [
            ilDclSelectionFieldModel::SELECTION_TYPE_SINGLE,
            ilDclSelectionFieldModel::SELECTION_TYPE_COMBOBOX,
            ilDclSelectionFieldModel::SELECTION_TYPE_MULTI
        ];

        foreach ($options as $option) {
            $selection_type->addOption(new ilRadioOption($this->lng->txt('dcl_' . $option), $option));
        }

        $opt->addSubItem($selection_type);

        return $opt;
    }

    public function getInputField(ilPropertyFormGUI $form, ?int $record_id = null): ilFormPropertyGUI
    {
        $options = ilDclSelectionOption::getAllForField((int) $this->getField()->getId());
        switch ($this->getField()->getProperty(static::PROP_SELECTION_TYPE)) {
            case ilDclSelectionFieldModel::SELECTION_TYPE_MULTI:
                $input = new ilMultiSelectInputGUI(
                    $this->getField()->getTitle(),
                    'field_' . $this->getField()->getId()
                );

                $input->setHeight(100);
                $input->setHeightUnit('%; max-height: 150px');
                $input->setWidth(100);
                $input->setWidthUnit('%');

                $array = [];
                foreach ($options as $opt) {
                    $array[$opt->getOptId()] = $opt->getValue();
                }
                $input->setOptions($array);
                break;
            case ilDclSelectionFieldModel::SELECTION_TYPE_COMBOBOX:
                $input = new ilSelectInputGUI($this->getField()->getTitle(), 'field_' . $this->getField()->getId());
                $array = [];
                foreach ($options as $opt) {
                    $array[$opt->getOptId()] = $opt->getValue();
                }
                $input->setOptions(["" => $this->lng->txt('dcl_please_select')] + $array);
                break;
            case ilDclSelectionFieldModel::SELECTION_TYPE_SINGLE:
            default:
                $input = new ilRadioGroupInputGUI($this->getField()->getTitle(), 'field_' . $this->getField()->getId());
                foreach ($options as $opt) {
                    $input->addOption(new ilRadioOption($opt->getValue(), (string) $opt->getOptId()));
                }
                $input->setValue((string) array_keys($options)[0]);
                break;
        }
        $this->setupInputField($input, $this->getField());

        return $input;
    }

    public function addFilterInputFieldToTable(ilTable2GUI $table)
    {
        $input = $table->addFilterItemByMetaType(
            "filter_" . $this->getField()->getId(),
            ilTable2GUI::FILTER_SELECT,
            false,
            $this->getField()->getId()
        );

        $options = ilDclSelectionOption::getAllForField((int) $this->getField()->getId());
        $array = ['' => $this->lng->txt('dcl_all_entries')];
        foreach ($options as $opt) {
            $array[$opt->getOptId()] = $opt->getValue();
        }

        $array['none'] = $this->lng->txt('dcl_no_entry');

        $input->setOptions($array);

        $this->setupFilterInputField($input);

        return $this->getFilterInputFieldValue($input);
    }

    abstract protected function buildOptionsInput(): ilDclGenericMultiInputGUI;
}