class.ilDataCollectionField.php

Go to the documentation of this file.

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

require_once('./Services/Exceptions/classes/class.ilException.php');
require_once('Services/Utilities/classes/class.ilStr.php');
require_once('class.ilDataCollectionCache.php');
require_once('class.ilDataCollectionFieldProp.php');

class ilDataCollectionField {

        protected $id;
        protected $table_id;
        protected $title;
        protected $description;
        protected $datatypeId;
        protected $required;
        protected $order;
        protected $unique;
        protected $visible;
        protected $editable;
        protected $filterable;
        protected $locked;
        protected $property = array();
        protected $exportable;
        protected $datatype;
        const PROPERTYID_LENGTH = 1;
        const PROPERTYID_REGEX = 2;
        const PROPERTYID_REFERENCE = 3;
        const PROPERTYID_URL = 4;
        const PROPERTYID_TEXTAREA = 5;
        const PROPERTYID_REFERENCE_LINK = 6;
        const PROPERTYID_WIDTH = 7;
        const PROPERTYID_HEIGHT = 8;
        const PROPERTYID_LEARNING_PROGRESS = 9;
        const PROPERTYID_ILIAS_REFERENCE_LINK = 10;
        const PROPERTYID_N_REFERENCE = 11;
        const PROPERTYID_FORMULA_EXPRESSION = 12;
        const PROPERTYID_DISPLAY_COPY_LINK_ACTION_MENU = 13;
        const PROPERTYID_LINK_DETAIL_PAGE_TEXT = 14;
        const PROPERTYID_LINK_DETAIL_PAGE_MOB = 15;
        const PROPERTYID_SUPPORTED_FILE_TYPES = 16;
        // type of table il_dcl_view
        const VIEW_VIEW = 1;
        const EDIT_VIEW = 2;
        const FILTER_VIEW = 3;
        const EXPORTABLE_VIEW = 4;


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


        public static function _getTitleValidChars($a_as_regex = true) {
                if ($a_as_regex) {
                        return '/^[a-zA-Z\d \/\-.,äöüÄÖÜàéèÀÉÈç¢]*$/i';
                } else {
                        return 'A-Z a-z 0-9 /-.,';
                }
        }


        public static function _getFieldIdByTitle($title, $table_id) {
                global $ilDB;
                $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) {
                $this->id = $a_id;
        }


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


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


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


        public function setTitle($a_title) {
                //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() {
                return $this->title;
        }


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


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


        public function setDatatypeId($a_id) {
                //unset the cached datatype.
                $this->datatype = NULL;
                $this->datatypeId = $a_id;
        }


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

                return $this->datatypeId;
        }


        public function setRequired($a_required) {
                $this->required = $a_required;
        }


        public function getRequired() {
                return $this->required;
        }


        public function setPropertyvalue($a_value, $a_id) {
                $this->property[$a_id] = $a_value;
        }


        /*
         * isUnique
         */
        public function isUnique() {
                return $this->unique;
        }


        /*
         * setUnique
         */
        public function setUnique($unique) {
                $this->unique = $unique ? 1 : 0;
        }


        public function getPropertyvalues() {
                if ($this->property == NULL) {
                        $this->loadProperties();
                }

                return $this->property;
        }


        public function setVisible($visible) {
                if ($visible == true && $this->order === NULL) {
                        $this->setOrder(0);
                }

                $this->visible = $visible;
        }


        public function setFilterable($filterable) {
                if ($filterable == true && $this->order === NULL) {
                        $this->setOrder(0);
                }

                $this->filterable = $filterable;
        }


        /*
         * getDatatype
         */
        public function getDatatype() {
                $this->loadDatatype();

                return $this->datatype;
        }


        /*
         * getLength
         */
        public function getLength() {
                $props = $this->getPropertyvalues();
                $l = self::PROPERTYID_LENGTH;

                return $props[$l];
        }


        public function getTextArea() {
                $props = $this->getProperties();
                $t = self::PROPERTYID_TEXTAREA;

                return $props[$t];
        }


        public function getLearningProgress() {
                $props = $this->getPropertyvalues();
                $p = self::PROPERTYID_LEARNING_PROGRESS;

                return $props[$p];
        }


        /*
         * getDatatypeTitle
         */
        public function getDatatypeTitle() {
                $this->loadDatatype();

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


        /*
         * getStorageLocation
         */
        public function getStorageLocation() {
                $this->loadDatatype();

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


        protected function loadDatatype() {
                if ($this->datatype == NULL) {
                        $this->datatype = new ilDataCollectionDatatype($this->datatypeId);
                }
        }


        public function isVisible() {
                if (!isset($this->visible)) {
                        $this->loadVisibility();
                }

                return $this->visible;
        }


        protected function loadVisibility() {
                if ($this->visible == NULL) {
                        $this->loadViewDefinition(self::VIEW_VIEW);
                }
        }


        public function isFilterable() {
                if (!isset($this->filterable)) {
                        $this->loadFilterability();
                }

                return $this->filterable;
        }


        protected function loadFilterability() {
                if ($this->filterable == NULL) {
                        $this->loadViewDefinition(self::FILTER_VIEW);
                }
        }


        protected function loadViewDefinition($view) {
                global $ilDB;
                $query = "  SELECT view.table_id, def.field_order, def.is_set FROM il_dcl_viewdefinition def
                                                INNER JOIN il_dcl_view view ON view.id = def.view_id AND view.type = " . $ilDB->quote($view, "integer") . "
                                                WHERE def.field LIKE '" . $this->id . "' AND view.table_id = " . $ilDB->quote($this->table_id, "integer");
                $set = $ilDB->query($query);
                $rec = $ilDB->fetchAssoc($set);
                $prop = $rec['is_set'];

                switch ($view) {
                        case self::VIEW_VIEW:
                                $this->visible = $prop;
                                break;
                        case self::EDIT_VIEW:
                                $this->editable = $prop;
                                break;
                        case self::FILTER_VIEW:
                                $this->filterable = $prop;
                                break;
                        case self::EXPORTABLE_VIEW:
                                $this->exportable = $prop;
                                break;
                }

                if (!$this->order) {
                        $this->order = $rec['field_order'];
                }
        }


        public function isEditable() {
                if (!isset($this->editable)) {
                        $this->loadEditability();
                }

                return $this->editable;
        }


        /*
         * editable
         */
        public function setEditable($editable) {
                $this->editable = $editable;
        }


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

                return $this->exportable;
        }


        /*
         * loadEditability
         */
        private function loadEditability() {
                if ($this->editable == NULL) {
                        $this->loadViewDefinition(self::EDIT_VIEW);
                }
        }


        private function loadExportability() {
                if ($this->exportable == NULL) {
                        $this->loadViewDefinition(self::EXPORTABLE_VIEW);
                }
        }


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


        /*
         * isStandardField
         */
        public function isStandardField() {
                return false;
        }


        public function doRead() {
                global $ilDB;

                //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 = " . $ilDB->quote($this->getId(), "integer");
                $set = $ilDB->query($query);
                $rec = $ilDB->fetchAssoc($set);

                $this->setTableId($rec["table_id"]);
                $this->setTitle($rec["title"]);
                $this->setDescription($rec["description"]);
                $this->setDatatypeId($rec["datatype_id"]);
                $this->setRequired($rec["required"]);
                $this->setUnique($rec["is_unique"]);
                $this->setLocked($rec["is_locked"]);
                $this->loadProperties();
        }


        /*
         * buildFromDBRecord
         */
        public function buildFromDBRecord($rec) {
                $this->setId($rec["id"]);
                $this->setTableId($rec["table_id"]);
                $this->setTitle($rec["title"]);
                $this->setDescription($rec["description"]);
                $this->setDatatypeId($rec["datatype_id"]);
                $this->setRequired($rec["required"]);
                $this->setUnique($rec["is_unique"]);
                $this->setLocked($rec["is_locked"]);
        }


        public function doCreate() {
                global $ilDB;
                $this->getLocked() == NULL ? $this->setLocked(false) : true;

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

                $id = $ilDB->nextId("il_dcl_field");
                $this->setId($id);
                $query = "INSERT INTO il_dcl_field (" . "id" . ", table_id" . ", datatype_id" . ", title" . ", description" . ", required" . ", is_unique"
                        . ", is_locked" . " ) VALUES (" . $ilDB->quote($this->getId(), "integer") . "," . $ilDB->quote($this->getTableId(), "integer") . ","
                        . $ilDB->quote($this->getDatatypeId(), "integer") . "," . $ilDB->quote($this->getTitle(), "text") . ","
                        . $ilDB->quote($this->getDescription(), "text") . "," . $ilDB->quote($this->getRequired(), "integer") . ","
                        . $ilDB->quote($this->isUnique(), "integer") . "," . $ilDB->quote($this->getLocked() ? 1 : 0, "integer") . ")";
                $ilDB->manipulate($query);

                $this->updateVisibility();
                $this->updateFilterability();
                $this->updateEditability();
                $this->updateExportability();
        }


        public function doUpdate() {
                global $ilDB;

                $ilDB->update("il_dcl_field", array(
                        "table_id" => array( "integer", $this->getTableId() ),
                        "datatype_id" => array( "text", $this->getDatatypeId() ),
                        "title" => array( "text", $this->getTitle() ),
                        "description" => array( "text", $this->getDescription() ),
                        "required" => array( "integer", $this->getRequired() ),
                        "is_unique" => array( "integer", $this->isUnique() ),
                        "is_locked" => array( "integer", $this->getLocked() ? 1 : 0 ),
                ), array(
                        "id" => array( "integer", $this->getId() )
                ));
                $this->updateVisibility();
                $this->updateFilterability();
                $this->updateEditability();
                $this->updateExportability();
                $this->updateProperties();
        }


        protected function updateProperties() {
                global $ilDB;
                foreach ($this->property as $key => $value) {
                        $ilDB->update('il_dcl_field_prop', array(
                                'value' => array( 'integer', $value ),
                        ), array(
                                'field_id' => array( 'integer', $this->getId() ),
                                'datatype_prop_id' => array( 'integer', $key ),
                        ));
                }
        }


        public function getFilterable() {
                return $this->isFilterable();
        }


        /*
         * updateVisibility
         */
        protected function updateVisibility() {
                $this->updateViewDefinition(self::VIEW_VIEW);
        }


        /*
         * updateFilterability
         */
        protected function updateFilterability() {
                $this->updateViewDefinition(self::FILTER_VIEW);
        }


        protected function updateEditability() {
                $this->updateViewDefinition(self::EDIT_VIEW);
        }


        protected function updateExportability() {
                $this->updateViewDefinition(self::EXPORTABLE_VIEW);
        }


        private function updateViewDefinition($view) {
                global $ilDB;

                switch ($view) {
                        case self::EDIT_VIEW:
                                $set = $this->isEditable();
                                break;
                        case self::VIEW_VIEW:
                                $set = $this->isVisible();
                                if ($set && $this->order === NULL) {
                                        $this->order = 0;
                                }
                                break;
                        case self::FILTER_VIEW:
                                $set = $this->isFilterable();
                                if ($set && $this->order === NULL) {
                                        $this->order = 0;
                                }
                                break;
                        case self::EXPORTABLE_VIEW:
                                $set = $this->getExportable();
                                if ($set && $this->order === NULL) {
                                        $this->order = 0;
                                }
                                break;
                }

                if (!$set) {
                        $set = 0;
                } else {
                        $set = 1;
                }

                if (!isset($this->order)) {
                        $this->order = 0;
                }

                $query = "DELETE def FROM il_dcl_viewdefinition def INNER JOIN il_dcl_view ON il_dcl_view.type = " . $ilDB->quote($view, "integer")
                        . " AND il_dcl_view.table_id = " . $ilDB->quote($this->getTableId(), "integer") . " WHERE def.view_id = il_dcl_view.id AND def.field = "
                        . $ilDB->quote($this->getId(), "text");

                $ilDB->manipulate($query);

                $query = "INSERT INTO il_dcl_viewdefinition (view_id, field, field_order, is_set) SELECT id, " . $ilDB->quote($this->getId(), "text") . ", "
                        . $ilDB->quote($this->getOrder(), "integer") . ", " . $ilDB->quote($set, "integer") . "  FROM il_dcl_view WHERE il_dcl_view.type = "
                        . $ilDB->quote($view, "integer") . " AND il_dcl_view.table_id = " . $ilDB->quote($this->getTableId(), "integer");

                $ilDB->manipulate($query);
        }


        /*
         * deleteViewDefinition
         */
        private function deleteViewDefinition($view) {
                global $ilDB;

                $query = "DELETE def FROM il_dcl_viewdefinition def INNER JOIN il_dcl_view ON il_dcl_view.type = " . $ilDB->quote($view, "integer")
                        . " AND il_dcl_view.table_id = " . $ilDB->quote($this->getTableId(), "integer") . " WHERE def.view_id = il_dcl_view.id AND def.field = "
                        . $ilDB->quote($this->getId(), "text");

                $ilDB->manipulate($query);
        }


        /*
         * doDelete
         */
        public function doDelete() {
                global $ilDB;

                // delete viewdefinitions.
                $this->deleteViewDefinition(self::VIEW_VIEW);
                $this->deleteViewDefinition(self::FILTER_VIEW);
                $this->deleteViewDefinition(self::EDIT_VIEW);
                $this->deleteViewDefinition(self::EXPORTABLE_VIEW);

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

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


        /*
         * getOrder
         */
        public function getOrder() {
                if (!isset($this->order)) {
                        $this->loadVisibility();
                }

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


        /*
         * setOrder
         */
        public function setOrder($order) {
                $this->order = $order;
        }


        /*
         * getFieldRef
         */
        public function getFieldRef() {
                $props = $this->getPropertyvalues();
                $id = self::PROPERTYID_REFERENCE;

                return $props[$id];
        }


        /*
         * getFieldReflist
         */
        public function getFieldReflist() {
                $props = $this->getPropertyvalues();
                $id = self::PROPERTYID_N_REFERENCE;

                return $props[$id];
        }


        public function isNRef() {
                $props = $this->getPropertyvalues();
                $id = self::PROPERTYID_N_REFERENCE;

                return $props[$id];
        }


        private function loadProperties() {
                global $ilDB;

                $query = "SELECT datatype_prop_id, 
                                                                                title, 
                                                                                value 
                                                FROM il_dcl_field_prop fp 
                                                LEFT JOIN il_dcl_datatype_prop AS p ON p.id = fp.datatype_prop_id
                                                WHERE fp.field_id = " . $ilDB->quote($this->getId(), "integer");

                $set = $ilDB->query($query);

                while ($rec = $ilDB->fetchAssoc($set)) {
                        $this->setPropertyvalue($rec['value'], $rec['datatype_prop_id']);
                }
        }


        public function getProperties() {
                if ($this->property == NULL) {
                        $this->loadProperties();
                }

                return $this->property;
        }


        public function setProperties($data) {
                $this->property = $data;
        }


        public function setLocked($locked) {
                $this->locked = $locked;
        }


        public function getLocked() {
                return $this->locked;
        }


        /*
         * checkValidity
         */
        public function checkValidity($value, $record_id = NULL) {
                //Don't check empty values
                if ($value == NULL) {
                        return true;
                }

                if (!ilDataCollectionDatatype::checkValidity($this->getDatatypeId(), $value)) {
                        throw new ilDataCollectionInputException(ilDataCollectionInputException::TYPE_EXCEPTION);
                }

                $properties = $this->getPropertyvalues();
                $length = ilDataCollectionField::PROPERTYID_LENGTH;
                $regex_id = ilDataCollectionField::PROPERTYID_REGEX;
                $url = ilDataCollectionField::PROPERTYID_URL;

                if ($this->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_TEXT) {
                        $regex = $properties[$regex_id];
                        if (substr($regex, 0, 1) != "/") {
                                $regex = "/" . $regex;
                        }
                        if (substr($regex, - 1) != "/") {
                                $regex .= "/";
                        }

                        if ($properties[$length] < ilStr::strLen($value) AND is_numeric($properties[$length])) {
                                throw new ilDataCollectionInputException(ilDataCollectionInputException::LENGTH_EXCEPTION);
                        }
                        if (!($properties[$regex_id] == NULL OR @preg_match($regex, $value))) {
                                throw new ilDataCollectionInputException(ilDataCollectionInputException::REGEX_EXCEPTION);
                        }
                        //email or url
                        if ($properties[$url]
                                && !(preg_match('~(^(www|news|(ht|f)tp(s?)\://){1}\S+)~i', $value)
                                        || preg_match("/^[a-z0-9!#$%&'*+=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/i", $value))
                        ) {
                                throw new ilDataCollectionInputException(ilDataCollectionInputException::NOT_URL);
                        }
                }

                if ($this->isUnique() && $record_id === NULL) {
                        $table = ilDataCollectionCache::getTableCache($this->getTableId());

                        foreach ($table->getRecords() as $record) {
                                if ($record->getRecordFieldValue($this->getId()) == $value && ($record->getId() != $record_id || $record_id == 0)) {
                                        throw new ilDataCollectionInputException(ilDataCollectionInputException::UNIQUE_EXCEPTION);
                                }

                                //for text it has to be case insensitive.
                                if ($this->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_TEXT) {
                                        if (strtolower($record->getRecordFieldValue($this->getId())) == strtolower($value)
                                                && ($record->getId() != $record_id
                                                        || $record_id == 0)
                                        ) {
                                                throw new ilDataCollectionInputException(ilDataCollectionInputException::UNIQUE_EXCEPTION);
                                        }
                                }

                                if ($this->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_DATETIME) {
                                        $datestring = $value["date"] . " " . $value["time"];//["y"]."-".$value["date"]['m']."-".$value["date"]['d']." 00:00:00";

                                        if ($record->getRecordFieldValue($this->getId()) == $datestring && ($record->getId() != $record_id || $record_id == 0)) {
                                                throw new ilDataCollectionInputException(ilDataCollectionInputException::UNIQUE_EXCEPTION);
                                        }
                                }
                        }
                }

                return true;
        }


        public function cloneStructure($original_id) {
                $original = ilDataCollectionCache::getFieldCache($original_id);
                $this->setTitle($original->getTitle());
                $this->setDatatypeId($original->getDatatypeId());
                $this->setDescription($original->getDescription());
                $this->setEditable($original->isEditable());
                $this->setLocked($original->getLocked());
                $this->setFilterable($original->isFilterable());
                $this->setVisible($original->isVisible());
                $this->setOrder($original->getOrder());
                $this->setRequired($original->getRequired());
                $this->setUnique($original->isUnique());
                $this->setExportable($original->getExportable());
                $this->doCreate();
                $this->cloneProperties($original);
        }


        public function cloneProperties(ilDataCollectionField $originalField) {
                $orgProps = $originalField->getProperties();
                if ($orgProps == NULL) {
                        return;
                }
                foreach ($orgProps as $id => $value) {
                        $fieldprop_obj = new ilDataCollectionFieldProp();
                        $fieldprop_obj->setDatatypePropertyId($id);
                        $fieldprop_obj->setFieldId($this->getId());
                        // If reference field, we must reset the referenced field, otherwise it will point to the old ID
                        if ($originalField->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_REFERENCE
                                && $id == ilDataCollectionField::PROPERTYID_REFERENCE
                        ) {
                                $value = NULL;
                        }
                        $fieldprop_obj->setValue($value);
                        $fieldprop_obj->doCreate();
                }
        }


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

?>