class.ilCalendarRecurrence.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. |
        +-----------------------------------------------------------------------------+
*/

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

define('IL_CAL_FREQ_DAILY','DAILY');
define('IL_CAL_FREQ_WEEKLY','WEEKLY');
define('IL_CAL_FREQ_MONTHLY','MONTHLY');
define('IL_CAL_FREQ_YEARLY','YEARLY');

class ilCalendarRecurrence implements ilCalendarRecurrenceCalculation
{
        const REC_RECURRENCE = 0;
        const REC_EXCLUSION = 1;
        
        const FREQ_DAILY = 'DAILY';
        const FREQ_WEEKLY = 'WEEKLY';
        const FREQ_MONTHLY = 'MONTHLY';
        const FREQ_YEARLY = 'YEARLY';
        
        
        protected $db;
        
        private $recurrence_id;
        private $cal_id;
        private $recurrence_type;
        
        private $freq_type = '';
        private $freq_until_type; 
        private $freq_until_date = null;
        private $freq_until_count;
        
        private $interval = 0;
        private $byday = '';
        private $byweekno = '';
        private $bymonth = '';
        private $bymonthday = '';
        private $byyearday = '';
        private $bysetpos = '';
        private $weekstart = '';
        
        private $exclusion_dates = array();
        
        private $timezone = 'Europe/Berlin';

        public function __construct($a_rec_id = 0)
        {
                global $ilDB;
                
                $this->db = $ilDB;
                $this->recurrence_id = $a_rec_id;
                if($a_rec_id)
                {
                        $this->read();
                }
        }
        
        public static function _delete($a_cal_id)
        {
                global $ilDB;
                
                $query = "DELETE FROM cal_recurrence_rules ".
                        "WHERE cal_id = ".$ilDB->quote($a_cal_id ,'integer')." ";
                $res = $ilDB->manipulate($query);
                
                ilCalendarRecurrenceExclusions::delete($a_cal_id);
        }
        
        public function toICal($a_user_id)
        {
                include_once './Services/Calendar/classes/class.ilCalendarEntry.php';
                $entry = new ilCalendarEntry($this->getEntryId());

                $ical = 'RRULE:';
                $ical .= ('FREQ='.$this->getFrequenceType());
                
                if($this->getInterval())
                {
                        $ical .= (';INTERVAL='.$this->getInterval());
                }
                if($this->getFrequenceUntilCount())
                {
                        $ical .= (';COUNT='.$this->getFrequenceUntilCount());
                }
                elseif($this->getFrequenceUntilDate())
                {
                        if($entry->isFullday())
                        {
                                $ical .= (';UNTIL='.$this->getFrequenceUntilDate()->get(IL_CAL_FKT_DATE,'Ymd'));
                        }
                        else
                        {
                                $his = $entry->getStart()->get(IL_CAL_FKT_DATE, 'His');
                                $ical .= (';UNTIL='.$this->getFrequenceUntilDate()->get(IL_CAL_FKT_DATE,'Ymd').'T'.$his);
                        }
                }
                if($this->getBYMONTH())
                {
                        $ical .= (';BYMONTH='.$this->getBYMONTH());
                }
                if($this->getBYWEEKNO())
                {
                        $ical .= (';BYWEEKNO='.$this->getBYWEEKNO());
                }
                if($this->getBYYEARDAY())
                {
                        $ical .= (';BYYEARDAY='.$this->getBYYEARDAY());
                }
                if($this->getBYMONTHDAY())
                {
                        $ical .= (';BYMONTHDAY='.$this->getBYMONTHDAY());
                }
                if($this->getBYDAY())
                {
                        $ical .= (';BYDAY='.$this->getBYDAY());
                }
                if($this->getBYSETPOS())
                {
                        $ical .= (';BYSETPOS='.$this->getBYSETPOS());
                }

                // Required in outlook
                if($this->getBYDAY())
                {
                        include_once './Services/Calendar/classes/class.ilCalendarUserSettings.php';
                        include_once './Services/Calendar/classes/class.ilCalendarSettings.php';
                        $us = ilCalendarUserSettings::_getInstanceByUserId($a_user_id);
                        if($us->getWeekStart() == ilCalendarSettings::WEEK_START_MONDAY)
                        {
                                $ical .= (';WKST=MO');
                        }
                        else
                        {
                                $ical .= (';WKST=SU');
                        }
                }

                return $ical;
        }
        
        
        public function reset()
        {
                $this->setBYDAY('');
                $this->setBYMONTHDAY('');
                $this->setBYMONTH('');
                $this->setBYSETPOS('');
                $this->setBYWEEKNO('');
                $this->setBYYEARDAY('');
                $this->setFrequenceType('');
                $this->setInterval(1);
                $this->setFrequenceUntilCount(0);
                
                return true;
        }
        
        public function getRecurrenceId()
        {
                return $this->recurrence_id;
        }
        
        
        public function setEntryId($a_id)
        {
                $this->cal_id = $a_id;
        }
        
        public function getEntryId()
        {
                return $this->cal_id;
        }
        
        public function setRecurrence($a_type)
        {
                $this->recurrence_type = $a_type;
        }
        
        public function isRecurrence()
        {
                return $this->recurrence_type == self::REC_RECURRENCE;
        }
        
        public function setFrequenceType($a_type)
        {
                $this->freq_type = $a_type;
        }
        
        public function getFrequenceType()
        {
                return $this->freq_type;
        }
        
        public function getFrequenceUntilDate()
        {
                return is_object($this->freq_until_date) ? $this->freq_until_date : null;
        }
        
        public function setFrequenceUntilDate(ilDateTime $a_date = null)
        {
                $this->freq_until_date = $a_date;
        }
        
        public function setFrequenceUntilCount($a_count)
        {
                $this->freq_until_count = $a_count;
        }
        
        public function getFrequenceUntilCount()
        {
                return $this->freq_until_count;
        }
        
        public function setInterval($a_interval)
        {
                $this->interval = $a_interval;
        }
        
        public function getInterval()
        {
                return $this->interval ? $this->interval : 1;
        }
        
        public function setBYDAY($a_byday)
        {
                $this->byday = $a_byday;
        }
        
        public function getBYDAY()
        {
                return $this->byday;
        }
        
        public function getBYDAYList()
        {
                if(!trim($this->getBYDAY()))
                {
                        return array();
                }
                foreach(explode(',',$this->getBYDAY()) as $byday)
                {
                        $bydays[] = trim($byday);
                }
                return $bydays ? $bydays : array();
        }
        
        public function setBYWEEKNO($a_byweekno)
        {
                $this->byweekno = $a_byweekno;
        }
        
        public function getBYWEEKNOList()
        {
                if(!trim($this->getBYWEEKNO()))
                {
                        return array();
                }
                foreach(explode(',',$this->getBYWEEKNO()) as $week_num)
                {
                        $weeks[] = (int) $week_num;
                }
                return $weeks ? $weeks : array();
        }
        
        
        public function getBYWEEKNO()
        {
                return $this->byweekno;
        }
        
        public function setBYMONTH($a_by)
        {
                $this->bymonth = $a_by;
        }
        
        public function getBYMONTH()
        {
                return $this->bymonth;
        }
        
        public function getBYMONTHList()
        {
                if(!trim($this->getBYMONTH()))
                {
                        return array();
                }
                foreach(explode(',',$this->getBYMONTH()) as $month_num)
                {
                        $months[] = (int) $month_num;
                }
                return $months ? $months : array();
        }
        
        public function setBYMONTHDAY($a_by)
        {
                $this->bymonthday = $a_by;
        }
        
        public function getBYMONTHDAY()
        {
                return $this->bymonthday;
        }
        
        public function getBYMONTHDAYList()
        {
                if(!trim($this->getBYMONTHDAY()))
                {
                        return array();
                }
                foreach(explode(',',$this->getBYMONTHDAY()) as $month_num)
                {
                        $months[] = (int) $month_num;
                }
                return $months ? $months : array();
        
        }
        
        
        public function setBYYEARDAY($a_by)
        {
                $this->byyearday = $a_by;
        }
        
        public function getBYYEARDAY()
        {
                return $this->byyearday;
        }
        
        public function getBYYEARDAYList()
        {
                if(!trim($this->getBYYEARDAY()))
                {
                        return array();
                }
                foreach(explode(',',$this->getBYYEARDAY()) as $year_day)
                {
                        $days[] = (int) $year_day;
                }
                return $days ? $days : array();
        }
        
        public function setBYSETPOS($a_by)
        {
                $this->bysetpos = $a_by;
        }
        
        public function getBYSETPOS()
        {
                return $this->bysetpos;
        }
        
        public function getBYSETPOSList()
        {
                if(!trim($this->getBYSETPOS()))
                {
                        return array();
                }
                foreach(explode(',',$this->getBYSETPOS()) as $pos)
                {
                        $positions[] = (int) $pos;
                }
                return $positions ? $positions : array();
        }
        
        
        public function setWeekstart($a_start)
        {
                $this->weekstart = $a_start;
        }
        
        public function getWeekstart()
        {
                return $this->weekstart;
        }
        
        public function getTimeZone()
        {
                return $this->timezone;
        }
        
        public function setTimeZone($a_tz)
        {
                $this->timezone = $a_tz;
        }
        
        public function getExclusionDates()
        {
                return (array) $this->exclusion_dates;
        }
        
        public function validate()
        {
                $valid_frequences = array(IL_CAL_FREQ_DAILY,IL_CAL_FREQ_WEEKLY,IL_CAL_FREQ_MONTHLY,IL_CAL_FREQ_YEARLY);
                if(!in_array($this->getFrequenceType(),$valid_frequences))
                {
                        return false;
                }
                if($this->getFrequenceUntilCount() < 0)
                {
                        return false;
                }
                if($this->getInterval() <= 0)
                {
                        return false;
                }
                return true;
        }
        
        
        public function save()
        {
                global $ilDB;

                $until_date = is_null($this->getFrequenceUntilDate()) ? 
                        null : 
                        $this->getFrequenceUntilDate()->get(IL_CAL_DATETIME,'','UTC');
                $next_id = $ilDB->nextId('cal_recurrence_rules');
                
                $query = "INSERT INTO cal_recurrence_rules (rule_id,cal_id,cal_recurrence,freq_type,freq_until_date,freq_until_count,intervall, ".
                        "byday,byweekno,bymonth,bymonthday,byyearday,bysetpos,weekstart) ".
                        "VALUES( ".
                        $ilDB->quote($next_id,'integer').", ".
                        $this->db->quote($this->cal_id ,'integer').", ".
                        $ilDB->quote(1,'integer').", ".
                        $ilDB->quote((string) $this->getFrequenceType() ,'text').", ".
                        $this->db->quote($until_date,'timestamp').", ".
                        $this->db->quote((int) $this->getFrequenceUntilCount() ,'integer').", ".
                        $this->db->quote((int) $this->getInterval() ,'integer').", ".
                        $this->db->quote((string) $this->getBYDAY() ,'text').", ".
                        $this->db->quote((string) $this->getBYWEEKNO() ,'text').", ".
                        $this->db->quote((string) $this->getBYMONTH() ,'text').", ".
                        $this->db->quote((string) $this->getBYMONTHDAY() ,'text').", ".
                        $this->db->quote((string) $this->getBYYEARDAY() ,'text').", ".
                        $this->db->quote((string) $this->getBYSETPOS() ,'text').", ".
                        $this->db->quote((string) $this->getWeekstart() ,'text')." ".
                        ")";
                $res = $ilDB->manipulate($query);
                $this->recurrence_id = $next_id;
                return true;
        }
        
        public function update()
        {
                global $ilDB;
                
                $until_date = is_null($this->getFrequenceUntilDate()) ? 
                        null : 
                        $this->getFrequenceUntilDate()->get(IL_CAL_DATETIME,'','UTC');

                $query = "UPDATE cal_recurrence_rules SET ".
                        "cal_id = ".$this->db->quote($this->cal_id ,'integer').", ".
                        "cal_recurrence = 1,".
                        "freq_type = ".$this->db->quote($this->getFrequenceType() ,'text').", ".
                        "freq_until_date = ".$this->db->quote($until_date ,'timestamp').", ".
                        "freq_until_count = ".$this->db->quote($this->getFrequenceUntilCount() ,'integer').", ".
                        "intervall = ".$this->db->quote($this->getInterval() ,'integer').", ".
                        "byday = ".$this->db->quote($this->getBYDAY() ,'text').", ".
                        "byweekno = ".$this->db->quote($this->getBYWEEKNO() ,'text').", ".
                        "bymonth = ".$this->db->quote($this->getBYMONTH() ,'text').", ".
                        "bymonthday = ".$this->db->quote($this->getBYMONTHDAY() ,'text').", ".
                        "byyearday = ".$this->db->quote($this->getBYYEARDAY() ,'text').", ".
                        "bysetpos = ".$this->db->quote($this->getBYSETPOS() ,'text').", ".
                        "weekstart = ".$this->db->quote($this->getWeekstart() ,'text')." ".
                        "WHERE rule_id = ".$this->db->quote($this->recurrence_id ,'integer')." ";
                $res = $ilDB->manipulate($query);
                return true;
        }
        
        public function delete()
        {
                global $ilDB;
                
                $query = "DELETE FROM cal_recurrence_rules ".
                        "WHERE rule_id = ".$this->db->quote($this->recurrence_id ,'integer');
                $res = $ilDB->manipulate($query);
                return true;
        }

        private function read()
        {
                global $ilDB;
                
                $query = "SELECT * FROM cal_recurrence_rules ".
                        "WHERE rule_id = ".$this->db->quote($this->recurrence_id ,'integer')." ";
                $res = $this->db->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $this->cal_id = $row->cal_id;
                        $this->recurrence_type = $row->cal_recurrence;
                        $this->freq_type = $row->freq_type;
                        
                        if($row->freq_until_date != null)
                        {
                                $this->freq_until_date = new ilDateTime($row->freq_until_date,IL_CAL_DATETIME,'UTC');
                        }
                        $this->freq_until_count = $row->freq_until_count;
                        $this->interval = $row->intervall;
                        $this->byday = $row->byday;
                        $this->byweekno = $row->byweekno;
                        $this->bymonth = $row->bymonth;
                        $this->bymonthday = $row->bymonthday;
                        $this->byyearday = $row->byyearday;
                        $this->bysetpos = $row->bysetpos;
                        $this->weekstart = $row->week_start;
                }
                
                $this->exclusion_dates = ilCalendarRecurrenceExclusions::getExclusionDates($this->cal_id);
        }
}


?>