class.ilCalendarCategory.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 ilCalendarCategory
{
        const LTYPE_LOCAL = 1;
        const LTYPE_REMOTE = 2;
        
        private static $instances = null;

        const DEFAULT_COLOR = '#04427e';
        
        const TYPE_USR = 1;             // user
        const TYPE_OBJ = 2;             // object
        const TYPE_GLOBAL = 3;  // global
        const TYPE_CH = 4;              // consultation hours
        const TYPE_BOOK = 5;    // booking manager
        
        protected static $SORTED_TYPES = array(
                0               => self::TYPE_GLOBAL,
                1               => self::TYPE_USR,
                2               => self::TYPE_CH,
                3               => self::TYPE_BOOK,
                4               => self::TYPE_OBJ
        );
        
        
        protected $cat_id;
        protected $color;
        protected $type = self::TYPE_USR;
        protected $obj_id;
        protected $obj_type = null;
        protected $title;
        
        protected $location = self::LTYPE_LOCAL;
        protected $remote_url;
        protected $remote_user;
        protected $remote_pass;
        protected $remote_sync = null;
        
        protected $db;
        
        
        public function __construct($a_cat_id = 0)
        {
                global $ilDB;
                
                $this->db = $ilDB;
                $this->cat_id = $a_cat_id;
                
                $this->read();
        }
        
         public static function _getInstanceByObjId($a_obj_id)
         {
                global $ilDB;
                
                $query = "SELECT cat_id FROM cal_categories ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id ,'integer')." ".
                        "AND type = ".$ilDB->quote(self::TYPE_OBJ ,'integer');
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        return new ilCalendarCategory($row->cat_id);
                }
                return null;
         }

         public static function getInstanceByCategoryId($a_cat_id)
         {
                 if(!self::$instances[$a_cat_id])
                 {
                         return self::$instances[$a_cat_id] = new ilCalendarCategory($a_cat_id);
                 }
                 return self::$instances[$a_cat_id];
         }
         
         public static function lookupCategorySortIndex($a_type_id)
         {
                 return array_search($a_type_id, self::$SORTED_TYPES);
         }
         public static function lookupAppointments($a_category_id)
         {
                global $ilDB;
        
                $query = "SELECT * FROM cal_cat_assignments ".
                        'WHERE cat_id = '.$ilDB->quote($a_category_id,'integer');
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $apps[] = $row->cal_id;
                }
                return $apps ? $apps : array();
         }
        
        
        public function getCategoryID()
        {
                return $this->cat_id;
        }
        
        public function setTitle($a_title)
        {
                $this->title = $a_title;
        }
        
        public function getTitle()
        {
                return $this->title;
        }
        
        
        public function setColor($a_color)
        {
                $this->color = $a_color;
        }
        
        public function getColor()
        {
                return $this->color;
        }
        
        public function setType($a_type)
        {
                $this->type = $a_type;
        }
        
        public function getType()
        {
                return $this->type;
        }
        
        public function setObjId($a_obj_id)
        {
                $this->obj_id = $a_obj_id;
        }
        
        public function getObjId()
        {
                return $this->obj_id;
        }
        
        public function getObjType()
        {
                return $this->obj_type;
        }
        
        public function getLocationType()
        {
                return $this->location;
        }
        
        public function setLocationType($a_type)
        {
                $this->location = $a_type;
        }
        
        public function setRemoteUrl($a_url)
        {
                $this->remote_url = $a_url;
        }
        
        public function getRemoteUrl()
        {
                return $this->remote_url;
        }

        public function setRemoteUser($a_user)
        {
                $this->remote_user = $a_user;
        }
        
        public function getRemoteUser()
        {
                return $this->remote_user;
        }
        
        public function setRemotePass($a_pass)
        {
                $this->remote_pass = $a_pass;
        }
        
        public function getRemotePass()
        {
                return $this->remote_pass;
        }
        
        public function setRemoteSyncLastExecution(ilDateTime $dt = null)
        {
                $this->remote_sync = $dt;
        }
        
        public function getRemoteSyncLastExecution()
        {
                if($this->remote_sync instanceof ilDateTime)
                {
                        return $this->remote_sync;
                }
                return new ilDateTime();
        }

        
        public function add()
        {
                global $ilDB;

                $next_id = $ilDB->nextId('cal_categories');
                
                $query = "INSERT INTO cal_categories (cat_id,obj_id,color,type,title,loc_type,remote_url,remote_user,remote_pass,remote_sync) ".
                        "VALUES ( ".
                        $ilDB->quote($next_id,'integer').", ".
                        $this->db->quote($this->getObjId() ,'integer').", ".
                        $this->db->quote($this->getColor() ,'text').", ".
                        $this->db->quote($this->getType() ,'integer').", ".
                        $this->db->quote($this->getTitle() ,'text').", ".
                        $this->db->quote($this->getLocationType(),'integer').', '.
                        $this->db->quote($this->getRemoteUrl(),'text').', '.
                        $this->db->quote($this->getRemoteUser(),'text').', '.
                        $this->db->quote($this->getRemotePass(),'text').', '.
                        $this->db->quote($this->getRemoteSyncLastExecution()->get(IL_CAL_DATETIME,'',  ilTimeZone::UTC),'timestamp').' '.
                        ")";
                
                $ilDB->manipulate($query);

                $this->cat_id = $next_id;
                return $this->cat_id;
        }
        
        public function update()
        {
                global $ilDB;
                
                $query = "UPDATE cal_categories ".
                        "SET obj_id = ".$this->db->quote($this->getObjId() ,'integer').", ".
                        "color = ".$this->db->quote($this->getColor() ,'text').", ".
                        "type = ".$this->db->quote($this->getType() ,'integer').", ".
                        "title = ".$this->db->quote($this->getTitle() ,'text').", ".
                        "loc_type = ".$this->db->quote($this->getLocationType(),'integer').', '.
                        "remote_url = ".$this->db->quote($this->getRemoteUrl(),'text').', '.
                        "remote_user = ".$this->db->quote($this->getRemoteUser(),'text').', '.
                        "remote_pass = ".$this->db->quote($this->getRemotePass(),'text').', '.
                        'remote_sync = '.$this->db->quote($this->getRemoteSyncLastExecution()->get(IL_CAL_DATETIME,'',  ilTimeZone::UTC),'timestamp').' '.
                        "WHERE cat_id = ".$this->db->quote($this->cat_id ,'integer')." ";
                $res = $ilDB->manipulate($query);
                return true;
        }

        public function delete()
        {
                global $ilDB;
                
                $query = "DELETE FROM cal_categories ".
                        "WHERE cat_id = ".$this->db->quote($this->cat_id ,'integer')." ";
                $res = $ilDB->manipulate($query);

                include_once('./Services/Calendar/classes/class.ilCalendarHidden.php');
                ilCalendarHidden::_deleteCategories($this->cat_id);
                
                include_once('./Services/Calendar/classes/class.ilCalendarCategoryAssignments.php');
                foreach(ilCalendarCategoryAssignments::_getAssignedAppointments(array($this->cat_id)) as $app_id)
                {
                        include_once('./Services/Calendar/classes/class.ilCalendarEntry.php');
                        ilCalendarEntry::_delete($app_id);
                }
                ilCalendarCategoryAssignments::_deleteByCategoryId($this->cat_id);
        }
        
        public function validate()
        {
                if($this->getLocationType() == ilCalendarCategory::LTYPE_REMOTE and !$this->getRemoteUrl())
                {
                        return false;
                }
                if(strlen($this->getTitle()) and strlen($this->getColor()) and $this->getType())
                {
                        return true;
                }
                return false;
        }
        
        private function read()
        {
                global $ilDB;
                
                if(!$this->cat_id)
                {
                        return true;
                }
                
                $query = "SELECT * FROM cal_categories ".
                        "WHERE cat_id = ".$this->db->quote($this->getCategoryID() ,'integer')." ";
                $res = $this->db->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $this->cat_id = $row->cat_id;
                        $this->obj_id = $row->obj_id;
                        $this->type = $row->type;
                        $this->color = $row->color;
                        $this->title = $row->title;
                        $this->location = $row->loc_type;
                        $this->remote_url = $row->remote_url;
                        $this->remote_user = $row->remote_user;
                        $this->remote_pass = $row->remote_pass;
                        
                        if($row->remote_sync)
                        {
                                $this->remote_sync = new ilDateTime($row->remote_sync,IL_CAL_DATETIME,'UTC');
                        }
                        else
                        {
                                $this->remote_sync = new ilDateTime();
                        }
                }
                if($this->getType() == self::TYPE_OBJ)
                {
                        $this->title = ilObject::_lookupTitle($this->getObjId());
                        $this->obj_type = ilObject::_lookupType($this->getObjId());
                }
        }
}
?>