class.ilAdvancedMDFieldDefinitionText.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilAdvancedMDFieldDefinitionText extends ilAdvancedMDFieldDefinitionGroupBased
{
    public const XML_SEPARATOR_TRANSLATIONS = "~|~";
    public const XML_SEPARATOR_TRANSLATION = '~+~';
    public const KEY_MULTI = "multi";

    protected ?int $max_length = null;
    protected bool $multi = false;
    protected bool $multilingual_value_support = true;


    //
    // generic types
    //

    public function getType(): int
    {
        return self::TYPE_TEXT;
    }

    public function getADTGroup(): ilADTDefinition
    {
        return $this->getADTDefinition();
    }

    public function getTitles(): array
    {
        return [];
    }

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

    protected function initADTDefinition(): ilADTDefinition
    {
        $field_translations = ilAdvancedMDFieldTranslations::getInstanceByRecordId($this->getRecordId());

        $definition = ilADTFactory::getInstance()->getDefinitionInstanceByType(ilADTFactory::TYPE_LOCALIZED_TEXT);
        $definition->setMaxLength($this->getMaxLength());
        $definition->setActiveLanguages($field_translations->getActivatedLanguages($this->getFieldId(), true));
        $definition->setDefaultLanguage($field_translations->getDefaultLanguage());
        $definition->setMultilingualValueSupport($this->isMultilingualValueSupport());
        return $definition;
    }


    public function isMultilingualValueSupport(): bool
    {
        return $this->multilingual_value_support;
    }

    public function setMultilingualValueSupport(bool $multilingual_value_support): void
    {
        $this->multilingual_value_support = $multilingual_value_support;
    }

    public function setMaxLength(?int $max_length)
    {
        $this->max_length = $max_length;
    }

    public function getMaxLength(): ?int
    {
        return $this->max_length;
    }

    public function setMulti(bool $a_value): void
    {
        $this->multi = $a_value;
    }

    public function isMulti(): bool
    {
        return $this->multi;
    }


    //
    // definition (NOT ADT-based)
    //

    protected function importFieldDefinition(array $a_def): void
    {
        $this->setMaxLength(isset($a_def["max"]) ? (int) $a_def["max"] : null);
        $this->setMulti((bool) ($a_def[self::KEY_MULTI] ?? false));
        $multilingual_values = (bool) ($a_def['multilingual_values'] ?? true);
        $this->setMultilingualValueSupport($multilingual_values);
    }

    protected function getFieldDefinition(): array
    {
        return [
            "max" => $this->getMaxLength(),
            self::KEY_MULTI => $this->isMulti(),
            'multilingual_values' => $this->isMultilingualValueSupport()
        ];
    }

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

        $lng = $DIC['lng'];

        $res = array();

        if ($this->getMaxLength() !== null) {
            $res[$lng->txt("md_adv_text_max_length")] = $this->getMaxLength();
        }
        if ($this->isMulti()) {
            $res[$lng->txt("md_adv_text_multi")] = $lng->txt("yes");
        }

        return $res;
    }

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

        $lng = $DIC['lng'];
        $lng->loadLanguageModule('meta');

        $max = new ilNumberInputGUI($lng->txt("md_adv_text_max_length"), "max");
        $max->setValue((string) $this->getMaxLength());
        $max->setSize(10);
        $max->setSuffix($lng->txt("characters"));
        $max->setMinValue(1);
        $max->setMaxValue(4000); // DB limit
        $a_form->addItem($max);

        $multi = new ilCheckboxInputGUI($lng->txt("md_adv_text_multi"), self::KEY_MULTI);
        $multi->setValue("1");
        $multi->setChecked($this->isMulti());
        $a_form->addItem($multi);

        if ($a_disabled) {
            $max->setDisabled(true);
            $multi->setDisabled(true);
        }
        $record_translations = ilAdvancedMDRecordTranslations::getInstanceByRecordId($this->getRecordId());
        if (!count($record_translations->getTranslations())) {
            return;
        }
        $multilingual_values = new ilCheckboxInputGUI(
            $lng->txt('md_adv_text_multi_val'),
            'multilingual'
        );
        $multilingual_values->setInfo($lng->txt('md_adv_text_multi_val_info'));
        $multilingual_values->setChecked($this->isMultilingualValueSupport());
        $multilingual_values->setValue("1");
        $a_form->addItem($multilingual_values);
    }

    public function importCustomDefinitionFormPostValues(ilPropertyFormGUI $a_form, string $language = ''): void
    {
        $max = $a_form->getInput("max");
        $this->setMaxLength(($max !== "" && $max !== null) ? (int) $max : null);
        $this->setMulti((bool) $a_form->getInput(self::KEY_MULTI));
        $this->setMultilingualValueSupport((bool) $a_form->getInput('multilingual'));
    }

    //
    // import/export
    //

    protected function addPropertiesToXML(ilXmlWriter $a_writer): void
    {
        $a_writer->xmlElement('FieldValue', array("id" => "max"), $this->getMaxLength());
        $a_writer->xmlElement('FieldValue', array("id" => self::KEY_MULTI), $this->isMulti());
        $a_writer->xmlElement('FieldValue', ['id' => 'multilingual_values'], $this->isMultilingualValueSupport());
    }

    public function importXMLProperty(string $a_key, string $a_value): void
    {
        if ($a_key === "max") {
            $this->setMaxLength($a_value !== "" ? (int) $a_value : null);
        }
        if ($a_key === self::KEY_MULTI) {
            $this->setMulti((bool) $a_value);
        }
        if ($a_key == 'multilingual_values') {
            $this->setMultilingualValueSupport(
                $a_value != '' ? true : false
            );
        }
    }

    public function getValueForXML(ilADT $element): string
    {
        $translations = $element->getTranslations();
        $serialized_values = [];
        foreach ($translations as $lang_key => $translation) {
            $serialized_values[] = $lang_key . self::XML_SEPARATOR_TRANSLATION . $translation;
        }
        return implode(self::XML_SEPARATOR_TRANSLATIONS, $serialized_values);
    }

    public function importValueFromXML(string $a_cdata): void
    {
        // an import from release < 7
        if (strpos($a_cdata, self::XML_SEPARATOR_TRANSLATION) === false) {
            $this->getADT()->setText($a_cdata);
            $record = ilAdvancedMDRecord::_getInstanceByRecordId($this->record_id);
            $this->getADT()->setTranslation($record->getDefaultLanguage(), $a_cdata);
            return;
        }

        $translations = explode(self::XML_SEPARATOR_TRANSLATIONS, $a_cdata);
        foreach ($translations as $translation) {
            $parts = explode(self::XML_SEPARATOR_TRANSLATION, $translation);
            if ($parts === false) {
                continue;
            }
            $this->getADT()->setTranslation($parts[0], $parts[1]);
        }
    }

    public function importFromECS(string $a_ecs_type, $a_value, string $a_sub_id): bool
    {
        $value = '';
        switch ($a_ecs_type) {
            case ilECSUtils::TYPE_ARRAY:
                $value = implode(',', (array) $a_value);
                break;

            case ilECSUtils::TYPE_INT:
                $value = (int) $a_value;
                break;

            case ilECSUtils::TYPE_STRING:
                $value = (string) $a_value;
                break;

            case ilECSUtils::TYPE_TIMEPLACE:
                if ($a_value instanceof ilECSTimePlace) {
                    $value = $a_value->{'get' . ucfirst($a_sub_id)}();
                }
                break;
        }

        if (trim((string) $value)) {
            $this->getADT()->setText(is_null($value) ? null : (string) $value);
            return true;
        }
        return false;
    }

    public function prepareElementForEditor(ilADTFormBridge $a_bridge): void
    {
        if (!$a_bridge instanceof ilADTLocalizedTextFormBridge) {
            $this->logger->warning('Passed ' . get_class($a_bridge));
            return;
        }
        $a_bridge->setMulti($this->isMulti());
    }

    public function getSearchQueryParserValue(ilADTSearchBridge $a_adt_search): string
    {
        return (string) $a_adt_search->getADT()->getText();
    }

    protected function parseSearchObjects(array $a_records, array $a_object_types): array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $res = array();

        $obj_ids = array();
        foreach ($a_records as $record) {
            if ($record["sub_type"] == "-") {
                // keep found information
                $obj_ids[$record["obj_id"]] = $record;
            }
        }

        $sql = "SELECT obj_id,type" .
            " FROM object_data" .
            " WHERE " . $ilDB->in("obj_id", array_keys($obj_ids), false, "integer") .
            " AND " . $ilDB->in("type", $a_object_types, false, "text");
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            $row["found"] = array();
            foreach ($obj_ids[(int) $row["obj_id"]] as $field => $value) {
                if (substr($field, 0, 5) == "found") {
                    $row["found"][$field] = $value;
                }
            }
            $res[] = $row;
        }

        return $res;
    }

    public function searchObjects(
        ilADTSearchBridge $a_adt_search,
        ilQueryParser $a_parser,
        array $a_object_types,
        string $a_locate,
        string $a_search_type
    ): array {
        // :TODO: search type (like, fulltext)

        $condition = $a_adt_search->getSQLCondition(
            ilADTActiveRecordByType::SINGLE_COLUMN_NAME,
            ilADTTextSearchBridgeSingle::SQL_LIKE,
            $a_parser->getQuotedWords()
        );
        if ($condition) {
            $objects = ilADTActiveRecordByType::find(
                'adv_md_values',
                $this->getADT()->getType(),
                $this->getFieldId(),
                $condition,
                $a_locate
            );
            if (isset($objects) && count($objects)) {
                return $this->parseSearchObjects($objects, $a_object_types);
            }
            return [];
        }
        return [];
    }
}