Services/AdvancedMetaData/classes/class.ilAdvancedMDFieldDefinition.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/

class ilAdvancedMDFieldDefinition
{
        const TYPE_SELECT = 1;
        const TYPE_TEXT = 2;
        const TYPE_DATE = 3;

        private static $instances = array();
        
        protected $db = null;
        
        protected $record_id;
        protected $field_id;
        protected $import_id;
        protected $position;
        protected $field_type;
        protected $field_values = array();
        protected $title;
        protected $description;
        protected $searchable;
        protected $required = false;
        
        
        public function __construct($a_field_id = 0)
        {
                global $ilDB;
                
                $this->db = $ilDB;
                
                $this->field_id = $a_field_id;
                $this->read();
        }
        
        public static function _lookupImportId($a_field_id)
        {
                global $ilDB;
                
                $query = "SELECT import_id FROM adv_md_field_definition ".
                        "WHERE field_id = ".$ilDB->quote($a_field_id)." ";
                $res = $ilDB->query($query);
                $row = $res->fetchRow(DB_FETCHMODE_ASSOC);
                return $row['import_id'] ? $row['import_id'] : '';
        }
        
        public static function _lookupFieldId($a_import_id)
        {
                global $ilDB;
                
                $query = "SELECT field_id FROM adv_md_field_definition ".
                        "WHERE import_id = ".$ilDB->quote($a_import_id)." ";
                $res = $ilDB->query($query);
                $row = $res->fetchRow(DB_FETCHMODE_ASSOC);
                return $row['field_id'] ? $row['field_id'] : 0;
        }
        
        public static function _lookupDateFields()
        {
                global $ilDB;
                
                $query = "SELECT field_id FROM adv_md_field_definition ".
                        "WHERE field_type = ".self::TYPE_DATE." ";
                $res = $ilDB->query($query);
                
                $date_fields = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $date_fields[] = $row->field_id; 
                }
                return $date_fields;
        }
        
        public static function _getInstanceByFieldId($a_field_id)
        {
                if(isset(self::$instances[$a_field_id]))
                {
                        return self::$instances[$a_field_id];
                }
                return self::$instances[$a_field_id] = new ilAdvancedMDFieldDefinition($a_field_id);
        }
        

        public static function _getDefinitionsByRecordId($a_record_id)
        {
                global $ilDB;
                
                $query = "SELECT field_id FROM adv_md_field_definition ".
                        "WHERE record_id = ".$ilDB->quote($a_record_id)." ".
                        "ORDER BY position ";
                $res = $ilDB->query($query);
                $defs = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $defs[] = self::_getInstanceByFieldId($row->field_id);
                }
                return $defs ? $defs : array(); 
        }
        
        public static function _getActiveDefinitionsByObjType($a_type)
        {
                global $ilDB;
                
                $query = "SELECT field_id FROM adv_md_record_objs AS aro ".
                        "JOIN adv_md_record AS amr ON aro.record_id = amr.record_id ".
                        "JOIN adv_md_field_definition AS amf ON aro.record_id = amf.record_id ".
                        "WHERE active = 1 ".
                        "AND obj_type = ".$ilDB->quote($a_type)." ".
                        "ORDER BY aro.record_id,position ";
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $field_ids[] = $row->field_id;
                }
                return $field_ids ? $field_ids : array();
        }
        
        public static function _getSearchableDefinitionIds()
        {
                global $ilDB;
                
                $query = "SELECT field_id FROM adv_md_record AS amr ".
                        "JOIN adv_md_field_definition AS amfd USING (record_id) ".
                        "WHERE active = 1 ".
                        "AND searchable = 1";
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $field_ids[] = $row->field_id;
                }
                return $field_ids ? $field_ids : array();
        }
        
        
        public static function _deleteByRecordId($a_record_id)
        {
                global $ilDB;
                
                $query = "SELECT field_id FROM adv_md_field_definition ".
                        "WHERE record_id = ".$ilDB->quote($a_record_id);
                $res = $ilDB->query($query);    
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        // Delete values
                        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
                        ilAdvancedMDValues::_deleteByFieldId($row->field_id);
                }               

                // Delete definitions
                $query = "DELETE FROM adv_md_field_definition ".
                        "WHERE record_id  = ".$ilDB->quote($a_record_id)." ";
                $res = $ilDB->query($query);    
        }

        // Setter, Getter...
        public function setRecordId($a_id)
        {
                $this->record_id = $a_id;
        }
        
        public function getRecordId()
        {
                return $this->record_id;
        }
        
        public function getFieldId()
        {
                return $this->field_id;
        }
        
        public function setImportId($a_id_string)
        {
                $this->import_id = $a_id_string;
        }
        
        public function getImportId()
        {
                return $this->import_id;
        }
        
        public function setPosition($a_pos)
        {
                $this->position = $a_pos;
        }
        
        public function getPosition()
        {
                return $this->position;
        }
        
        public function setFieldType($a_type_id)
        {
                $this->field_type = $a_type_id;
        }
        
        public function getFieldType()
        {
                return $this->field_type;
        }
        
        public function setFieldValues($a_values)
        {
                $this->field_values = $a_values;
        }
        
        public function appendFieldValue($a_value)
        {
                if(strlen(trim($a_value)))
                {
                        $this->field_values[] = trim($a_value);
                }
        }
        
        public function getFieldValues()
        {
                return $this->field_values;
        }
        
        public function getFieldValuesForSelect()
        {
                global $lng;
                
                $values = array(0 => $lng->txt('select_one'));
                foreach($this->field_values as $value)
                {
                        $values[$value] = $value;
                }
                return $values;
        }
        
        public function setTitle($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 enableSearchable($a_status)
        {
                $this->searchable = (bool) $a_status;
        }
        
        public function isSearchable()
        {
                return (bool) $this->searchable;
        }
        
        public function isRequired()
        {
                return $this->required;
        }
        
        public function delete()
        {
                $query = "DELETE FROM adv_md_field_definition ".
                        "WHERE field_id = ".$this->db->quote($this->getFieldId())." ";
                $res = $this->db->query($query);
                
                // Also delete all values
                include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
                ilAdvancedMDValues::_deleteByFieldId($this->getFieldId());
                return true;    
        }
        
        public function add()
        {
                sort($values = $this->getFieldValues(),SORT_STRING);
                
                $position = $this->getLastPosition();
                
                $query = "INSERT INTO adv_md_field_definition ".
                        "SET record_id = ".$this->db->quote($this->getRecordId()).", ".
                        "import_id = ".$this->db->quote($this->getImportId()).", ".
                        "position = ".$this->db->quote($position + 1).", ".
                        "field_type = ".$this->db->quote($this->getFieldType()).", ".
                        "field_values = '".addslashes(serialize($values))."', ".
                        "title = ".$this->db->quote($this->getTitle()).", ".
                        "description = ".$this->db->quote($this->getDescription()).", ".
                        "searchable = ".(int) $this->isSearchable().", ".
                        "required = ".(int) $this->isRequired();
                $this->db->query($query);
                $this->field_id = $this->db->getLastInsertId();
                
                if(!strlen($this->getImportId()))
                {
                        $query = "UPDATE adv_md_field_definition ".
                                "SET import_id = ".$this->db->quote($this->generateImportId())." ".
                                "WHERE field_id = ".$this->db->quote($this->field_id)." ";
                        $this->db->query($query);
                }
                return true;
        }
        
        public function validate()
        {
                global $ilErr,$lng;
                
                if(!strlen($this->getTitle()) or !$this->getFieldType())
                {
                        $ilErr->setMessage('fill_out_all_required_fields');
                        return false;
                }
                return true;
        }
        
        public function update()
        {
                $query = "UPDATE adv_md_field_definition ".
                        "SET record_id = ".$this->db->quote($this->getRecordId()).", ".
                        "import_id = ".$this->db->quote($this->getImportId()).", ".
                        "position = ".$this->db->quote($this->getPosition()).", ".
                        "field_type = ".$this->db->quote($this->getFieldType()).", ".
                        "field_values = '".addslashes(serialize($this->getFieldValues()))."', ".
                        "title = ".$this->db->quote($this->getTitle()).", ".
                        "description = ".$this->db->quote($this->getDescription()).", ".
                        "searchable = ".(int) $this->isSearchable().", ".
                        "required = ".(int) $this->isRequired()." ".
                        "WHERE field_id = ".$this->db->quote($this->getFieldId())." ";
                                                
                $this->db->query($query);
                return true;
        }
        
         public function toXML(ilXmlWriter $writer)
         {
                switch($this->getFieldType())
                {
                        case self::TYPE_TEXT:
                                $type = 'Text';
                                break;
                                
                        case self::TYPE_SELECT:
                                $type = 'Select';
                                break;
                                
                        case self::TYPE_DATE:
                                $type = 'Date';
                                break;
                }
                
                
                $writer->xmlStartTag('Field',array(
                        'id' => $this->generateImportId(),
                        'searchable' => ($this->isSearchable() ? 'Yes' : 'No'),
                        'fieldType'      => $type));
                
                $writer->xmlElement('FieldTitle',null,$this->getTitle());
                $writer->xmlElement('FieldDescription',null,$this->getDescription());
                $writer->xmlElement('FieldPosition',null,$this->getPosition());
                
                foreach($this->getFieldValues() as $value)
                {
                        if(strlen($value))
                        {
                                $writer->xmlElement('FieldValue',null,$value);
                        }
                }
                
                $writer->xmlEndTag('Field');
         }
        
        
        private function read()
        {
                if(!$this->field_id)
                {
                        return false;
                }
                $query = "SELECT * FROM adv_md_field_definition ".
                        "WHERE field_id = ".$this->db->quote($this->getFieldId())." ";
                $res = $this->db->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $this->record_id = $row->record_id;
                        $this->import_id = $row->import_id;
                        $this->position = $row->position;
                        $this->field_type = $row->field_type;
                        $this->field_values = unserialize(stripslashes($row->field_values));
                        $this->title = $row->title;
                        $this->description = $row->description;
                        $this->searchable = $row->searchable;
                        $this->required = $row->required;
                }
        }
        
        private function getLastPosition()
        {
                $query = "SELECT max(position) as pos FROM adv_md_field_definition ".
                        "WHERE record_id = ".$this->db->quote($this->getRecordId())." ";
                $res = $this->db->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        return $row->pos;
                }
                return 0;
        }
        
        protected function generateImportId()
        {
                return 'il_'.IL_INST_ID.'_adv_md_field_'.$this->getFieldId();
        }
        
}
?>