class.ilDataCollectionRecordField.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.ilDataCollectionInputException.php';

class ilDataCollectionRecordField {

        protected $id;
        protected $field;
        protected $record;
        protected $value;
        protected $user;
        protected $ctrl;
        protected $db;

        protected $lng;

        public function __construct(ilDataCollectionRecord $record, ilDataCollectionField $field) {
                global $ilCtrl, $ilUser, $ilDB, $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->record->getId())
                        return;

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

                if ($this->id == null) {
                        $this->doCreate();
                }

                $this->loadValue();
        }


        protected 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->record->getId(), "integer") . ", " . $this->db->quote($this->field->getId(), "text") . ")";
                $this->db->manipulate($query);
                $this->id = $id;
        }


        public function doUpdate() {
                //$this->loadValue(); //Removed Mantis #0011799
                if (!$this->id) {
                        $this->doCreate();
                }
                $datatype = $this->field->getDatatype();
                $query = "DELETE FROM il_dcl_stloc" . $datatype->getStorageLocation() . "_value WHERE record_field_id = "
                        . $this->db->quote($this->id, "integer");
                $this->db->manipulate($query);
                $next_id = $this->db->nextId("il_dcl_stloc" . $datatype->getStorageLocation() . "_value");

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

                $this->db->insert("il_dcl_stloc" . $datatype->getStorageLocation() . "_value", array(
                        "value" => array( $datatype->getDbType(), $this->value ),
                        "record_field_id " => array( "integer", $this->id ),
                        "id" => array( "integer", $next_id )
                ));
        }


        public function delete() {
                $datatype = $this->field->getDatatype();
                $query = "DELETE FROM il_dcl_stloc" . $datatype->getStorageLocation() . "_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 setValue($value, $omit_parsing = false) {
                $this->loadValue();
                if (! $omit_parsing) {
                        $tmp = $this->field->getDatatype()->parseValue($value, $this);
                        $old = $this->value;
                        //if parse value fails keep the old value
                        if ($tmp !== false) {
                                $this->value = $tmp;
                                //delete old file from filesystem
                                // TODO Does not belong here, create separate class ilDataCollectionFileField and overwrite setValue method
                                if ($old && $this->field->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_FILE) {
//                                      $this->record->deleteFile($old); // Removed due to #0018064
                                }
                        }
                } else {
                        $this->value = $value;
                }
        }

        public function setValueFromForm(&$form) {
                if (in_array($this->field->getDatatypeId(), array(ilDataCollectionDatatype::INPUTFORMAT_MOB, ilDataCollectionDatatype::INPUTFORMAT_FILE))
                        && $form->getItemByPostVar("field_" . $this->field->getId())->getDeletionFlag()
                ) {
                        $value = - 1;
                } else {
                        $value = $form->getInput("field_" . $this->field->getId());
                }
                $this->setValue($value);
        }

        public function getValueFromExcel($excel, $row, $col) {
                $value = $excel->val($row, $col);
                if ($this->field->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_DATETIME) {
                        $value = array(
                                'date' => date('Y-m-d', strtotime($value)),
                                'time' => '00:00:00',
                        );
                }
                return $value;
        }

        public function fillFormInput(&$form) {
                $value = $this->getFormInput();
                $form->getItemByPostVar('field_'.$this->field->getId())->setValueByArray(array("field_".$this->field->getId() => $value));
        }


        protected function getFormInput() {
                $datatype = $this->field->getDatatype();

                return $datatype->parseFormInput($this->getValue(), $this);
        }


        public function getExportValue() {
                $datatype = $this->field->getDatatype();

                return $datatype->parseExportValue($this->getValue());
        }

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


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


        public function getHTML($link = true) {
                $datatype = $this->field->getDatatype();

                return $datatype->parseHTML($this->getValue(), $this, $link);
        }

        public function getSortingValue($link = true) {
                $datatype = $this->field->getDatatype();

                return $datatype->parseSortingValue($this->getValue(), $this, $link);
        }

        public function getSingleHTML() {
                return $this->getHTML(false);
        }


        protected function loadValue() {
                if ($this->value === NULL) {
                        $datatype = $this->field->getDatatype();
                        switch ($datatype->getId()) {
                                case ilDataCollectionDatatype::INPUTFORMAT_RATING:
                                        return true;
                        }
                        $query = "SELECT * FROM il_dcl_stloc" . $datatype->getStorageLocation() . "_value WHERE record_field_id = "
                                . $this->db->quote($this->id, "integer");

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


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


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


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

?>