ilCalendarRecurrence Class Reference

Model of calendar entry recurrcences based on iCalendar-RFC-5545. More...

Inheritance diagram for ilCalendarRecurrence:

Collaboration diagram for ilCalendarRecurrence:

Public Member Functions
	__construct (int $a_rec_id=0)
	toICal (int $a_user_id)
	Get ical presentation for calendar recurrence. More...
	reset ()
	reset all settings More...
	getRecurrenceId ()
	setEntryId (int $a_id)
	getEntryId ()
	setRecurrence (int $a_type)
	set type of recurrence public More...
	isRecurrence ()
	setFrequenceType (string $a_type)
	getFrequenceType ()
	Get Frequence type of recurrence. More...
	getFrequenceUntilDate ()
	Get end data of recurrence. More...
	setFrequenceUntilDate (?ilDateTime $a_date=null)
	setFrequenceUntilCount (int $a_count)
	getFrequenceUntilCount ()
	Get number of recurrences. More...
	setInterval (int $a_interval)
	getInterval ()
	Get interval of recurrence. More...
	setBYDAY (string $a_byday)
	3.8.5.3. More...
	getBYDAY ()
	getBYDAYList ()
	setBYWEEKNO (string $a_byweekno)
	getBYWEEKNOList ()
	Get BYWEEKNOList. More...
	getBYWEEKNO ()
	setBYMONTH (string $a_by)
	getBYMONTH ()
	getBYMONTHList ()
	Get BYMONTHList. More...
	setBYMONTHDAY (string $a_by)
	getBYMONTHDAY ()
	getBYMONTHDAYList ()
	Get BYMONTHDAY List. More...
	setBYYEARDAY (string $a_by)
	getBYYEARDAY ()
	getBYYEARDAYList ()
	Get BYYEARDAYLIST. More...
	setBYSETPOS (string $a_by)
	getBYSETPOS ()
	getBYSETPOSList ()
	Get BYSETPOS List. More...
	setWeekstart (string $a_start)
	getWeekstart ()
	getTimeZone ()
	Get timezone of recurrence. More...
	setTimeZone (string $a_tz)
	getExclusionDates ()
	validate ()
	validate More...
	save ()
	update ()
	delete ()

Static Public Member Functions
static	_delete (int $a_cal_id)

Data Fields
const	FREQ_NONE = 'NONE'
const	FREQ_DAILY = 'DAILY'
const	FREQ_WEEKLY = 'WEEKLY'
const	FREQ_MONTHLY = 'MONTHLY'
const	FREQ_YEARLY = 'YEARLY'

Protected Attributes
const	REC_RECURRENCE = 0
const	REC_EXCLUSION = 1
ilDBInterface	$db

Private Member Functions
	read ()

Private Attributes
int	$recurrence_id = 0
int	$cal_id = 0
int	$recurrence_type = 0
string	$freq_type = ''
string	$freq_until_type = ''
ilDate	$freq_until_date = null
int	$freq_until_count = 0
int	$interval = 1
string	$byday = ''
string	$byweekno = ''
string	$bymonth = ''
string	$bymonthday = ''
string	$byyearday = ''
string	$bysetpos = ''
string	$weekstart = ''
array	$exclusion_dates = array()
string	$timezone = 'Europe/Berlin'

Detailed Description

Model of calendar entry recurrcences based on iCalendar-RFC-5545.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

Definition at line 28 of file class.ilCalendarRecurrence.php.

Constructor & Destructor Documentation

__construct()

ilCalendarRecurrence::__construct

(

int

$a_rec_id = 0

)

Definition at line 63 of file class.ilCalendarRecurrence.php.

References $DIC, and read().

    {
        global $DIC;

        $this->db = $DIC->database();
        $this->recurrence_id = $a_rec_id;
        if ($a_rec_id) {
            $this->read();
        }
    }

Here is the call graph for this function:

Member Function Documentation

_delete()

static ilCalendarRecurrence::_delete ( int  $a_cal_id )

static

Definition at line 74 of file class.ilCalendarRecurrence.php.

References $DIC, $ilDB, $res, and ilCalendarRecurrenceExclusions\delete().

Referenced by ilCalendarEntry\_delete(), and ilCalendarEntry\delete().

                                                 : void
    {
        global $DIC;

        $ilDB = $DIC['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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilCalendarRecurrence::delete

(

)

Definition at line 473 of file class.ilCalendarRecurrence.php.

References $res.

                            : void
    {
        $query = "DELETE FROM cal_recurrence_rules " .
            "WHERE rule_id = " . $this->db->quote($this->recurrence_id, 'integer');
        $res = $this->db->manipulate($query);
    }

getBYDAY()

ilCalendarRecurrence::getBYDAY

(

)

Definition at line 240 of file class.ilCalendarRecurrence.php.

References $byday.

Referenced by getBYDAYList(), save(), toICal(), and update().

                              : string
    {
        return $this->byday;
    }

Here is the caller graph for this function:

getBYDAYList()

ilCalendarRecurrence::getBYDAYList

(

)

Implements ilCalendarRecurrenceCalculation.

Definition at line 248 of file class.ilCalendarRecurrence.php.

References getBYDAY().

                                  : array
    {
        if (!trim($this->getBYDAY())) {
            return array();
        }
        $bydays = [];
        foreach (explode(',', $this->getBYDAY()) as $byday) {
            $bydays[] = trim($byday);
        }
        return $bydays;
    }

Here is the call graph for this function:

getBYMONTH()

ilCalendarRecurrence::getBYMONTH

(

)

Definition at line 287 of file class.ilCalendarRecurrence.php.

References $bymonth.

Referenced by getBYMONTHList(), save(), toICal(), and update().

                                : string
    {
        return $this->bymonth;
    }

Here is the caller graph for this function:

getBYMONTHDAY()

ilCalendarRecurrence::getBYMONTHDAY

(

)

Definition at line 309 of file class.ilCalendarRecurrence.php.

References $bymonthday.

Referenced by getBYMONTHDAYList(), save(), toICal(), and update().

                                   : string
    {
        return $this->bymonthday;
    }

Here is the caller graph for this function:

getBYMONTHDAYList()

ilCalendarRecurrence::getBYMONTHDAYList

(

)

Get BYMONTHDAY List.

Returns

int[] array of "month day" items [1,31]

Implements ilCalendarRecurrenceCalculation.

Definition at line 314 of file class.ilCalendarRecurrence.php.

References getBYMONTHDAY(), and ILIAS\Repository\int().

                                       : array
    {
        if (!trim($this->getBYMONTHDAY())) {
            return array();
        }
        $month = [];
        foreach (explode(',', $this->getBYMONTHDAY()) as $month_num) {
            $month[] = (int) $month_num;
        }
        return $month;
    }

Here is the call graph for this function:

getBYMONTHList()

ilCalendarRecurrence::getBYMONTHList

(

)

Get BYMONTHList.

Returns

int[] array of "by month" items: [1,12]

Implements ilCalendarRecurrenceCalculation.

Definition at line 292 of file class.ilCalendarRecurrence.php.

References getBYMONTH(), and ILIAS\Repository\int().

                                    : array
    {
        if (!trim($this->getBYMONTH())) {
            return array();
        }
        $months = [];
        foreach (explode(',', $this->getBYMONTH()) as $month_num) {
            $months[] = (int) $month_num;
        }
        return $months;
    }

Here is the call graph for this function:

getBYSETPOS()

ilCalendarRecurrence::getBYSETPOS

(

)

Definition at line 353 of file class.ilCalendarRecurrence.php.

References $bysetpos.

Referenced by getBYSETPOSList(), save(), toICal(), and update().

                                 : string
    {
        return $this->bysetpos;
    }

Here is the caller graph for this function:

getBYSETPOSList()

ilCalendarRecurrence::getBYSETPOSList

(

)

Get BYSETPOS List.

Implements ilCalendarRecurrenceCalculation.

Definition at line 358 of file class.ilCalendarRecurrence.php.

References getBYSETPOS(), and ILIAS\Repository\int().

                                     : array
    {
        if (!trim($this->getBYSETPOS())) {
            return array();
        }
        $positions = [];
        foreach (explode(',', $this->getBYSETPOS()) as $pos) {
            $positions[] = (int) $pos;
        }
        return $positions;
    }

Here is the call graph for this function:

getBYWEEKNO()

ilCalendarRecurrence::getBYWEEKNO

(

)

Definition at line 277 of file class.ilCalendarRecurrence.php.

References $byweekno.

Referenced by getBYWEEKNOList(), save(), toICal(), and update().

                                 : string
    {
        return $this->byweekno;
    }

Here is the caller graph for this function:

getBYWEEKNOList()

ilCalendarRecurrence::getBYWEEKNOList

(

)

Get BYWEEKNOList.

Returns

int[] array of "by week no" items: [1,54]

Implements ilCalendarRecurrenceCalculation.

Definition at line 265 of file class.ilCalendarRecurrence.php.

References getBYWEEKNO(), and ILIAS\Repository\int().

                                     : array
    {
        if (!trim($this->getBYWEEKNO())) {
            return array();
        }
        $weeks = [];
        foreach (explode(',', $this->getBYWEEKNO()) as $week_num) {
            $weeks[] = (int) $week_num;
        }
        return $weeks;
    }

Here is the call graph for this function:

getBYYEARDAY()

ilCalendarRecurrence::getBYYEARDAY

(

)

Definition at line 331 of file class.ilCalendarRecurrence.php.

References $byyearday.

Referenced by getBYYEARDAYList(), save(), toICal(), and update().

                                  : string
    {
        return $this->byyearday;
    }

Here is the caller graph for this function:

getBYYEARDAYList()

ilCalendarRecurrence::getBYYEARDAYList

(

)

Get BYYEARDAYLIST.

Returns

int[] array of "year day" items [1,365]

Implements ilCalendarRecurrenceCalculation.

Definition at line 336 of file class.ilCalendarRecurrence.php.

References getBYYEARDAY(), and ILIAS\Repository\int().

                                      : array
    {
        if (!trim($this->getBYYEARDAY())) {
            return array();
        }
        $days = [];
        foreach (explode(',', $this->getBYYEARDAY()) as $year_day) {
            $days[] = (int) $year_day;
        }
        return $days;
    }

Here is the call graph for this function:

getEntryId()

ilCalendarRecurrence::getEntryId

(

)

Definition at line 171 of file class.ilCalendarRecurrence.php.

References $cal_id.

Referenced by toICal().

                                : int
    {
        return $this->cal_id;
    }

Here is the caller graph for this function:

getExclusionDates()

ilCalendarRecurrence::getExclusionDates

(

)

Returns

ilCalendarRecurrenceExclusion[]

Implements ilCalendarRecurrenceCalculation.

Definition at line 393 of file class.ilCalendarRecurrence.php.

References $exclusion_dates.

                                       : array
    {
        return $this->exclusion_dates;
    }

getFrequenceType()

ilCalendarRecurrence::getFrequenceType

(

)

Get Frequence type of recurrence.

Implements ilCalendarRecurrenceCalculation.

Definition at line 196 of file class.ilCalendarRecurrence.php.

References $freq_type.

Referenced by ilObjEmployeeTalkSeriesGUI\copyTemplateValues(), ilEmployeeTalkAppointmentGUI\loadRecurrenceSettings(), save(), toICal(), update(), and validate().

                                      : string
    {
        return $this->freq_type;
    }

Here is the caller graph for this function:

getFrequenceUntilCount()

ilCalendarRecurrence::getFrequenceUntilCount

(

)

Get number of recurrences.

Implements ilCalendarRecurrenceCalculation.

Definition at line 216 of file class.ilCalendarRecurrence.php.

References $freq_until_count.

Referenced by save(), toICal(), update(), and validate().

                                            : int
    {
        return $this->freq_until_count;
    }

Here is the caller graph for this function:

getFrequenceUntilDate()

ilCalendarRecurrence::getFrequenceUntilDate

(

)

Get end data of recurrence.

Implements ilCalendarRecurrenceCalculation.

Definition at line 201 of file class.ilCalendarRecurrence.php.

References null.

Referenced by save(), toICal(), and update().

                                           : ?ilDate
    {
        return is_object($this->freq_until_date) ? $this->freq_until_date : null;
    }

Here is the caller graph for this function:

getInterval()

ilCalendarRecurrence::getInterval

(

)

Get interval of recurrence.

Implements ilCalendarRecurrenceCalculation.

Definition at line 226 of file class.ilCalendarRecurrence.php.

References $interval.

Referenced by save(), toICal(), update(), and validate().

                                 : int
    {
        return $this->interval;
    }

Here is the caller graph for this function:

getRecurrenceId()

ilCalendarRecurrence::getRecurrenceId

(

)

Definition at line 161 of file class.ilCalendarRecurrence.php.

References $recurrence_id.

                                     : int
    {
        return $this->recurrence_id;
    }

getTimeZone()

ilCalendarRecurrence::getTimeZone

(

)

Get timezone of recurrence.

Implements ilCalendarRecurrenceCalculation.

Definition at line 380 of file class.ilCalendarRecurrence.php.

References $timezone.

                                 : string
    {
        return $this->timezone;
    }

getWeekstart()

ilCalendarRecurrence::getWeekstart

(

)

Definition at line 375 of file class.ilCalendarRecurrence.php.

References $weekstart.

Referenced by save(), and update().

                                  : string
    {
        return $this->weekstart;
    }

Here is the caller graph for this function:

isRecurrence()

ilCalendarRecurrence::isRecurrence

(

)

Definition at line 186 of file class.ilCalendarRecurrence.php.

                                  : bool
    {
        return $this->recurrence_type == self::REC_RECURRENCE;
    }

read()

ilCalendarRecurrence::read ( )

private

Definition at line 480 of file class.ilCalendarRecurrence.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, ilCalendarRecurrenceExclusions\getExclusionDates(), if, IL_CAL_DATETIME, ILIAS\Repository\int(), and null.

Referenced by __construct().

                           : void
    {
        $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(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->cal_id = (int) $row->cal_id;
            $this->recurrence_type = (int) $row->cal_recurrence;
            $this->freq_type = (string) $row->freq_type;

            if ($row->freq_until_date != null) {
                $this->freq_until_date = new ilDate($row->freq_until_date, IL_CAL_DATETIME);
            }
            $this->freq_until_count = (int) $row->freq_until_count;
            $this->interval = (int) $row->intervall;
            $this->byday = (string) $row->byday;
            $this->byweekno = (string) $row->byweekno;
            $this->bymonth = (string) $row->bymonth;
            $this->bymonthday = (string) $row->bymonthday;
            $this->byyearday = (string) $row->byyearday;
            $this->bysetpos = (string) $row->bysetpos;
            $this->weekstart = (string) $row->weekstart;
        }

        $this->exclusion_dates = ilCalendarRecurrenceExclusions::getExclusionDates($this->cal_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

ilCalendarRecurrence::reset

(

)

reset all settings

Definition at line 148 of file class.ilCalendarRecurrence.php.

References setBYDAY(), setBYMONTH(), setBYMONTHDAY(), setBYSETPOS(), setBYWEEKNO(), setBYYEARDAY(), setFrequenceType(), setFrequenceUntilCount(), and setInterval().

                           : void
    {
        $this->setBYDAY('');
        $this->setBYMONTHDAY('');
        $this->setBYMONTH('');
        $this->setBYSETPOS('');
        $this->setBYWEEKNO('');
        $this->setBYYEARDAY('');
        $this->setFrequenceType('');
        $this->setInterval(1);
        $this->setFrequenceUntilCount(0);
    }

Here is the call graph for this function:

save()

ilCalendarRecurrence::save

(

)

Definition at line 420 of file class.ilCalendarRecurrence.php.

References $res, getBYDAY(), getBYMONTH(), getBYMONTHDAY(), getBYSETPOS(), getBYWEEKNO(), getBYYEARDAY(), getFrequenceType(), getFrequenceUntilCount(), getFrequenceUntilDate(), getInterval(), getWeekstart(), IL_CAL_DATETIME, and null.

                          : void
    {
        $until_date = is_null($this->getFrequenceUntilDate()) ?
            null :
            $this->getFrequenceUntilDate()->get(IL_CAL_DATETIME, '', 'UTC');
        $next_id = $this->db->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( " .
            $this->db->quote($next_id, 'integer') . ", " .
            $this->db->quote($this->cal_id, 'integer') . ", " .
            $this->db->quote(1, 'integer') . ", " .
            $this->db->quote($this->getFrequenceType(), 'text') . ", " .
            $this->db->quote($until_date, 'timestamp') . ", " .
            $this->db->quote($this->getFrequenceUntilCount(), 'integer') . ", " .
            $this->db->quote($this->getInterval(), 'integer') . ", " .
            $this->db->quote($this->getBYDAY(), 'text') . ", " .
            $this->db->quote($this->getBYWEEKNO(), 'text') . ", " .
            $this->db->quote($this->getBYMONTH(), 'text') . ", " .
            $this->db->quote($this->getBYMONTHDAY(), 'text') . ", " .
            $this->db->quote($this->getBYYEARDAY(), 'text') . ", " .
            $this->db->quote($this->getBYSETPOS(), 'text') . ", " .
            $this->db->quote($this->getWeekstart(), 'text') . " " .
            ")";
        $res = $this->db->manipulate($query);
        $this->recurrence_id = $next_id;
    }

Here is the call graph for this function:

setBYDAY()

ilCalendarRecurrence::setBYDAY

(

string

$a_byday

)

3.8.5.3.

Recurrence Rule example: BYDAY=TU,TH

Definition at line 235 of file class.ilCalendarRecurrence.php.

Referenced by reset().

                                             : void
    {
        $this->byday = $a_byday;
    }

Here is the caller graph for this function:

setBYMONTH()

ilCalendarRecurrence::setBYMONTH

(

string

$a_by

)

Definition at line 282 of file class.ilCalendarRecurrence.php.

Referenced by reset().

                                            : void
    {
        $this->bymonth = $a_by;
    }

Here is the caller graph for this function:

setBYMONTHDAY()

ilCalendarRecurrence::setBYMONTHDAY

(

string

$a_by

)

Definition at line 304 of file class.ilCalendarRecurrence.php.

Referenced by reset().

                                               : void
    {
        $this->bymonthday = $a_by;
    }

Here is the caller graph for this function:

setBYSETPOS()

ilCalendarRecurrence::setBYSETPOS

(

string

$a_by

)

Definition at line 348 of file class.ilCalendarRecurrence.php.

Referenced by reset().

                                             : void
    {
        $this->bysetpos = $a_by;
    }

Here is the caller graph for this function:

setBYWEEKNO()

ilCalendarRecurrence::setBYWEEKNO

(

string

$a_byweekno

)

Definition at line 260 of file class.ilCalendarRecurrence.php.

Referenced by reset().

                                                   : void
    {
        $this->byweekno = $a_byweekno;
    }

Here is the caller graph for this function:

setBYYEARDAY()

ilCalendarRecurrence::setBYYEARDAY

(

string

$a_by

)

Definition at line 326 of file class.ilCalendarRecurrence.php.

Referenced by reset().

                                              : void
    {
        $this->byyearday = $a_by;
    }

Here is the caller graph for this function:

setEntryId()

ilCalendarRecurrence::setEntryId

(

int

$a_id

)

Definition at line 166 of file class.ilCalendarRecurrence.php.

                                         : void
    {
        $this->cal_id = $a_id;
    }

setFrequenceType()

ilCalendarRecurrence::setFrequenceType

(

string

$a_type

)

Definition at line 191 of file class.ilCalendarRecurrence.php.

Referenced by reset().

                                                    : void
    {
        $this->freq_type = $a_type;
    }

Here is the caller graph for this function:

setFrequenceUntilCount()

ilCalendarRecurrence::setFrequenceUntilCount

(

int

$a_count

)

Definition at line 211 of file class.ilCalendarRecurrence.php.

Referenced by reset().

                                                        : void
    {
        $this->freq_until_count = $a_count;
    }

Here is the caller graph for this function:

setFrequenceUntilDate()

ilCalendarRecurrence::setFrequenceUntilDate

(

?ilDateTime

$a_date = null

)

Definition at line 206 of file class.ilCalendarRecurrence.php.

                                                                     : void
    {
        $this->freq_until_date = $a_date;
    }

setInterval()

ilCalendarRecurrence::setInterval

(

int

$a_interval

)

Definition at line 221 of file class.ilCalendarRecurrence.php.

Referenced by reset().

                                                : void
    {
        $this->interval = $a_interval;
    }

Here is the caller graph for this function:

setRecurrence()

ilCalendarRecurrence::setRecurrence

(

int

$a_type

)

set type of recurrence public

Parameters

int	REC_RECURRENCE or REC_EXLUSION defines whther the current object is a recurrence an exclusion pattern

Definition at line 181 of file class.ilCalendarRecurrence.php.

Referenced by ilCalendarAppointmentGUI\initForm(), and ilObjSessionGUI\initForm().

                                              : void
    {
        $this->recurrence_type = $a_type;
    }

Here is the caller graph for this function:

setTimeZone()

ilCalendarRecurrence::setTimeZone

(

string

$a_tz

)

Definition at line 385 of file class.ilCalendarRecurrence.php.

                                             : void
    {
        $this->timezone = $a_tz;
    }

setWeekstart()

ilCalendarRecurrence::setWeekstart

(

string

$a_start

)

Definition at line 370 of file class.ilCalendarRecurrence.php.

                                                 : void
    {
        $this->weekstart = $a_start;
    }

toICal()

ilCalendarRecurrence::toICal

(

int

$a_user_id

)

Get ical presentation for calendar recurrence.

Definition at line 89 of file class.ilCalendarRecurrence.php.

References ilCalendarUserSettings\_getInstanceByUserId(), getBYDAY(), getBYMONTH(), getBYMONTHDAY(), getBYSETPOS(), getBYWEEKNO(), getBYYEARDAY(), getEntryId(), getFrequenceType(), getFrequenceUntilCount(), getFrequenceUntilDate(), getInterval(), IL_CAL_FKT_DATE, and ilCalendarSettings\WEEK_START_MONDAY.

                                          : string
    {
        $entry = new ilCalendarEntry($this->getEntryId());

        if (!$this->getFrequenceType()) {
            return '';
        }

        $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()) {
            $us = ilCalendarUserSettings::_getInstanceByUserId($a_user_id);
            if ($us->getWeekStart() == ilCalendarSettings::WEEK_START_MONDAY) {
                $ical .= (';WKST=MO');
            } else {
                $ical .= (';WKST=SU');
            }
        }

        return $ical;
    }

Here is the call graph for this function:

update()

ilCalendarRecurrence::update

(

)

Definition at line 449 of file class.ilCalendarRecurrence.php.

References $res, getBYDAY(), getBYMONTH(), getBYMONTHDAY(), getBYSETPOS(), getBYWEEKNO(), getBYYEARDAY(), getFrequenceType(), getFrequenceUntilCount(), getFrequenceUntilDate(), getInterval(), getWeekstart(), IL_CAL_DATETIME, and null.

                            : void
    {
        $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 = $this->db->manipulate($query);
    }

Here is the call graph for this function:

validate()

ilCalendarRecurrence::validate

(

)

validate

Implements ilCalendarRecurrenceCalculation.

Definition at line 401 of file class.ilCalendarRecurrence.php.

References getFrequenceType(), getFrequenceUntilCount(), and getInterval().

                              : bool
    {
        $valid_frequences = array(self::FREQ_DAILY,
                                  self::FREQ_WEEKLY,
                                  self::FREQ_MONTHLY,
                                  self::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;
    }

Here is the call graph for this function:

Field Documentation

$byday

string ilCalendarRecurrence::$byday = ''

private

Definition at line 51 of file class.ilCalendarRecurrence.php.

Referenced by getBYDAY().

$bymonth

string ilCalendarRecurrence::$bymonth = ''

private

Definition at line 53 of file class.ilCalendarRecurrence.php.

Referenced by getBYMONTH().

$bymonthday

string ilCalendarRecurrence::$bymonthday = ''

private

Definition at line 54 of file class.ilCalendarRecurrence.php.

Referenced by getBYMONTHDAY().

$bysetpos

string ilCalendarRecurrence::$bysetpos = ''

private

Definition at line 56 of file class.ilCalendarRecurrence.php.

Referenced by getBYSETPOS().

$byweekno

string ilCalendarRecurrence::$byweekno = ''

private

Definition at line 52 of file class.ilCalendarRecurrence.php.

Referenced by getBYWEEKNO().

$byyearday

string ilCalendarRecurrence::$byyearday = ''

private

Definition at line 55 of file class.ilCalendarRecurrence.php.

Referenced by getBYYEARDAY().

$cal_id

int ilCalendarRecurrence::$cal_id = 0

private

Definition at line 42 of file class.ilCalendarRecurrence.php.

Referenced by getEntryId().

$db

ilDBInterface ilCalendarRecurrence::$db

protected

Definition at line 39 of file class.ilCalendarRecurrence.php.

$exclusion_dates

array ilCalendarRecurrence::$exclusion_dates = array()

private

Definition at line 59 of file class.ilCalendarRecurrence.php.

Referenced by getExclusionDates().

$freq_type

string ilCalendarRecurrence::$freq_type = ''

private

Definition at line 45 of file class.ilCalendarRecurrence.php.

Referenced by getFrequenceType().

$freq_until_count

int ilCalendarRecurrence::$freq_until_count = 0

private

Definition at line 48 of file class.ilCalendarRecurrence.php.

Referenced by getFrequenceUntilCount().

$freq_until_date

ilDate ilCalendarRecurrence::$freq_until_date = null

private

Definition at line 47 of file class.ilCalendarRecurrence.php.

$freq_until_type

string ilCalendarRecurrence::$freq_until_type = ''

private

Definition at line 46 of file class.ilCalendarRecurrence.php.

$interval

int ilCalendarRecurrence::$interval = 1

private

Definition at line 50 of file class.ilCalendarRecurrence.php.

Referenced by getInterval().

$recurrence_id

int ilCalendarRecurrence::$recurrence_id = 0

private

Definition at line 41 of file class.ilCalendarRecurrence.php.

Referenced by getRecurrenceId().

$recurrence_type

int ilCalendarRecurrence::$recurrence_type = 0

private

Definition at line 43 of file class.ilCalendarRecurrence.php.

$timezone

string ilCalendarRecurrence::$timezone = 'Europe/Berlin'

private

Definition at line 61 of file class.ilCalendarRecurrence.php.

Referenced by getTimeZone().

$weekstart

string ilCalendarRecurrence::$weekstart = ''

private

Definition at line 57 of file class.ilCalendarRecurrence.php.

Referenced by getWeekstart().

FREQ_DAILY

const ilCalendarRecurrence::FREQ_DAILY = 'DAILY'

Definition at line 34 of file class.ilCalendarRecurrence.php.

Referenced by ilCalendarRecurrenceCalculator\applyBYDAYRules(), ilCalendarRecurrenceCalculator\applyBYMONTHDAYRules(), ilCalendarRecurrenceCalculator\applyBYYEARDAYRules(), ilCalendarChangedAppointmentsTableGUI\fillRow(), ilCalendarAppointmentsTableGUI\fillRow(), ilCalendarRecurrenceCalculator\incrementByFrequency(), ilConsultationHoursGUI\initFormSequence(), ilRecurrenceInputGUI\insert(), ilRecurrenceInputGUI\loadRecurrence(), ilObjEmployeeTalkSeriesGUI\loadRecurrenceSettings(), ilEmployeeTalkAppointmentGUI\loadRecurrenceSettings(), and ilObjSessionGUI\loadRecurrenceSettings().

FREQ_MONTHLY

const ilCalendarRecurrence::FREQ_MONTHLY = 'MONTHLY'

Definition at line 36 of file class.ilCalendarRecurrence.php.

Referenced by ilCalendarRecurrenceCalculator\applyBYDAYRules(), ilCalendarRecurrenceCalculator\applyBYMONTHDAYRules(), ilCalendarRecurrenceCalculator\applyBYMONTHRules(), ilCalendarRecurrenceCalculator\applyBYWEEKNORules(), ilCalendarRecurrenceCalculator\applyBYYEARDAYRules(), ilCalendarChangedAppointmentsTableGUI\fillRow(), ilCalendarAppointmentsTableGUI\fillRow(), ilCalendarRecurrenceCalculator\incrementByFrequency(), ilConsultationHoursGUI\initFormSequence(), ilRecurrenceInputGUI\insert(), ilRecurrenceInputGUI\loadRecurrence(), ilObjEmployeeTalkSeriesGUI\loadRecurrenceSettings(), ilEmployeeTalkAppointmentGUI\loadRecurrenceSettings(), ilObjSessionGUI\loadRecurrenceSettings(), ilCalendarRecurrenceCalculationTest\testMonthly(), and ilCalendarRecurrenceCalculationTest\testMonthlyByDay().

FREQ_NONE

const ilCalendarRecurrence::FREQ_NONE = 'NONE'

Definition at line 33 of file class.ilCalendarRecurrence.php.

Referenced by ilRecurrenceInputGUI\checkInput(), and ilCalendarAppointmentGUI\saveRecurrenceSettings().

FREQ_WEEKLY

const ilCalendarRecurrence::FREQ_WEEKLY = 'WEEKLY'

Definition at line 35 of file class.ilCalendarRecurrence.php.

Referenced by ilCalendarRecurrenceCalculator\applyBYDAYRules(), ilCalendarRecurrenceCalculator\applyBYMONTHDAYRules(), ilCalendarRecurrenceCalculator\applyBYWEEKNORules(), ilCalendarRecurrenceCalculator\applyBYYEARDAYRules(), ilCalendarChangedAppointmentsTableGUI\fillRow(), ilCalendarAppointmentsTableGUI\fillRow(), ilCalendarRecurrenceCalculator\incrementByFrequency(), ilConsultationHoursGUI\initFormSequence(), ilRecurrenceInputGUI\insert(), ilRecurrenceInputGUI\loadRecurrence(), ilObjEmployeeTalkSeriesGUI\loadRecurrenceSettings(), ilEmployeeTalkAppointmentGUI\loadRecurrenceSettings(), and ilObjSessionGUI\loadRecurrenceSettings().

FREQ_YEARLY

const ilCalendarRecurrence::FREQ_YEARLY = 'YEARLY'

Definition at line 37 of file class.ilCalendarRecurrence.php.

Referenced by ilCalendarRecurrenceCalculator\applyBYDAYRules(), ilCalendarRecurrenceCalculator\applyBYMONTHDAYRules(), ilCalendarRecurrenceCalculator\applyBYMONTHRules(), ilCalendarRecurrenceCalculator\applyBYWEEKNORules(), ilCalendarRecurrenceCalculator\applyBYYEARDAYRules(), ilCalendarChangedAppointmentsTableGUI\fillRow(), ilCalendarAppointmentsTableGUI\fillRow(), ilCalendarRecurrenceCalculator\incrementByFrequency(), ilRecurrenceInputGUI\insert(), ilRecurrenceInputGUI\loadRecurrence(), ilObjEmployeeTalkSeriesGUI\loadRecurrenceSettings(), ilEmployeeTalkAppointmentGUI\loadRecurrenceSettings(), ilObjSessionGUI\loadRecurrenceSettings(), and ilCalendarRecurrenceCalculationTest\testYearly().

REC_EXCLUSION

const ilCalendarRecurrence::REC_EXCLUSION = 1

protected

Definition at line 31 of file class.ilCalendarRecurrence.php.

REC_RECURRENCE

const ilCalendarRecurrence::REC_RECURRENCE = 0

protected

Definition at line 30 of file class.ilCalendarRecurrence.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/Calendar/classes/class.ilCalendarRecurrence.php