class.ilDclBaseRecordFieldModel.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilDclBaseRecordFieldModel
{
    protected ?int $id = null;
    protected ilDclBaseFieldModel $field;
    protected ilDclBaseRecordModel $record;
    protected ?ilDclBaseRecordRepresentation $record_representation = null;
    protected ?ilDclBaseFieldRepresentation $field_representation = null;
    protected $value;
    protected ilObjUser $user;
    protected ilCtrl $ctrl;
    protected ilDBInterface $db;
    protected ilLanguage $lng;
    protected ILIAS\HTTP\Services $http;
    protected ILIAS\Refinery\Factory $refinery;

    public function __construct(ilDclBaseRecordModel $record, ilDclBaseFieldModel $field)
    {
        global $DIC;

        $this->record = $record;
        $this->field = $field;
        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();
        $this->db = $DIC->database();
        $this->lng = $DIC->language();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->doRead();
    }

    protected function doRead(): void
    {
        if (!$this->getRecord()->getId()) {
            return;
        }

        $query = "SELECT * FROM il_dcl_record_field WHERE field_id = " . $this->db->quote(
            $this->getField()->getId(),
            "integer"
        ) . " AND record_id = "
            . $this->db->quote($this->getRecord()->getId(), "integer");
        $set = $this->db->query($query);
        $rec = $this->db->fetchAssoc($set);
        $this->id = $rec['id'] ?? null;

        $this->loadValue();
    }

    public function doCreate(): void
    {
        $id = $this->db->nextId("il_dcl_record_field");
        $query = "INSERT INTO il_dcl_record_field (id, record_id, field_id) VALUES (" . $this->db->quote(
            $id,
            "integer"
        ) . ", "
            . $this->db->quote(
                $this->getRecord()->getId(),
                "integer"
            ) . ", " . $this->db->quote($this->getField()->getId(), "text") . ")";
        $this->db->manipulate($query);
        $this->id = $id;
    }

    public function doUpdate(): void
    {
        //$this->loadValue(); //Removed Mantis #0011799
        $datatype = $this->getField()->getDatatype();
        $storage_location = ($this->getField()->getStorageLocationOverride() !== null) ? $this->getField()->getStorageLocationOverride() : $datatype->getStorageLocation();

        if ($storage_location != 0) {
            $query = "DELETE FROM il_dcl_stloc" . $storage_location . "_value WHERE record_field_id = "
                . $this->db->quote($this->id, ilDBConstants::T_INTEGER);
            $this->db->manipulate($query);

            $next_id = $this->db->nextId("il_dcl_stloc" . $storage_location . "_value");

            $value = $this->serializeData($this->value);

            if ($this->getId() == 0) {
                $this->doCreate();
            }

            $insert_params = [
                'value' => [$this->getDbType($storage_location), $value],
                'record_field_id' => [ilDBConstants::T_INTEGER, $this->getId()],
                'id' => [ilDBConstants::T_INTEGER, $next_id],
            ];

            $this->db->insert("il_dcl_stloc" . $storage_location . "_value", $insert_params);
        }
    }

    private function getDBType(int $storage_location): string
    {
        switch ($storage_location) {
            case 1:
                return ilDBConstants::T_TEXT;
            case 2:
                return ilDBConstants::T_INTEGER;
            case 3:
                return ilDBConstants::T_DATE;
            default:
                throw new InvalidArgumentException('Unsupported storage_location: ' . $storage_location);
        }
    }

    public function delete(): void
    {
        $datatype = $this->getField()->getDatatype();
        $storage_location = ($this->getField()->getStorageLocationOverride() !== null) ? $this->getField()->getStorageLocationOverride() : $datatype->getStorageLocation();

        if ($storage_location != 0) {
            $query = "DELETE FROM il_dcl_stloc" . $storage_location . "_value WHERE record_field_id = "
                . $this->db->quote($this->id, "integer");
            $this->db->manipulate($query);
        }

        $query2 = "DELETE FROM il_dcl_record_field WHERE id = " . $this->db->quote($this->id, "integer");
        $this->db->manipulate($query2);
    }

    public function getValue()
    {
        $this->loadValue();

        return $this->value;
    }

    public function serializeData($value)
    {
        if (is_array($value)) {
            $value = json_encode($value);
        }

        return $value;
    }

    public function deserializeData($value)
    {
        $deserialize = json_decode((string) $value, true);
        if (is_array($deserialize)) {
            return $deserialize;
        }

        return $value;
    }

    public function setValue($value, bool $omit_parsing = false): void
    {
        $this->loadValue();
        if (!$omit_parsing) {
            $tmp = $this->parseValue($value);
            //if parse value fails keep the old value
            if ($tmp !== false) {
                $this->value = $tmp;
            }
        } else {
            $this->value = $value;
        }
    }

    public function setValueFromForm(ilPropertyFormGUI $form): void
    {
        $value = $form->getInput("field_" . $this->getField()->getId());

        $this->setValue($value);
    }

    public function getFormulaValue(): string
    {
        return (string) $this->getExportValue();
    }

    public function parseExportValue($value)
    {
        return $value;
    }

    public function getValueFromExcel(ilExcel $excel, int $row, int $col)
    {
        return (string) $excel->getCell($row, $col);
    }

    public function parseValue($value)
    {
        return $value;
    }

    public function getExportValue()
    {
        return $this->parseExportValue($this->getValue());
    }

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

    public function getPlainText()
    {
        return $this->getExportValue();
    }

    public function getSortingValue(bool $link = true)
    {
        return $this->parseSortingValue($this->getValue(), $link);
    }

    public function addHiddenItemsToConfirmation(ilConfirmationGUI $confirmation)
    {
        if (!is_array($this->getValue())) {
            $confirmation->addHiddenItem('field_' . $this->field->getId(), (string) $this->getValue());
        } else {
            foreach ($this->getValue() as $key => $value) {
                $confirmation->addHiddenItem('field_' . $this->field->getId() . "[$key]", (string) $value);
            }
        }
    }

    public function parseSortingValue($value, bool $link = true)
    {
        return $value;
    }

    protected function loadValue(): void
    {
        if ($this->value === null) {
            $datatype = $this->getField()->getDatatype();

            $storage_location = ($this->getField()->getStorageLocationOverride() !== null) ? $this->getField()->getStorageLocationOverride() : $datatype->getStorageLocation();
            if ($storage_location != 0) {
                $query = "SELECT * FROM il_dcl_stloc" . $storage_location . "_value WHERE record_field_id = "
                    . $this->db->quote($this->id, "integer");

                $set = $this->db->query($query);
                $rec = $this->db->fetchAssoc($set);
                $value = $this->deserializeData($rec['value'] ?? null);
                $this->value = $value;
            }
        }
    }

    public function cloneStructure(ilDclBaseRecordFieldModel $old_record_field): void
    {
        $this->setValue($old_record_field->getValue());
        $this->doUpdate();
    }

    public function afterClone(): void
    {
    }

    public function getField(): ilDclBaseFieldModel
    {
        return $this->field;
    }

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

    public function getRecord(): ilDclBaseRecordModel
    {
        return $this->record;
    }

    public function getRecordRepresentation(): ?ilDclBaseRecordRepresentation
    {
        return $this->record_representation;
    }

    public function setRecordRepresentation(ilDclBaseRecordRepresentation $record_representation): void
    {
        $this->record_representation = $record_representation;
    }

    public function getFieldRepresentation(): ?ilDclBaseFieldRepresentation
    {
        return $this->field_representation;
    }

    public function setFieldRepresentation(ilDclBaseFieldRepresentation $field_representation): void
    {
        $this->field_representation = $field_representation;
    }
}