class.ilAdvancedMDRecord.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 ilAdvancedMDRecord
{
        private static $instances = array();
        
        protected $record_id;
        protected $import_id;
        protected $active;
        protected $title;
        protected $description;
        protected $obj_types = array();
        protected $db = null;
        
        public function __construct($a_record_id = 0)
        {
                global $ilDB;
                
                $this->record_id = $a_record_id;
                $this->db = $ilDB;
                
                if($this->getRecordId())
                {
                        $this->read();
                }
        }
        
        public static function _getInstanceByRecordId($a_record_id)
        {
                if(isset(self::$instances[$a_record_id]))
                {
                        return self::$instances[$a_record_id];
                }
                return self::$instances[$a_record_id] = new ilAdvancedMDRecord($a_record_id);
        }
        
        public static function _getActiveSearchableRecords()
        {
                global $ilDB;
                
                $query = "SELECT DISTINCT(amr.record_id) FROM adv_md_record amr ".
                        "JOIN adv_mdf_definition amfd ON amr.record_id = amfd.record_id ".
                        "WHERE searchable = 1 AND active = 1 ";
                        
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $records[] = self::_getInstanceByRecordId($row->record_id);
                }
                return $records ? $records : array();
        }

        public static function _lookupTitle($a_record_id)
        {
                static $title_cache = array();
                
                if(isset($title_cache[$a_record_id]))
                {
                        return $title_cache[$a_record_id];
                }
                
                global $ilDB;
                
                $query = "SELECT title FROM adv_md_record ".
                        "WHERE record_id = ".$ilDB->quote($a_record_id ,'integer')." ";
                $res = $ilDB->query($query);
                $row = $res->fetchRow(DB_FETCHMODE_OBJECT);
                
                return $title_cache[$a_record_id] = $row->title;
        }
        
        public static function _lookupRecordIdByImportId($a_ilias_id)
        {
                global $ilDB;
                
                $query = "SELECT record_id FROM adv_md_record ".
                        "WHERE import_id = ".$ilDB->quote($a_ilias_id ,'text')." ";
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        return $row->record_id;
                }
                return 0;
        }
        
        public static function _getAssignableObjectTypes()
        {
                return array('cat','crs','rcrs');
        }
        
        public static function _getActivatedObjTypes()
        {
                global $ilDB;
                
                $query = "SELECT DISTINCT(obj_type) FROM adv_md_record_objs amo ".
                        "JOIN adv_md_record amr ON amo.record_id = amr.record_id ".
                        "WHERE active = 1 ";
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $obj_types[] = $row->obj_type; 
                }
                return $obj_types ? $obj_types : array(); 
        }
        
        public static function _getRecords()
        {
                global $ilDB;
                
                $query = "SELECT record_id FROM adv_md_record ";
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $records[] = ilAdvancedMDRecord::_getInstanceByRecordId($row->record_id);
                }
                return $records ? $records : array();
        }
        
        public static function _getAllRecordsByObjectType()
        {
                global $ilDB;
                
                $records = array();
                
                $query = "SELECT * FROM adv_md_record_objs ";
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $records[$row->obj_type][] = self::_getInstanceByRecordId($row->record_id);
                }
                return $records;
        }
        
        public static function _getActivatedRecordsByObjectType($a_obj_type)
        {
                global $ilDB;           

                $records = array();
                
                $query = "SELECT amro.record_id record_id FROM adv_md_record_objs amro ".
                        "JOIN adv_md_record amr ON amr.record_id = amro.record_id ".
                        "WHERE active = 1 ".
                        "AND obj_type = ".$ilDB->quote($a_obj_type ,'text')." ";
                
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $records[] = self::_getInstanceByRecordId($row->record_id);
                }
                return $records;
        }
        

        
        public static function _delete($a_record_id)
        {
                global $ilDB;
                
                // Delete fields
                ilAdvancedMDFieldDefinition::_deleteByRecordId($a_record_id);
                
                $query = "DELETE FROM adv_md_record ".
                        "WHERE record_id = ".$ilDB->quote($a_record_id ,'integer')." ";
                $res = $ilDB->manipulate($query);
                
                $query = "DELETE FROM adv_md_record_objs ".
                        "WHERE record_id = ".$ilDB->quote($a_record_id ,'integer')." ";
                $res = $ilDB->manipulate($query);
        }
        
        
        public function delete()
        {
                ilAdvancedMDRecord::_delete($this->getRecordId());
        }
        
        public function save()
        {
                global $ilDB;
                
                // Save import id if given
                $next_id = $ilDB->nextId('adv_md_record');
                
                $query = "INSERT INTO adv_md_record (record_id,import_id,active,title,description) ".
                        "VALUES(".
                        $ilDB->quote($next_id,'integer').", ".
                        $this->db->quote($this->getImportId(),'text').", ".
                        $this->db->quote($this->isActive() ,'integer').", ".
                        $this->db->quote($this->getTitle() ,'text').", ".
                        $this->db->quote($this->getDescription() ,'text')." ".
                        ")";
                $res = $ilDB->manipulate($query);
                $this->record_id = $next_id;

                if(!strlen($this->getImportId()))
                {
                        // set import id to default value
                        $query = "UPDATE adv_md_record ".
                                "SET import_id = ".$this->db->quote($this->generateImportId() ,'text')." ".
                                "WHERE record_id = ".$this->db->quote($this->record_id ,'integer')." ";
                        $res = $ilDB->manipulate($query);
                }

                foreach($this->getAssignedObjectTypes() as $type)
                {
                        global $ilDB;
                
                        $query = "INSERT INTO adv_md_record_objs (record_id,obj_type) ".
                                "VALUES( ".
                                $this->db->quote($this->getRecordId() ,'integer').", ".
                                $this->db->quote($type ,'text')." ".
                                ")";
                        $res = $ilDB->manipulate($query);
                }
        }
        
        public function update()
        {
                global $ilDB;
                
                $query = "UPDATE adv_md_record ".
                        "SET active = ".$this->db->quote($this->isActive() ,'integer').", ".
                        "title = ".$this->db->quote($this->getTitle() ,'text').", ".
                        "description = ".$this->db->quote($this->getDescription() ,'text')." ".
                        "WHERE record_id = ".$this->db->quote($this->getRecordId() ,'integer')." ";
                $res = $ilDB->manipulate($query);
                                
                // Delete assignments
                $query = "DELETE FROM adv_md_record_objs ".
                        "WHERE record_id = ".$this->db->quote($this->getRecordId() ,'integer')." ";
                $res = $ilDB->manipulate($query);
                        
                // Insert assignments
                foreach($this->getAssignedObjectTypes() as $type)
                {
                        $query = "INSERT INTO adv_md_record_objs (record_id,obj_type) ".
                                "VALUES ( ".
                                $this->db->quote($this->getRecordId() ,'integer').", ".
                                $this->db->quote($type ,'text')." ".
                                ")";
                        $res = $ilDB->manipulate($query);
                }
        }
        
        public function validate()
        {
                global $ilErr,$lng;
                
                if(!strlen($this->getTitle()))
                {
                        $ilErr->setMessage('fill_out_all_required_fields');
                        return false;
                }
                return true;
        }
        
        public function getRecordId()
        {
                return $this->record_id;
        }
        
        public function setActive($a_active)
        {
                $this->active = $a_active;
        }
        
        public function isActive()
        {
                return (bool) $this->active;
        }
        
        public function setTitle($a_title)
        {
                $this->title = $a_title;
        }
        
        public function getTitle()
        {
                return $this->title;
        }
        
        public function setDescription($a_description)
        {
                $this->description = $a_description;
        }
        
        public function getDescription()
        {
                return $this->description;
        }
        
        public function setImportId($a_id_string)
        {
                $this->import_id = $a_id_string;
        }
        
        public function getImportId()
        {
                return $this->import_id;        
        }
        
        public function setAssignedObjectTypes($a_obj_types)
        {
                $this->obj_types = $a_obj_types;
        }
        
        public function appendAssignedObjectType($a_obj_type)
        {
                $this->obj_types[] = $a_obj_type;
        }
        
        public function getAssignedObjectTypes()
        {
                return $this->obj_types ? $this->obj_types : array();
        }
        
        public function toXML(ilXmlWriter $writer)
        {
                $writer->xmlStartTag('Record',array('active' => $this->isActive() ? 1 : 0,
                        'id' => $this->generateImportId()));
                $writer->xmlElement('Title',null,$this->getTitle());
                $writer->xmlElement('Description',null,$this->getDescription());
                
                foreach($this->getAssignedObjectTypes() as $obj_type)
                {
                        $writer->xmlElement('ObjectType',null,$obj_type);
                }
                
                include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDFieldDefinition.php');
                foreach(ilAdvancedMDFieldDefinition::_getDefinitionsByRecordId($this->getRecordId()) as $definition)
                {
                        $definition->toXML($writer);
                }
                $writer->xmlEndTag('Record');
        }
        
        private function read()
        {
                global $ilDB;
                
                $query = "SELECT * FROM adv_md_record ".
                        "WHERE record_id = ".$this->db->quote($this->getRecordId() ,'integer')." ";
                $res = $this->db->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $this->setImportId($row->import_id);
                        $this->setActive($row->active);
                        $this->setTitle($row->title);
                        $this->setDescription($row->description);
                }
                $query = "SELECT * FROM adv_md_record_objs ".
                        "WHERE record_id = ".$this->db->quote($this->getRecordId() ,'integer')." ";
                $res = $this->db->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $this->obj_types[] = $row->obj_type;
                }
        }
        
        protected function generateImportId()
        {
                return 'il_'.IL_INST_ID.'_adv_md_record_'.$this->getRecordId();
        }
        
        public function __destruct()
        {
                unset(self::$instances[$this->getRecordId()]);
        }
}
?>