Stores exclusion dates for calendar recurrences. More...

Collaboration diagram for ilCalendarRecurrenceExclusion:

Public Member Functions
	__construct ($a_exclusion_id=0)
	Constructor. More...

	getId ()
	Get exclusion id. More...

	getEntryId ()
	Get calendar entry id. More...

	setEntryId ($a_id)
	Set entry id (id of calendar appointment) More...

	getDate ()
	Get exclusion date. More...

	setDate (ilDate $dt=null)
	Set exclusion date. More...

	toICal ()
	Exclusion date to ical format. More...

	save ()
	Save exclusion date to db. More...

Protected Member Functions
	read ()
	Read exclusion. More...

Protected Attributes
	$exclusion = null

	$cal_id = 0

	$exclusion_id = 0

	$db = null

Detailed Description

Stores exclusion dates for calendar recurrences.

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

Version: $Id$

Definition at line 38 of file class.ilCalendarRecurrenceExclusion.php.

Constructor & Destructor Documentation

◆ __construct()

ilCalendarRecurrenceExclusion::__construct ( $a_exclusion_id = 0 )

Constructor.

Returns

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $this->db = $ilDB;
        $this->exclusion_id = $a_exclusion_id;
        
        if ($this->getId()) {
            $this->read();
        }
    }

References $DIC, $ilDB, getId(), and read().

Here is the call graph for this function:

Member Function Documentation

◆ getDate()

ilCalendarRecurrenceExclusion::getDate ( )

Get exclusion date.

Returns

Definition at line 97 of file class.ilCalendarRecurrenceExclusion.php.

    {
        return $this->exclusion instanceof ilDate ? $this->exclusion : null;
    }

Referenced by save(), and toICal().

Here is the caller graph for this function:

◆ getEntryId()

ilCalendarRecurrenceExclusion::getEntryId ( )

Get calendar entry id.

Returns

Definition at line 78 of file class.ilCalendarRecurrenceExclusion.php.

    {
        return $this->cal_id;
    }

References $cal_id.

Referenced by save(), and toICal().

Here is the caller graph for this function:

◆ getId()

ilCalendarRecurrenceExclusion::getId ( )

Get exclusion id.

Returns

Definition at line 69 of file class.ilCalendarRecurrenceExclusion.php.

    {
        return $this->exclusion_id;
    }

References $exclusion_id.

Referenced by __construct(), read(), and save().

Here is the caller graph for this function:

◆ read()

ilCalendarRecurrenceExclusion::read ( )

protected

Read exclusion.

Returns

Definition at line 160 of file class.ilCalendarRecurrenceExclusion.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT * FROM cal_rec_exclusion WHERE excl_id = " . $ilDB->quote($this->getId(), 'integer');
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->cal_id = $row->cal_id;
            $this->setDate(new ilDate($row->excl_date, IL_CAL_DATE, 'UTC'));
        }
    }

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, getId(), IL_CAL_DATE, and setDate().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilCalendarRecurrenceExclusion::save ( )

Save exclusion date to db.

Returns

Definition at line 134 of file class.ilCalendarRecurrenceExclusion.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        if (!$this->getDate()) {
            return false;
        }
        
        $query = "INSERT INTO cal_rec_exclusion (excl_id,cal_id,excl_date) " .
            "VALUES( " .
            $ilDB->quote($next_id = $ilDB->nextId('cal_rec_exclusion'), 'integer') . ', ' .
            $ilDB->quote($this->getEntryId(), 'integer') . ', ' .
            $ilDB->quote($this->getDate()->get(IL_CAL_DATE, '', 'UTC'), 'timestamp') .
            ')';
        $ilDB->manipulate($query);
        
        $this->exclusion_id = $next_id;
        return $this->getId();
    }

References $DIC, $ilDB, $query, getDate(), getEntryId(), getId(), and IL_CAL_DATE.

Here is the call graph for this function:

◆ setDate()

ilCalendarRecurrenceExclusion::setDate ( ilDate $dt = null )

Set exclusion date.

Parameters

ilDate $dt [optional]

Returns

Definition at line 107 of file class.ilCalendarRecurrenceExclusion.php.

    {
        $this->exclusion = $dt;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setEntryId()

ilCalendarRecurrenceExclusion::setEntryId ( $a_id )

Set entry id (id of calendar appointment)

Parameters

object $a_id

Returns

Definition at line 88 of file class.ilCalendarRecurrenceExclusion.php.

    {
        $this->cal_id = $a_id;
    }

◆ toICal()

ilCalendarRecurrenceExclusion::toICal ( )

Exclusion date to ical format.

Returns

Definition at line 116 of file class.ilCalendarRecurrenceExclusion.php.

    {
        $entry = new ilCalendarEntry($this->getEntryId());
        $start = $entry->getStart();
 
        if ($entry->isFullday()) {
            return 'EXDATE;VALUE=DATE:' . $this->getDate()->get(IL_CAL_FKT_DATE, 'Ymd');
        } else {
            return 'EXDATE:' .
                $this->getDate()->get(IL_CAL_FKT_DATE, 'Ymd', ilTimeZone::UTC) .
                'T' . $start->get(IL_CAL_FKT_DATE, 'His', ilTimeZone::UTC) . 'Z';
        }
    }