class.ilAdvancedMDFieldDefinitionGroupBased.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

abstract class ilAdvancedMDFieldDefinitionGroupBased extends ilAdvancedMDFieldDefinition
{
    protected $options = [];
    protected $complex = [];

    protected function initADTDefinition(): ilADTDefinition
    {
        $def = ilADTFactory::getInstance()->getDefinitionInstanceByType("Enum");
        $def->setNumeric(false);

        $options = $this->getOptions();
        $def->setOptions($options);
        return $def;
    }

    public function setOptions(?array $a_values = null): void
    {
        if ($a_values !== null) {
            foreach ($a_values as $idx => $value) {
                $a_values[$idx] = trim($value);
                if (!$a_values[$idx]) {
                    unset($a_values[$idx]);
                }
            }
            $a_values = array_unique($a_values);
            // sort($a_values);
        }
        $this->options = $a_values;
    }

    public function getOptions(): array
    {
        return $this->options;
    }

    protected function importFieldDefinition(array $a_def): void
    {
        $this->setOptions($a_def["options"] ?? []);
        $this->complex = $a_def["complex"] ?? [];
    }

    protected function getFieldDefinition(): array
    {
        return array(
            "options" => $this->options,
            "complex" => $this->complex
        );
    }

    public function getFieldDefinitionForTableGUI(string $content_language): array
    {
        global $lng;

        return array($lng->txt("options") => implode(",", $this->getOptions()));
    }

    protected function addCustomFieldToDefinitionForm(
        ilPropertyFormGUI $a_form,
        bool $a_disabled = false,
        string $language = ''
    ): void {
        global $lng;

        $field = new ilTextInputGUI($lng->txt("options"), "opts");
        $field->setRequired(true);
        $field->setMulti(true);
        $field->setMaxLength(255); // :TODO:
        $a_form->addItem($field);

        $options = $this->getOptions();
        if ($options) {
            $field->setMultiValues($options);
            $field->setValue(array_shift($options));
        }

        if ($a_disabled) {
            $field->setDisabled(true);
        }
    }

    public function importCustomDefinitionFormPostValues(ilPropertyFormGUI $a_form, string $language = ''): void
    {
        $old = $this->getOptions();
        $new = $a_form->getInput("opts");

        if (is_array($old)) {
            $missing = array_diff($old, $new);
            if (sizeof($missing)) {
                foreach ($missing as $item) {
                    unset($this->complex[$item]);
                }
            }
        }

        $this->setOptions($new);
    }

    protected function addPropertiesToXML(ilXmlWriter $a_writer): void
    {
        foreach ($this->getOptions() as $value) {
            $a_writer->xmlElement('FieldValue', null, $value);
        }
    }

    public function importXMLProperty(string $a_key, string $a_value): void
    {
        $this->options[] = $a_value;
    }


    //
    // import/export
    //

    public function getValueForXML(ilADT $element): string
    {
        return $element->getSelection();
    }

    public function importValueFromXML(string $a_cdata): void
    {
        /*
         * On import from <7 options are not given by index but by
         * their label. There is nothing in the XML by which one could
         * tell apart legacy and standard imports, so we have to
         * make a best guess here (32410).
         *
         * Might fail for enums where the labels are integers.
         * See also ilAdvancedMDFieldDefinitionSelect::translateLegacyImportValueFromXML.
         */
        if (
            !in_array($a_cdata, array_keys($this->options)) &&
            in_array($a_cdata, $this->options)
        ) {
            $a_cdata = (string) array_search($a_cdata, $this->options);
        }
        $this->getADT()->setSelection($a_cdata);
    }


    //
    // complex options
    //

    abstract public function getADTGroup(): ilADTDefinition;

    abstract public function getTitles(): array;

    public function hasComplexOptions(): bool
    {
        return true;
    }

    protected function getADTForOption(string $a_option): ilADT
    {
        $adt = ilADTFactory::getInstance()->getInstanceByDefinition($this->getADTGroup());
        if (array_key_exists($a_option, $this->complex)) {
            $adt->importStdClass($this->complex[$a_option]);
        }
        return $adt;
    }

    public function getComplexOptionsOverview(object $a_parent_gui, string $a_parent_cmd): ?string
    {
        $tbl = new ilAdvancedMDFieldDefinitionGroupTableGUI($a_parent_gui, $a_parent_cmd, $this);
        return $tbl->getHTML();
    }

    public function exportOptionToTableGUI($a_option, array &$a_item): void
    {
        $adt = $this->getADTForOption($a_option);
        foreach ($adt->getElements() as $title => $element) {
            $pres = ilADTFactory::getInstance()->getPresentationBridgeForInstance($element);
            $a_item[$title] = $pres->getList();
        }
    }

    public function initOptionForm(ilPropertyFormGUI $a_form, $a_option_id)
    {
        global $lng;

        $option = $this->findOptionById($a_option_id);
        if ($option) {
            $title = new ilTextInputGUI($lng->txt("option"), "option");
            $title->setValue($option);
            $title->setDisabled(true);
            $a_form->addItem($title);

            $adt = $this->getADTForOption($option);
            $adt_form = ilADTFactory::getInstance()->getFormBridgeForInstance($adt);
            $adt_form->setForm($a_form);

            $titles = $this->getTitles();
            foreach ($adt_form->getElements() as $id => $element) {
                $element->setTitle($titles[$id]);
            }

            $adt_form->addToForm();
        }
    }

    public function updateComplexOption(ilPropertyFormGUI $a_form, $a_option_id)
    {
        $option = $this->findOptionById($a_option_id);
        if ($option) {
            $adt = ilADTFactory::getInstance()->getInstanceByDefinition($this->getADTGroup());
            $adt_form = ilADTFactory::getInstance()->getFormBridgeForInstance($adt);
            $adt_form->setForm($a_form);
            if ($adt_form->validate()) {
                $adt_form->importFromPost();
                $this->importComplexOptionFromForm($option, $adt);
                return true;
            }
        }

        return false;
    }

    protected function importComplexOptionFromForm(string $a_option, ilADT $a_adt)
    {
        $this->complex[$a_option] = $a_adt->exportStdClass();
    }

    protected function findOptionById(string $a_id): ?string
    {
        foreach ($this->getOptions() as $item) {
            if (md5($item) == $a_id) {
                return $item;
            }
        }
        return null;
    }
}