class.ilDclBaseFieldModel.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilDclBaseFieldModel
{
    protected string $id = "";
    protected int $table_id = 0;
    protected string $title = "";
    protected string $description = "";
    protected int $datatype_id = 0;
    protected ?int $order = null;
    protected bool $unique = false;
    protected array $property = [];
    protected bool $exportable = false;
    protected ?ilDclDatatype $datatype = null;
    protected ?int $storage_location_override = null;
    public const PROP_LENGTH = "lenght";
    public const PROP_REGEX = "regex";
    public const PROP_REFERENCE = "table_id";
    public const PROP_URL = "url";
    public const PROP_REFERENCE_LINK = "reference_link";
    public const PROP_WIDTH = "width";
    public const PROP_HEIGHT = "height";
    public const PROP_LEARNING_PROGRESS = "learning_progress";
    public const PROP_ILIAS_REFERENCE_LINK = "ILIAS_reference_link";
    public const PROP_N_REFERENCE = "multiple_selection";
    public const PROP_FORMULA_EXPRESSION = "expression";
    public const PROP_DISPLAY_COPY_LINK_ACTION_MENU = "display_action_menu";
    public const PROP_LINK_DETAIL_PAGE_TEXT = "link_detail_page_text";
    public const PROP_LINK_DETAIL_PAGE_MOB = "link_detail_page_mob";
    public const PROP_SUPPORTED_FILE_TYPES = "supported_file_types";
    public const PROP_PLUGIN_HOOK_NAME = "plugin_hook_name";
    // type of table il_dcl_view
    public const EDIT_VIEW = 2;
    public const EXPORTABLE_VIEW = 4;

    protected ilDBInterface $db;
    protected ilLanguage $lng;

    public function __construct(int $a_id = 0)
    {
        global $DIC;
        $this->db = $DIC->database();
        $this->lng = $DIC->language();

        if ($a_id != 0) {
            $this->id = (string) $a_id;
            $this->doRead();
        }
    }

    public static function _getTitleInvalidChars(bool $a_as_regex = true): string
    {
        if ($a_as_regex) {
            return '/^[^<>\\\\":]*$/i';
        } else {
            return '\ < > " :';
        }
    }

    public static function _getFieldIdByTitle(string $title, int $table_id): int
    {
        global $DIC;
        $ilDB = $DIC->database();

        $result = $ilDB->query(
            'SELECT id FROM il_dcl_field WHERE title = ' . $ilDB->quote($title, 'text') . ' AND table_id = '
            . $ilDB->quote($table_id, 'integer')
        );
        $id = 0;
        while ($rec = $ilDB->fetchAssoc($result)) {
            $id = $rec['id'];
        }

        return $id;
    }

    public function setId($a_id): void
    {
        $this->id = (string) $a_id;
    }

    public function getId(): string
    {
        return $this->id;
    }

    public function setTableId(int $a_id): void
    {
        $this->table_id = $a_id;
    }

    public function getTableId(): int
    {
        return $this->table_id;
    }

    public function setTitle(string $a_title): void
    {
        //title cannot begin with _ as this is saved for other purposes. make __ instead.
        if (substr($a_title, 0, 1) == "_" && substr($a_title, 0, 2) != "__") {
            $a_title = "_" . $a_title;
        }
        $this->title = $a_title;
    }

    public function getTitle(): string
    {
        return $this->title;
    }

    public function setDescription(string $a_desc): void
    {
        $this->description = $a_desc;
    }

    public function getDescription(): string
    {
        return $this->description;
    }

    public function setDatatypeId(int $a_id): void
    {
        //unset the cached datatype.
        $this->datatype = null;
        $this->datatype_id = $a_id;
    }

    public function getDatatypeId(): ?int
    {
        if ($this->isStandardField()) {
            return ilDclStandardField::_getDatatypeForId($this->getId());
        }

        return $this->datatype_id;
    }

    public function isUnique(): bool
    {
        return $this->unique;
    }

    public function setUnique(?bool $unique): void
    {
        $this->unique = (bool) $unique;
    }

    public function getDatatype(): ilDclDatatype
    {
        $this->loadDatatype();

        return $this->datatype;
    }

    public function getDatatypeTitle(): string
    {
        $this->loadDatatype();
        return $this->datatype->getTitle();
    }

    public function getPresentationTitle(): string
    {
        return $this->lng->txt('dcl_' . $this->getDatatypeTitle());
    }

    public function getPresentationDescription(): string
    {
        return $this->lng->txt('dcl_' . $this->getDatatypeTitle() . '_desc');
    }

    public function getStorageLocation(): ?int
    {
        if ($this->getStorageLocationOverride() !== null) {
            return $this->getStorageLocationOverride();
        }

        $this->loadDatatype();

        return $this->datatype->getStorageLocation();
    }

    protected function loadDatatype(): void
    {
        if ($this->datatype == null) {
            $this->datatype = ilDclCache::getDatatype($this->datatype_id);
        }
    }

    protected function loadTableFieldSetting(): void
    {
        $tablefield_setting = ilDclTableFieldSetting::getInstance($this->getTableId(), $this->getId());
        $this->exportable = $tablefield_setting->isExportable();
        $this->order = $tablefield_setting->getFieldOrder();
    }

    public function getExportable(): bool
    {
        if (!isset($this->exportable)) {
            $this->loadExportability();
        }

        return $this->exportable;
    }

    private function loadExportability(): void
    {
        if ($this->exportable == null) {
            $this->loadTableFieldSetting();
        }
    }

    public function toArray(): array
    {
        return (array) $this;
    }

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

    public function doRead(): void
    {
        //THEN 1 ELSE 0 END AS has_options FROM il_dcl_field f WHERE id = ".$ilDB->quote($this->getId(),"integer");
        $query = "SELECT * FROM il_dcl_field WHERE id = " . $this->db->quote($this->getId(), "integer");
        $set = $this->db->query($query);
        $rec = $this->db->fetchAssoc($set);

        if ($rec) {
            $this->setTableId($rec["table_id"]);
            if (null !== $rec["title"]) {
                $this->setTitle($rec["title"]);
            }
            if (null !== $rec["description"]) {
                $this->setDescription($rec["description"]);
            }
            $this->setDatatypeId($rec["datatype_id"]);
            $this->setUnique((bool) $rec["is_unique"]);
        }

        $this->loadProperties();
        $this->loadTableFieldSetting();
    }

    public function buildFromDBRecord(array $rec): void
    {
        $this->setId($rec["id"]);
        $this->setTableId($rec["table_id"]);
        $this->setTitle($rec["title"]);
        $this->setDescription($rec["description"]);
        $this->setDatatypeId($rec["datatype_id"]);
        $this->setUnique($rec["is_unique"] ?? null);
    }

    public function doCreate(): void
    {
        if (!ilDclTable::_tableExists($this->getTableId())) {
            throw new ilException("The field does not have a related table!");
        }

        $id = $this->db->nextId("il_dcl_field");
        $this->setId($id);
        $query = "INSERT INTO il_dcl_field (" . "id" . ", table_id" . ", datatype_id" . ", title" . ", description" . ", is_unique"
            . " ) VALUES (" . $this->db->quote($this->getId(), "integer") . "," . $this->db->quote(
                $this->getTableId(),
                "integer"
            ) . ","
            . $this->db->quote($this->getDatatypeId(), "integer") . "," . $this->db->quote($this->getTitle(), "text") . ","
            . $this->db->quote($this->getDescription(), "text") . "," . $this->db->quote($this->isUnique(), "integer") . ")";
        $this->db->manipulate($query);

        $this->updateTableFieldSetting();

        $this->addToTableViews();
    }

    protected function addToTableViews(): void
    {
        foreach (ilDclTableView::getAllForTableId($this->table_id) as $tableview) {
            $tableview->createFieldSetting($this->id);
        }
    }

    public function doUpdate(): void
    {
        $this->db->update(
            "il_dcl_field",
            [
                "table_id" => [
                    "integer",
                    $this->getTableId(),
                ],
                "datatype_id" => [
                    "text",
                    $this->getDatatypeId(),
                ],
                "title" => [
                    "text",
                    $this->getTitle(),
                ],
                "description" => [
                    "text",
                    $this->getDescription(),
                ],
                "is_unique" => [
                    "integer",
                    $this->isUnique(),
                ],
            ],
            [
                "id" => [
                    "integer",
                    $this->getId(),
                ],
            ]
        );
        $this->updateTableFieldSetting();
        $this->updateProperties();
    }

    public function updateProperties(): void
    {
        foreach ($this->property as $prop) {
            $prop->store();
        }
    }

    protected function updateTableFieldSetting(): void
    {
        $tablefield_setting = ilDclTableFieldSetting::getInstance($this->getTableId(), $this->getId());
        $tablefield_setting->setExportable($this->exportable);
        $tablefield_setting->setFieldOrder($this->getOrder());
        $tablefield_setting->store();
    }

    public function doDelete(): void
    {
        // delete tablefield setting.
        ilDclTableFieldSetting::getInstance($this->getTableId(), $this->getId())->delete();

        $query = "DELETE FROM il_dcl_field_prop WHERE field_id = " . $this->db->quote($this->getId(), "text");
        $this->db->manipulate($query);

        $query = "DELETE FROM il_dcl_field WHERE id = " . $this->db->quote($this->getId(), "text");
        $this->db->manipulate($query);

        foreach ($this->getViewSettings() as $field_setting) {
            $field_setting->delete();
        }
    }

    public function getViewSettings(): array
    {
        return ilDclTableViewFieldSetting::where(['field' => $this->getId()])->get();
    }

    public function getViewSetting(int $tableview_id): ilDclTableViewFieldSetting
    {
        return ilDclTableViewFieldSetting::getTableViewFieldSetting($this->getId(), $tableview_id);
    }

    public function getOrder(): int
    {
        if ($this->order == null) {
            $this->loadTableFieldSetting();
        }

        return !$this->order ? 0 : $this->order;
    }

    public function setOrder(int $order): void
    {
        $this->order = $order;
    }

    protected function loadProperties(): void
    {
        $this->property = ilDclCache::getFieldProperties($this->getId());
    }

    public function hasProperty(string $key): bool
    {
        $this->loadProperties();

        return (isset($this->property[$key]) && $this->property[$key]->getValue() != null);
    }

    public function getProperty(string $key): mixed
    {
        $instance = $this->getPropertyInstance($key);

        return ($instance !== null) ? $instance->getValue() : null;
    }

    public function getPropertyInstance(string $key): ?ilDclFieldProperty
    {
        $this->loadProperties();
        if ($this->hasProperty($key)) {
            return $this->property[$key];
        }

        return null;
    }

    public function setProperty(string $key, $value): ?ilDclFieldProperty
    {
        $this->loadProperties();
        if (isset($this->property[$key])) {
            $this->property[$key]->setValue($value);
        } else {
            $property = new ilDclFieldProperty();
            $property->setName($key);
            $property->setFieldId((int) $this->getId());
            $property->setValue($value);

            $this->property[$key] = $property;
        }

        return $this->property[$key];
    }

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

    public function checkValidityFromForm(ilPropertyFormGUI &$form, ?int $record_id = null): void
    {
        $value = $form->getInput('field_' . $this->getId());
        $this->checkValidity($value, $record_id);
    }

    public function checkValidity($value, ?int $record_id = null): bool
    {
        //Don't check empty values
        if (!isset($value)) {
            return true;
        }

        if ($this->isUnique()) {
            $table = ilDclCache::getTableCache($this->getTableId());
            foreach ($table->getRecords() as $record) {
                if ($record->getId() !== $record_id || $record_id === 0) {
                    if ($this->areEqual($record->getRecordFieldValue($this->getId()), $value)) {
                        throw new ilDclInputException(ilDclInputException::UNIQUE_EXCEPTION);
                    }
                }
            }
        }

        return true;
    }

    protected function areEqual($value_1, $value_2): bool
    {
        return $this->normalizeValue($value_1) === $this->normalizeValue($value_2);
    }

    protected function normalizeValue(mixed $value)
    {
        if (is_string($value)) {
            $value = trim(preg_replace("/\\s+/uism", " ", $value));
        }

        return $value;
    }

    public function cloneStructure(int $original_id): void
    {
        $original = ilDclCache::getFieldCache($original_id);
        $this->setTitle($original->getTitle());
        $this->setDatatypeId($original->getDatatypeId());
        $this->setDescription($original->getDescription());
        $this->setOrder($original->getOrder());
        $this->setUnique($original->isUnique());
        $this->setExportable($original->getExportable());
        $this->doCreate();
        $this->cloneProperties($original);

        // mandatory for all cloning functions
        ilDclCache::setCloneOf($original_id, (int) $this->getId(), ilDclCache::TYPE_FIELD);
    }

    public function afterClone(array $records)
    {
        foreach ($records as $rec) {
            ilDclCache::getRecordFieldCache($rec, $this)->afterClone();
        }
    }

    public function cloneProperties(ilDclBaseFieldModel $originalField): void
    {
        $orgProps = $originalField->getValidFieldProperties();
        if (count($orgProps) == 0) {
            return;
        }
        foreach ($orgProps as $prop_name) {
            $fieldprop_obj = new ilDclFieldProperty();
            $fieldprop_obj->setFieldId((int) $this->getId());
            $fieldprop_obj->setName($prop_name);

            $value = $originalField->getProperty($prop_name);

            if (
                $prop_name == ilDclBaseFieldModel::PROP_REFERENCE &&
                (
                    $originalField->getDatatypeId() == ilDclDatatype::INPUTFORMAT_REFERENCE ||
                    $originalField->getDatatypeId() == ilDclDatatype::INPUTFORMAT_COPY
                )
            ) {
                $value = null;
            }

            if ($value) {
                $fieldprop_obj->setValue($value);
                $fieldprop_obj->create();
            }
        }
    }

    public function setExportable(bool $exportable): void
    {
        $this->exportable = $exportable;
    }

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

    public function getRecordQuerySortObject(
        string $direction = "asc",
        bool $sort_by_status = false
    ): ?ilDclRecordQueryObject {
        $sql_obj = new ilDclRecordQueryObject();

        $select_str = "sort_stloc_{$this->getId()}.value AS field_{$this->getId()}";
        $join_str
            = "LEFT JOIN il_dcl_record_field AS sort_record_field_{$this->getId()} ON (sort_record_field_{$this->getId()}.record_id = record.id AND sort_record_field_{$this->getId()}.field_id = "
            . $this->db->quote($this->getId(), 'integer') . ") ";
        $join_str .= "LEFT JOIN il_dcl_stloc{$this->getStorageLocation()}_value AS sort_stloc_{$this->getId()} ON (sort_stloc_{$this->getId()}.record_field_id = sort_record_field_{$this->getId()}.id)";

        $sql_obj->setSelectStatement($select_str);
        $sql_obj->setJoinStatement($join_str);
        $sql_obj->setOrderStatement("field_{$this->getId()} $direction, ID ASC");

        return $sql_obj;
    }

    public function getRecordQueryFilterObject(
        $filter_value = "",
        ?ilDclBaseFieldModel $sort_field = null
    ): ?ilDclRecordQueryObject {
        return null;
    }

    public function getSortField(): string
    {
        return $this->getTitle();
    }

    public function hasNumericSorting(): bool
    {
        if ($this->getDatatypeId() == ilDclDatatype::INPUTFORMAT_NUMBER) {
            return true;
        }

        return false;
    }

    public function checkFieldCreationInput(ilPropertyFormGUI $form): bool
    {
        return true;
    }

    public function getStorageLocationOverride(): ?int
    {
        return $this->storage_location_override;
    }

    public function setStorageLocationOverride(?int $storage_location_override): void
    {
        $this->storage_location_override = $storage_location_override;
    }

    public function fillHeaderExcel(ilExcel $worksheet, int &$row, int &$col): void
    {
        $worksheet->setCell($row, $col, $this->getTitle());
        $col++;
    }

    public function checkTitlesForImport(array &$titles, array &$import_fields): void
    {
        foreach ($titles as $k => $title) {
            if (!mb_detect_encoding($title, "UTF-8", true) == "UTF-8") {
                $title = mb_convert_encoding($title, 'UTF-8', 'ISO-8859-1');
            }
            if ($title == $this->getTitle()) {
                $import_fields[$k] = $this;
            }
        }
    }

    public function storePropertiesFromForm(ilPropertyFormGUI $form): void
    {
        $field_props = $this->getValidFieldProperties();
        $representation = ilDclFieldFactory::getFieldRepresentationInstance($this);

        foreach ($field_props as $property) {
            $value = $form->getInput($representation->getPropertyInputFieldId($property));

            // save non empty values and set them to null, when they already exist. Do not override plugin-hook when already set.
            if (!empty($value) || ($this->getPropertyInstance($property) != null && $property != self::PROP_PLUGIN_HOOK_NAME)) {
                $this->setProperty($property, $value)?->store();
            }
        }
    }

    public function fillPropertiesForm(ilPropertyFormGUI &$form): bool
    {
        $values = [
            'table_id' => $this->getTableId(),
            'field_id' => $this->getId(),
            'title' => $this->getTitle(),
            'datatype' => $this->getDatatypeId(),
            'description' => $this->getDescription(),
            'unique' => $this->isUnique(),
        ];

        $properties = $this->getValidFieldProperties();
        foreach ($properties as $prop) {
            $values['prop_' . $prop] = $this->getProperty($prop);
        }

        $form->setValuesByArray($values);

        return true;
    }

    public function isConfirmationRequired(ilPropertyFormGUI $form): bool
    {
        return false;
    }

    public function getConfirmationGUI(ilPropertyFormGUI $form): ilConfirmationGUI
    {
        $ilConfirmationGUI = new ilConfirmationGUI();
        $ilConfirmationGUI->setFormAction($form->getFormAction());
        $ilConfirmationGUI->addHiddenItem('confirmed', "1");
        $ilConfirmationGUI->addHiddenItem('field_id', $form->getInput('field_id'));
        $ilConfirmationGUI->addHiddenItem('title', $form->getInput('title'));
        $ilConfirmationGUI->addHiddenItem('description', $form->getInput('description'));
        $ilConfirmationGUI->addHiddenItem('datatype', $form->getInput('datatype'));
        $ilConfirmationGUI->addHiddenItem('unique', $form->getInput('unique'));
        $ilConfirmationGUI->setConfirm($this->lng->txt('dcl_update_field'), 'update');
        $ilConfirmationGUI->setCancel($this->lng->txt('cancel'), 'edit');

        return $ilConfirmationGUI;
    }
}