class.ilCalendarEntry.php

Go to the documentation of this file.

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

include_once('Services/Calendar/classes/class.ilDate.php');
include_once('./Services/Calendar/interfaces/interface.ilDatePeriod.php');

define('IL_CAL_TRANSLATION_NONE',0);
define('IL_CAL_TRANSLATION_SYSTEM',1);


class ilCalendarEntry implements ilDatePeriod
{
        protected $log;
        protected $db;
        
        
        protected $entry_id;
        protected $last_update;
        protected $title;
        protected $subtitle;
        protected $description;
        protected $location;
        protected $further_informations;
        protected $start = null;
        protected $fullday;
        protected $end = null;
        protected $is_auto_generated = false; 
        protected $context_id = 0;
        protected $translation_type = IL_CAL_TRANSLATION_NONE;
        protected $is_milestone = false;
        protected $completion = 0;

        protected $notification = false;

        public function __construct($a_id = 0)
        {
                global $ilDB,$ilLog;
                
                $this->log = $ilLog;
                $this->db = $ilDB;
                
                if($this->entry_id = $a_id)
                {
                        $this->read();
                }
        }

        public function __clone()
        {
                $this->entry_id = NULL;
        }
        
        public static function _delete($a_entry_id)
        {
                global $ilDB;
                
                include_once('./Services/Calendar/classes/class.ilCalendarRecurrence.php');
                ilCalendarRecurrence::_delete($a_entry_id);
                
                $query = "DELETE FROM cal_entries ".
                        "WHERE cal_id = ".$ilDB->quote($a_entry_id ,'integer')." ";
                $res = $ilDB->manipulate($query);
                
                return true;
        }

        public function getEntryId()
        {
                return $this->entry_id;
        }
        
        public function getLastUpdate()
        {
                return $this->last_update ? $this->last_update : new ilDateTime(time(),IL_CAL_UNIX);
        }
        
        public function setLastUpdate($a_date)
        {
                $this->last_update = $a_date;
        }
        
        
        public function getStart()
        {
                return $this->start;
                
        }
        
        public function setStart($a_start)
        {
                $this->start = $a_start;
        }
        
        public function getEnd()
        {
                return $this->end;
        }
        
        public function setEnd($a_end)
        {
                $this->end = $a_end;
        }
        
        public function setTitle($a_title)
        {
                $this->title = $a_title;
        }
        
        public function getTitle()
        {
                return $this->title;
        }
        
        public function getPresentationTitle($a_shorten = true)
        {
                global $lng;
                
                if($this->getTranslationType() == IL_CAL_TRANSLATION_NONE)
                {
                        $title = $this->getTitle();
                }
                elseif(strlen($this->getSubtitle()))
                {
                        // parse dynamic title?
                        if(preg_match("/#([a-z]+)#/", $this->getSubtitle(), $matches))
                        {
                                $subtitle = $this->parseDynamicTitle($matches[1]);
                        }
                        else
                        {
                                $subtitle = $lng->txt($this->getSubtitle());
                        }
                        $title = $this->getTitle().
                                (strlen($subtitle) 
                                ? ' ('.$subtitle.')'
                                : '');
                }               
                else
                {
                        $title = $lng->txt($this->getTitle());
                }

                if($a_shorten)
                {
                        return ilUtil::shortenText(ilUtil::shortenWords($title,20),40,true);
                }
                return $title;
        }
        
        public function getPresentationStyle()
        {
                // see parseDynamicTitle()
                return $this->presentation_style;
        }
        
        protected function parseDynamicTitle($a_type)
        {
                global $lng;
                
                $title = $style = "";
                switch($a_type)
                {
                        case "consultationhour":
                                include_once 'Services/Booking/classes/class.ilBookingEntry.php';
                                $entry = new ilBookingEntry($this->getContextId());
                                if($entry)
                                {
                                        if($entry->isOwner())
                                        {
                                                $max = (int)$entry->getNumberOfBookings();
                                                $current = (int)$entry->getCurrentNumberOfBookings($this->getEntryId());                                                
                                                if(!$current)
                                                {
                                                        $style = ';border-left-width: 5px; border-left-style: solid; border-left-color: green';
                                                        $title = $lng->txt('cal_book_free');
                                                }
                                                elseif($current >= $max)
                                                {
                                                        $style = ';border-left-width: 5px; border-left-style: solid; border-left-color: red';
                                                        $title = $lng->txt('cal_booked_out');
                                                }
                                                else
                                                {
                                                        $style = ';border-left-width: 5px; border-left-style: solid; border-left-color: yellow';
                                                        $title = $current.'/'.$max;
                                                }
                                        }                               
                                        else
                                        {
                                                /*
                                                 * if($entry->hasBooked($this->getEntryId()))
                                                 */
                                                include_once 'Services/Calendar/classes/ConsultationHours/class.ilConsultationHourAppointments.php';
                                                $apps = ilConsultationHourAppointments::getAppointmentIds($entry->getObjId(), $this->getContextId(), $this->getStart());
                                                $orig_event = $apps[0];
                                                if($entry->hasBooked($orig_event))
                                                {
                                                        $style = ';border-left-width: 5px; border-left-style: solid; border-left-color: green';
                                                        $title = $lng->txt('cal_date_booked');
                                                }
                                        }
                                }                                                                                               
                                break;                                          
                }
                
                if($style)
                {
                        $this->presentation_style = $style;
                }
                return $title;
        }
        
        public function setSubtitle($a_subtitle)
        {
                $this->subtitle = $a_subtitle;
        }
        
        public function getSubtitle()
        {
                return $this->subtitle;
        }
        
        public function setDescription($a_description)
        {
                $this->description = $a_description;
        }
        
        public function getDescription()
        {
                return $this->description;
        }
        
        public function setLocation($a_location)
        {
                $this->location = $a_location;
        }
        
        public function getLocation()
        {
                return $this->location;
        }
        
        public function setFurtherInformations($a_informations)
        {
                $this->further_informations = $a_informations;
        }
        
        public function getFurtherInformations()
        {
                return $this->further_informations;
        }
        
        public function setFullday($a_fullday)
        {
                $this->fullday = (bool) $a_fullday;
        }
        
        public function isFullday()
        {
                return (bool) $this->fullday;
        }
        
        public function isAutoGenerated()
        {
                return (bool) $this->is_auto_generated;
        }
        
        public function setAutoGenerated($a_status)
        {
                $this->is_auto_generated = $a_status;
        }
        
        public function isMilestone()
        {
                return (bool) $this->is_milestone;
        }
        
        public function setMilestone($a_status)
        {
                $this->is_milestone = $a_status;
        }

        function setCompletion($a_completion)
        {
                $this->completion = $a_completion;
        }

        function getCompletion()
        {
                return $this->completion;
        }

        public function setContextId($a_context_id)
        {
                $this->context_id = $a_context_id;
        }
        
        public function getContextId()
        {
                return $this->context_id;
        }
        
        public function setTranslationType($a_type)
        {
                $this->translation_type = $a_type;
        }
        
        public function getTranslationType()
        {
                return $this->translation_type;
        }
        
        public function enableNotification($a_status)
        {
                $this->notification = $a_status;
        }
        
        public function isNotificationEnabled()
        {
                return (bool) $this->notification;
        }
        
        public function update()
        {
                global $ilDB;
                
                $now = new ilDateTime(time(),IL_CAL_UNIX);
                $utc_timestamp = $now->get(IL_CAL_DATETIME,'',ilTimeZone::UTC);
                
                
                $query = "UPDATE cal_entries ".
                        "SET title = ".$this->db->quote($this->getTitle() ,'text').", ".
                        "last_update = ".$ilDB->quote($utc_timestamp,'timestamp').", ".
                        "subtitle = ".$this->db->quote($this->getSubtitle() ,'text').", ".
                        "description = ".$this->db->quote($this->getDescription(),'text').", ".
                        "location = ".$this->db->quote($this->getLocation() ,'text').", ".
                        "fullday = ".$ilDB->quote($this->isFullday() ? 1 : 0,'integer').", ".
                        "starta = ".$this->db->quote($this->getStart()->get(IL_CAL_DATETIME,'','UTC'),'timestamp').", ".
                        "enda = ".$this->db->quote($this->getEnd()->get(IL_CAL_DATETIME,'','UTC'),'timestamp').", ".
                        "informations = ".$this->db->quote($this->getFurtherInformations() ,'text').", ".
                        "auto_generated =  ".$this->db->quote($this->isAutoGenerated() ,'integer').", ".
                        "translation_type = ".$this->db->quote($this->getTranslationType() ,'integer').", ".
                        "context_id = ".$this->db->quote($this->getContextId() ,'integer').", ".
                        "completion = ".$this->db->quote($this->getCompletion(), 'integer').", ".
                        "is_milestone = ".$this->db->quote($this->isMilestone() ? 1 : 0, 'integer').", ".
                        'notification = '.$this->db->quote($this->isNotificationEnabled() ? 1 : 0,'integer').' '.
                        "WHERE cal_id = ".$this->db->quote($this->getEntryId() ,'integer')." ";
                $res = $ilDB->manipulate($query);

                return true;
        }
        
        public function save()
        {
                global $ilDB;
                
                $next_id = $ilDB->nextId('cal_entries');
                $now = new ilDateTime(time(),IL_CAL_UNIX);
                $utc_timestamp = $now->get(IL_CAL_DATETIME,'',ilTimeZone::UTC);

                $query = "INSERT INTO cal_entries (cal_id,title,last_update,subtitle,description,location,fullday,starta,enda, ".
                        "informations,auto_generated,context_id,translation_type, completion, is_milestone, notification) ".
                        "VALUES( ".
                        $ilDB->quote($next_id,'integer').", ".
                        $this->db->quote($this->getTitle(),'text').", ".
                        $ilDB->quote($utc_timestamp,'timestamp').", ".
                        $this->db->quote($this->getSubtitle(),'text').", ".
                        $this->db->quote($this->getDescription() ,'text').", ".
                        $this->db->quote($this->getLocation() ,'text').", ".
                        $ilDB->quote($this->isFullday() ? 1 : 0,'integer').", ".
                        $this->db->quote($this->getStart()->get(IL_CAL_DATETIME,'','UTC'),'timestamp').", ".
                        $this->db->quote($this->getEnd()->get(IL_CAL_DATETIME,'','UTC'),'timestamp').", ".
                        $this->db->quote($this->getFurtherInformations() ,'text').", ".
                        $this->db->quote($this->isAutoGenerated() ,'integer').", ".
                        $this->db->quote($this->getContextId() ,'integer').", ".
                        $this->db->quote($this->getTranslationType() ,'integer').", ".
                        $this->db->quote($this->getCompletion(), 'integer').", ".
                        $this->db->quote($this->isMilestone() ? 1 : 0, 'integer').", ".
                        $this->db->quote($this->isNotificationEnabled() ? 1 : 0,'integer').' '.
                        ")";
                $res = $ilDB->manipulate($query);       
                
                $this->entry_id = $next_id;             
                return true;
        }
        
        public function delete()
        {
                global $ilDB;
                
                include_once('./Services/Calendar/classes/class.ilCalendarRecurrence.php');
                ilCalendarRecurrence::_delete($this->getEntryId());
                
                $query = "DELETE FROM cal_entries ".
                        "WHERE cal_id = ".$this->db->quote($this->getEntryId() ,'integer')." ";
                $res = $ilDB->manipulate($query);
                
                include_once './Services/Calendar/classes/class.ilCalendarCategoryAssignments.php';
                ilCalendarCategoryAssignments::_deleteByAppointmentId($this->getEntryId());
                
                return true;
        }
        
        public function validate()
        {
                global $ilErr,$lng;
                
                $success = true;
                $ilErr->setMessage('');
                if(!strlen($this->getTitle()))
                {
                        $success = false;
                        $ilErr->appendMessage($lng->txt('err_missing_title'));
                }       
                if(!$this->getStart() || !$this->getEnd())
                {
                        $success = false;                       
                }
                else if(ilDateTime::_before($this->getEnd(),$this->getStart(),''))
                {
                        $success = false;
                        $ilErr->appendMessage($lng->txt('err_end_before_start'));
                }
                return $success;
        }
        
        
        
        protected function read()
        {
                global $ilDB;
                
                $query = "SELECT * FROM cal_entries WHERE cal_id = ".$this->db->quote($this->getEntryId() ,'integer')." ";
                $res = $this->db->query($query);
                while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                {
                        $this->setLastUpdate(new ilDateTime($row->last_update,IL_CAL_DATETIME,'UTC'));
                        $this->setTitle($row->title);
                        $this->setSubtitle($row->subtitle);
                        $this->setDescription($row->description);
                        $this->setLocation($row->location);
                        $this->setFurtherInformations($row->informations);
                        $this->setFullday((bool) $row->fullday);
                        $this->setAutoGenerated($row->auto_generated);
                        $this->setContextId($row->context_id);
                        $this->setTranslationType($row->translation_type);
                        $this->setCompletion($row->completion);
                        $this->setMilestone($row->is_milestone);
                        $this->enableNotification((bool) $row->notification);
                        
                        if($this->isFullday())
                        {
                                $this->start = new ilDate($row->starta,IL_CAL_DATETIME);
                                $this->end = new ilDate($row->enda,IL_CAL_DATETIME);
                        }
                        else
                        {
                                $this->start = new ilDateTime($row->starta,IL_CAL_DATETIME,'UTC');
                                $this->end = new ilDateTime($row->enda,IL_CAL_DATETIME,'UTC');
                        }
                }
                
        }
        
        public function appointmentToMailString($lng)
        {
                $body = $lng->txt('cal_details');
                $body .= "\n\n";
                $body .= $lng->txt('title').': '.$this->getTitle()."\n";
                
                ilDatePresentation::setUseRelativeDates(false);
                $body .= $lng->txt('date').': '.ilDatePresentation::formatPeriod($this->getStart(), $this->getEnd())."\n";
                ilDatePresentation::setUseRelativeDates(true);
                
                if(strlen($this->getLocation()))
                {
                        $body .= $lng->txt('cal_where').': '.$this->getLocation()."\n";
                }
        
                if(strlen($this->getDescription()))
                {
                        $body .= $lng->txt('description').': '.$this->getDescription()."\n";
                }
                return $body;
        }
        
        
        function writeResponsibleUsers($a_users)
        {
                global $ilDB;
                
                $ilDB->manipulateF("DELETE FROM cal_entry_responsible WHERE cal_id = %s",
                        array("integer"), array($this->getEntryId()));
                
                if (is_array($a_users))
                {
                        foreach ($a_users as $user_id)
                        {
                                $ilDB->manipulateF("INSERT INTO cal_entry_responsible (cal_id, user_id) ".
                                        " VALUES (%s,%s)", array("integer", "integer"),
                                        array($this->getEntryId(), $user_id));
                        }
                }
                
                $this->responsible_users = $a_users;
        }
        
        function readResponsibleUsers()
        {
                global $ilDB;
                
                $set = $ilDB->queryF("SELECT * FROM cal_entry_responsible WHERE cal_id = %s",
                        array("integer"), array($this->getEntryId()));

                $return = array();
                while($rec = $ilDB->fetchAssoc($set))
                {
                        $n = ilObjUser::_lookupName($rec["user_id"]);
                        $return[] = array_merge($n,
                                array("login" => ilObjUser::_lookupLogin($rec["user_id"])));
                }

                return $return;
        }
}
?>