class.ilDclBaseRecordFieldModel.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once './Modules/DataCollection/exceptions/class.ilDclInputException.php';

class ilDclBaseRecordFieldModel
{

    protected $id;
    protected $field;
    protected $record;
    protected $record_representation;
    protected $field_representation;
    protected $value;
    protected $user;
    protected $ctrl;
    protected $db;
    protected $lng;


    public function __construct(ilDclBaseRecordModel $record, ilDclBaseFieldModel $field)
    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $ilUser = $DIC['ilUser'];
        $ilDB = $DIC['ilDB'];
        $lng = $DIC['lng'];
        $this->record = $record;
        $this->field = $field;
        $this->ctrl = $ilCtrl;
        $this->user = $ilUser;
        $this->db = $ilDB;
        $this->lng = $lng;
        $this->doRead();
    }


    protected function doRead()
    {
        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'];

        $this->loadValue();
    }


    public function doCreate()
    {
        $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()
    {
        //$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, "integer");
            $this->db->manipulate($query);

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

            // This is a workaround to ensure that date values in stloc3 are never stored as NULL, which is not allowed
            if ($storage_location == 3 && (is_null($this->value) || empty($this->value))) {
                $this->value = '0000-00-00 00:00:00';
            }

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

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

            $insert_params = array(
                "value" => array($datatype->getDbType(), $value),
                "record_field_id" => array("integer", $this->getId()),
                "id" => array("integer", $next_id),
            );

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


    public function delete()
    {
        $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 getValueForRepresentation()
    {
        return $this->getValue();
    }


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

        return $value;
    }


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

        return $value;
    }


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


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

        $this->setValue($value);
    }


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


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


    public function getValueFromExcel($excel, $row, $col)
    {
        $value = $excel->getCell($row, $col);

        return $value;
    }


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


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


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


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


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


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


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


    protected function loadValue()
    {
        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']);
                $this->value = $value;
            }
        }
    }


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


    public function afterClone()
    {
    }


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


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


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


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


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


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


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