This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilCalendarEntry:

Collaboration diagram for ilCalendarEntry:

Public Member Functions
	__construct (int $a_id=0)

	__clone ()
	clone instance More...

	setContextInfo (string $a_info)

	getContextInfo ()

	getEntryId ()

	getLastUpdate ()

	setLastUpdate (ilDateTime $a_date)

	getStart ()
	Get start of date period. More...

	setStart (?ilDateTime $a_start)

	getEnd ()
	Get end of period. More...

	setEnd (?ilDateTime $a_end)

	setTitle (string $a_title)

	getTitle ()

	getPresentationTitle (bool $a_shorten=true)

	getPresentationStyle ()

	setSubtitle (string $a_subtitle)
	set subtitle Used for automatic generated appointments. More...

	getSubtitle ()

	setDescription (string $a_description)

	getDescription ()

	setLocation (string $a_location)

	getLocation ()

	setFurtherInformations (string $a_informations)

	getFurtherInformations ()

	setFullday (bool $a_fullday)
	set fullday event Fullday events do not change their time in different timezones. More...

	isFullday ()
	is event a fullday period More...

	isAutoGenerated ()

	setAutoGenerated (bool $a_status)

	isMilestone ()

	setMilestone (bool $a_status)

	setCompletion (int $a_completion)

	getCompletion ()

	setContextId (int $a_context_id)

	getContextId ()

	setTranslationType (int $a_type)

	getTranslationType ()

	enableNotification (bool $a_status)

	isNotificationEnabled ()

	update ()

	save ()

	delete ()

	validate ()

	appointmentToMailString (ilLanguage $lng)

	writeResponsibleUsers (array $a_users)

	readResponsibleUsers ()

	getStart ()
	Get start of date period. More...

	getEnd ()
	Get end of period. More...

	isFullday ()
	is event a fullday period More...

Static Public Member Functions
static	_delete (int $a_entry_id)

Data Fields
const	TRANSLATION_NONE = 0

const	TRANSLATION_SYSTEM = 1

Protected Member Functions
	parseDynamicTitle (string $a_type)

	read ()

Protected Attributes
ilLogger	$log

ilDBInterface	$db

ilLanguage	$lng

ilErrorHandling	$error

int	$entry_id = 0

ilDateTime	$last_update = null

string	$title = ''

string	$presentation_style = ''

string	$subtitle = ''

string	$description = ''

string	$location = ''

string	$further_informations = ''

ilDateTime	$start = null

bool	$fullday = false

ilDateTime	$end = null

bool	$is_auto_generated = false

int	$context_id = 0

string	$context_info = ''

int	$translation_type = ilCalendarEntry::TRANSLATION_NONE

bool	$is_milestone = false

int	$completion = 0

bool	$notification = false

array	$responsible_users = []

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Model for a calendar entry.

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

Version: $Id$

Definition at line 27 of file class.ilCalendarEntry.php.

Constructor & Destructor Documentation

◆ __construct()

ilCalendarEntry::__construct ( int $a_id = 0 )

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

    {
        global $DIC;
 
        $this->log = $DIC->logger()->cal();
        $this->lng = $DIC->language();
        $this->db = $DIC->database();
        $this->error = $DIC['ilErr'];
        $this->entry_id = $a_id;
        if ($this->entry_id > 0) {
            $this->read();
        }
    }

References $DIC, error(), ILIAS\Repository\lng(), and read().

Here is the call graph for this function:

Member Function Documentation

◆ __clone()

ilCalendarEntry::__clone ( )

clone instance

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

    {
        $this->entry_id = 0;
    }

◆ _delete()

static ilCalendarEntry::_delete ( int $a_entry_id )

static

Definition at line 79 of file class.ilCalendarEntry.php.

                                                   : void
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        ilCalendarRecurrence::_delete($a_entry_id);
 
        $query = "DELETE FROM cal_entries " .
            "WHERE cal_id = " . $ilDB->quote($a_entry_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
    }

References $DIC, $ilDB, $query, $res, and ilCalendarRecurrence\_delete().

Referenced by ilCalendarCategory\delete(), ilCalendarAppEventListener\deleteAppointments(), and ilCalendarRemoteReader\importIcal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appointmentToMailString()

ilCalendarEntry::appointmentToMailString ( ilLanguage $lng )

Definition at line 465 of file class.ilCalendarEntry.php.

                                                            : string
    {
        $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;
    }

References $lng, ilDatePresentation\formatPeriod(), getDescription(), getEnd(), getLocation(), getStart(), getTitle(), ilDatePresentation\setUseRelativeDates(), and ilLanguage\txt().

Here is the call graph for this function:

◆ delete()

ilCalendarEntry::delete ( )

Definition at line 407 of file class.ilCalendarEntry.php.

                            : void
    {
        ilCalendarRecurrence::_delete($this->getEntryId());
 
        $query = "DELETE FROM cal_entries " .
            "WHERE cal_id = " . $this->db->quote($this->getEntryId(), 'integer') . " ";
        $res = $this->db->manipulate($query);
 
        ilCalendarCategoryAssignments::_deleteByAppointmentId($this->getEntryId());
    }

References $query, $res, ilCalendarRecurrence\_delete(), ilCalendarCategoryAssignments\_deleteByAppointmentId(), and getEntryId().

Here is the call graph for this function:

◆ enableNotification()

ilCalendarEntry::enableNotification ( bool $a_status )

Definition at line 340 of file class.ilCalendarEntry.php.

                                                      : void
    {
        $this->notification = $a_status;
    }

References ILIAS\UI\examples\Symbol\Glyph\Notification\notification().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCompletion()

ilCalendarEntry::getCompletion ( )

Definition at line 315 of file class.ilCalendarEntry.php.

                                   : int
    {
        return $this->completion;
    }

References $completion.

Referenced by save(), and update().

Here is the caller graph for this function:

◆ getContextId()

ilCalendarEntry::getContextId ( )

Definition at line 325 of file class.ilCalendarEntry.php.

                                  : int
    {
        return $this->context_id;
    }

References $context_id.

Referenced by ilCalendarScheduleFilterTimings\modifyEvent(), ilCalendarScheduleFilterBookings\modifyEvent(), ilCalendarScheduleFilterConsultationHourInRepository\modifyEvent(), ilCalendarScheduleFilterExercise\modifyEvent(), parseDynamicTitle(), save(), and update().

Here is the caller graph for this function:

◆ getContextInfo()

ilCalendarEntry::getContextInfo ( )

Definition at line 96 of file class.ilCalendarEntry.php.

                                    : string
    {
        return $this->context_info;
    }

References $context_info.

Referenced by ilCalendarScheduleFilterTimings\modifyEvent(), save(), and update().

Here is the caller graph for this function:

◆ getDescription()

ilCalendarEntry::getDescription ( )

Definition at line 250 of file class.ilCalendarEntry.php.

                                    : string
    {
        return $this->description;
    }

References $description.

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

Here is the caller graph for this function:

◆ getEnd()

ilCalendarEntry::getEnd ( )

Get end of period.

Implements ilDatePeriod.

Definition at line 126 of file class.ilCalendarEntry.php.

                            : ?ilDateTime
    {
        return $this->end;
    }

References $end.

Referenced by appointmentToMailString(), ilCalendarScheduleFilterBookingPool\modifyEvent(), save(), update(), and validate().

Here is the caller graph for this function:

◆ getEntryId()

ilCalendarEntry::getEntryId ( )

Definition at line 101 of file class.ilCalendarEntry.php.

                                : int
    {
        return $this->entry_id;
    }

References $entry_id.

Referenced by ilCalendarExport\buildAppointmentUrl(), ilCalendarAppointmentGUI\calendarEntryToCategory(), ilCalendarExport\createVEVENT(), delete(), ilCalendarExport\isRepeatingAppointment(), ilCalendarScheduleFilterTimings\modifyEvent(), ilCalendarScheduleFilterBookings\modifyEvent(), ilCalendarScheduleFilterConsultationHourInRepository\modifyEvent(), ilCalendarScheduleFilterExercise\modifyEvent(), ilCalendarScheduleFilterHidden\modifyEvent(), ilCalendarScheduleFilterBookingPool\modifyEvent(), parseDynamicTitle(), read(), readResponsibleUsers(), update(), and writeResponsibleUsers().

Here is the caller graph for this function:

◆ getFurtherInformations()

ilCalendarEntry::getFurtherInformations ( )

Definition at line 270 of file class.ilCalendarEntry.php.

                                            : string
    {
        return $this->further_informations;
    }

References $further_informations.

Referenced by save(), and update().

Here is the caller graph for this function:

◆ getLastUpdate()

ilCalendarEntry::getLastUpdate ( )

Definition at line 106 of file class.ilCalendarEntry.php.

                                   : ilDateTime
    {
        return $this->last_update ?: new ilDateTime(time(), IL_CAL_UNIX);
    }

References IL_CAL_UNIX.

◆ getLocation()

ilCalendarEntry::getLocation ( )

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

                                 : string
    {
        return $this->location;
    }

References $location.

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

Here is the caller graph for this function:

◆ getPresentationStyle()

ilCalendarEntry::getPresentationStyle ( )

Definition at line 225 of file class.ilCalendarEntry.php.

                                          : string
    {
        return $this->presentation_style;
    }

References $presentation_style.

◆ getPresentationTitle()

ilCalendarEntry::getPresentationTitle ( bool $a_shorten = true )

Definition at line 146 of file class.ilCalendarEntry.php.

                                                                : string
    {
        if ($this->getTranslationType() == ilCalendarEntry::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 = $this->lng->txt($this->getSubtitle());
            }
            $title = $this->getTitle() .
                (strlen($subtitle)
                    ? ' (' . $subtitle . ')'
                    : '');
        } else {
            $title = $this->lng->txt($this->getTitle());
        }
 
        if ($a_shorten) {
            return ilStr::shortenTextExtended(ilStr::shortenWords($title, 20), 40, true);
        }
        return $title;
    }

References $subtitle, $title, getSubtitle(), getTitle(), getTranslationType(), ILIAS\Repository\lng(), parseDynamicTitle(), ilStr\shortenTextExtended(), ilStr\shortenWords(), and TRANSLATION_NONE.

Referenced by ilCalendarScheduleFilterTimings\modifyEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStart()

ilCalendarEntry::getStart ( )

Get start of date period.

Implements ilDatePeriod.

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

                              : ?ilDateTime
    {
        return $this->start;
    }

References $start.

Referenced by appointmentToMailString(), ilCalendarWeekGUI\getAppointmentTimeString(), ilCalendarAgendaListGUI\getPluginAgendaItem(), save(), update(), and validate().

Here is the caller graph for this function:

◆ getSubtitle()

ilCalendarEntry::getSubtitle ( )

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

                                 : string
    {
        return $this->subtitle;
    }

References $subtitle.

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

Here is the caller graph for this function:

◆ getTitle()

ilCalendarEntry::getTitle ( )

Definition at line 141 of file class.ilCalendarEntry.php.

                              : string
    {
        return $this->title;
    }

References $title.

Referenced by appointmentToMailString(), getPresentationTitle(), ilCalendarScheduleFilterTimings\modifyEvent(), save(), update(), and validate().

Here is the caller graph for this function:

◆ getTranslationType()

ilCalendarEntry::getTranslationType ( )

Definition at line 335 of file class.ilCalendarEntry.php.

                                        : int
    {
        return $this->translation_type;
    }

References $translation_type.

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

Here is the caller graph for this function:

◆ isAutoGenerated()

ilCalendarEntry::isAutoGenerated ( )

Definition at line 290 of file class.ilCalendarEntry.php.

                                     : bool
    {
        return $this->is_auto_generated;
    }

References $is_auto_generated.

Referenced by ilCalendarScheduleFilterTimings\modifyEvent(), save(), and update().

Here is the caller graph for this function:

◆ isFullday()

ilCalendarEntry::isFullday ( )

is event a fullday period

Implements ilDatePeriod.

Definition at line 285 of file class.ilCalendarEntry.php.

                               : bool
    {
        return $this->fullday;
    }

References $fullday.

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

Here is the caller graph for this function:

◆ isMilestone()

ilCalendarEntry::isMilestone ( )

Definition at line 300 of file class.ilCalendarEntry.php.

                                 : bool
    {
        return $this->is_milestone;
    }

References $is_milestone.

Referenced by ilCalendarExport\createAppointment(), save(), and update().

Here is the caller graph for this function:

◆ isNotificationEnabled()

ilCalendarEntry::isNotificationEnabled ( )

Definition at line 345 of file class.ilCalendarEntry.php.

                                           : bool
    {
        return $this->notification;
    }

References $notification.

Referenced by save(), and update().

Here is the caller graph for this function:

◆ parseDynamicTitle()

ilCalendarEntry::parseDynamicTitle ( string $a_type )

protected

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

                                                        : string
    {
        $title = $style = "";
        switch ($a_type) {
            case "consultationhour":
                $entry = new ilBookingEntry($this->getContextId());
                if ($entry) {
                    if ($entry->isOwner()) {
                        $max = $entry->getNumberOfBookings();
                        $current = $entry->getCurrentNumberOfBookings($this->getEntryId());
                        if (!$current) {
                            $style = ';border-left-width: 5px; border-left-style: solid; border-left-color: green';
                            $title = $this->lng->txt('cal_book_free');
                        } elseif ($current >= $max) {
                            $style = ';border-left-width: 5px; border-left-style: solid; border-left-color: red';
                            $title = $this->lng->txt('cal_booked_out');
                        } else {
                            $style = ';border-left-width: 5px; border-left-style: solid; border-left-color: yellow';
                            $title = $current . '/' . $max;
                        }
                    } else {
                        $apps = ilConsultationHourAppointments::getAppointmentIds(
                            $entry->getObjId(),
                            $this->getContextId(),
                            $this->getStart()
                        );
                        if ($apps === []) {
                            $style = ';border-left-width: 5px; border-left-style: solid; border-left-color: red';
                            $title = $this->lng->txt('cal_booked_out');
                        } else {
                            $orig_event = $apps[0];
                            $max = $entry->getNumberOfBookings();
                            $current = $entry->getCurrentNumberOfBookings($this->getEntryId());
                            if ($entry->hasBooked($orig_event)) {
                                $title = $this->lng->txt('cal_date_booked');
                            } elseif ($current >= $max) {
                                $style = ';border-left-width: 5px; border-left-style: solid; border-left-color: red';
                                $title = $this->lng->txt('cal_booked_out');
                            } else {
                                $style = ';border-left-width: 5px; border-left-style: solid; border-left-color: green';
                                $title = $this->lng->txt('cal_book_free');
                            }
                        }
                    }
                }
                break;
        }
        if (strlen($style)) {
            $this->presentation_style = $style;
        }
 
        return $title;
    }

References $title, ilConsultationHourAppointments\getAppointmentIds(), getContextId(), getEntryId(), and ILIAS\Repository\lng().

Referenced by getPresentationTitle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilCalendarEntry::read ( )

protected

Definition at line 435 of file class.ilCalendarEntry.php.

                             : void
    {
        $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((string) $row->last_update, IL_CAL_DATETIME, 'UTC'));
            $this->setTitle((string) $row->title);
            $this->setSubtitle((string) $row->subtitle);
            $this->setDescription((string) $row->description);
            $this->setLocation((string) $row->location);
            $this->setFurtherInformations((string) $row->informations);
            $this->setFullday((bool) $row->fullday);
            $this->setAutoGenerated((bool) $row->auto_generated);
            $this->setContextId((int) $row->context_id);
            $this->setContextInfo((string) $row->context_info);
            $this->setTranslationType((int) $row->translation_type);
            $this->setCompletion((int) $row->completion);
            $this->setMilestone((bool) $row->is_milestone);
            $this->enableNotification((bool) $row->notification);
 
            if ($this->isFullday()) {
                $this->start = new ilDate((string) $row->starta, IL_CAL_DATETIME);
                $this->end = new ilDate((string) $row->enda, IL_CAL_DATETIME);
            } else {
                $this->start = new ilDateTime((string) $row->starta, IL_CAL_DATETIME, 'UTC');
                $this->end = new ilDateTime((string) $row->enda, IL_CAL_DATETIME, 'UTC');
            }
        }
    }

References $query, $res, enableNotification(), ilDBConstants\FETCHMODE_OBJECT, getEntryId(), IL_CAL_DATETIME, isFullday(), setAutoGenerated(), setCompletion(), setContextId(), setContextInfo(), setDescription(), setFullday(), setFurtherInformations(), setLastUpdate(), setLocation(), setMilestone(), setSubtitle(), setTitle(), and setTranslationType().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readResponsibleUsers()

ilCalendarEntry::readResponsibleUsers ( )

Definition at line 507 of file class.ilCalendarEntry.php.

                                          : array
    {
        $set = $this->db->queryF(
            "SELECT * FROM cal_entry_responsible WHERE cal_id = %s",
            array("integer"),
            array($this->getEntryId())
        );
 
        $return = array();
        while ($rec = $this->db->fetchAssoc($set)) {
            $n = ilObjUser::_lookupName((int) $rec["user_id"]);
            $return[] = array_merge(
                $n,
                array("login" => ilObjUser::_lookupLogin((int) $rec["user_id"]))
            );
        }
        return $return;
    }

References ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), and getEntryId().

Here is the call graph for this function:

◆ save()

ilCalendarEntry::save ( )

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

                          : void
    {
        $next_id = $this->db->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,context_info,translation_type, completion, is_milestone, notification) " .
            "VALUES( " .
            $this->db->quote($next_id, 'integer') . ", " .
            $this->db->quote($this->getTitle(), 'text') . ", " .
            $this->db->quote($utc_timestamp, 'timestamp') . ", " .
            $this->db->quote($this->getSubtitle(), 'text') . ", " .
            $this->db->quote($this->getDescription(), 'text') . ", " .
            $this->db->quote($this->getLocation(), 'text') . ", " .
            $this->db->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->getContextInfo(), 'text') . ', ' .
            $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 = $this->db->manipulate($query);
 
        $this->entry_id = $next_id;
    }

References $query, $res, getCompletion(), getContextId(), getContextInfo(), getDescription(), getEnd(), getFurtherInformations(), getLocation(), getStart(), getSubtitle(), getTitle(), getTranslationType(), IL_CAL_DATETIME, IL_CAL_UNIX, isAutoGenerated(), isFullday(), isMilestone(), isNotificationEnabled(), and ilTimeZone\UTC.

Here is the call graph for this function:

◆ setAutoGenerated()

ilCalendarEntry::setAutoGenerated ( bool $a_status )

Definition at line 295 of file class.ilCalendarEntry.php.

                                                    : void
    {
        $this->is_auto_generated = $a_status;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setCompletion()

ilCalendarEntry::setCompletion ( int $a_completion )

Definition at line 310 of file class.ilCalendarEntry.php.

                                                    : void
    {
        $this->completion = $a_completion;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setContextId()

ilCalendarEntry::setContextId ( int $a_context_id )

Definition at line 320 of file class.ilCalendarEntry.php.

                                                   : void
    {
        $this->context_id = $a_context_id;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setContextInfo()

ilCalendarEntry::setContextInfo ( string $a_info )

Definition at line 91 of file class.ilCalendarEntry.php.

                                                  : void
    {
        $this->context_info = $a_info;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setDescription()

ilCalendarEntry::setDescription ( string $a_description )

Definition at line 245 of file class.ilCalendarEntry.php.

                                                         : void
    {
        $this->description = $a_description;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setEnd()

ilCalendarEntry::setEnd ( ?ilDateTime $a_end )

Definition at line 131 of file class.ilCalendarEntry.php.

                                              : void
    {
        $this->end = $a_end;
    }

Referenced by ilCalendarScheduleFilterBookingPool\modifyEvent().

Here is the caller graph for this function:

◆ setFullday()

ilCalendarEntry::setFullday ( bool $a_fullday )

set fullday event Fullday events do not change their time in different timezones.

It is possible to create fullday events with a duration of more than one day.

Definition at line 280 of file class.ilCalendarEntry.php.

                                               : void
    {
        $this->fullday = $a_fullday;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setFurtherInformations()

ilCalendarEntry::setFurtherInformations ( string $a_informations )

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

                                                                  : void
    {
        $this->further_informations = $a_informations;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setLastUpdate()

ilCalendarEntry::setLastUpdate ( ilDateTime $a_date )

Definition at line 111 of file class.ilCalendarEntry.php.

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

Referenced by read().

Here is the caller graph for this function:

◆ setLocation()

ilCalendarEntry::setLocation ( string $a_location )

Definition at line 255 of file class.ilCalendarEntry.php.

                                                   : void
    {
        $this->location = $a_location;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setMilestone()

ilCalendarEntry::setMilestone ( bool $a_status )

Definition at line 305 of file class.ilCalendarEntry.php.

                                                : void
    {
        $this->is_milestone = $a_status;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setStart()

ilCalendarEntry::setStart ( ?ilDateTime $a_start )

Definition at line 121 of file class.ilCalendarEntry.php.

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

◆ setSubtitle()

ilCalendarEntry::setSubtitle ( string $a_subtitle )

set subtitle Used for automatic generated appointments.

Will be appended to the title.

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

                                                   : void
    {
        $this->subtitle = $a_subtitle;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setTitle()

ilCalendarEntry::setTitle ( string $a_title )

Definition at line 136 of file class.ilCalendarEntry.php.

                                             : void
    {
        $this->title = $a_title;
    }

Referenced by ilCalendarScheduleFilterTimings\modifyEvent(), and read().

Here is the caller graph for this function:

◆ setTranslationType()

ilCalendarEntry::setTranslationType ( int $a_type )

Definition at line 330 of file class.ilCalendarEntry.php.

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

Referenced by read().

Here is the caller graph for this function:

◆ update()

ilCalendarEntry::update ( )

Definition at line 350 of file class.ilCalendarEntry.php.

                            : void
    {
        $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 = " . $this->db->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 = " . $this->db->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') . ", " .
            'context_info = ' . $this->db->quote($this->getContextInfo(), 'text') . ', ' .
            "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 = $this->db->manipulate($query);
    }

References $query, $res, getCompletion(), getContextId(), getContextInfo(), getDescription(), getEnd(), getEntryId(), getFurtherInformations(), getLocation(), getStart(), getSubtitle(), getTitle(), getTranslationType(), IL_CAL_DATETIME, IL_CAL_UNIX, isAutoGenerated(), isFullday(), isMilestone(), isNotificationEnabled(), and ilTimeZone\UTC.

Here is the call graph for this function:

◆ validate()

ilCalendarEntry::validate ( )

Definition at line 418 of file class.ilCalendarEntry.php.

                              : bool
    {
        $success = true;
        $this->error->setMessage('');
        if (!strlen($this->getTitle())) {
            $success = false;
            $this->error->appendMessage($this->lng->txt('err_missing_title'));
        }
        if (!$this->getStart() || !$this->getEnd()) {
            $success = false;
        } elseif (ilDateTime::_before($this->getEnd(), $this->getStart(), '')) {
            $success = false;
            $this->error->appendMessage($this->lng->txt('err_end_before_start'));
        }
        return $success;
    }

References ilDateTime\_before(), error(), getEnd(), getStart(), getTitle(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ writeResponsibleUsers()

ilCalendarEntry::writeResponsibleUsers ( array $a_users )

Definition at line 485 of file class.ilCalendarEntry.php.

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

References getEntryId().

Here is the call graph for this function:

Field Documentation

◆ $completion

int ilCalendarEntry::$completion = 0

protected

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

Referenced by getCompletion().

◆ $context_id

int ilCalendarEntry::$context_id = 0

protected

Definition at line 49 of file class.ilCalendarEntry.php.

Referenced by getContextId().

◆ $context_info

string ilCalendarEntry::$context_info = ''

protected

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

Referenced by getContextInfo().

◆ $db

ilDBInterface ilCalendarEntry::$db

protected

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

◆ $description

string ilCalendarEntry::$description = ''

protected

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

Referenced by getDescription().

◆ $end

ilDateTime ilCalendarEntry::$end = null

protected

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

Referenced by getEnd().

◆ $entry_id

int ilCalendarEntry::$entry_id = 0

protected

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

Referenced by getEntryId().

◆ $error

ilErrorHandling ilCalendarEntry::$error

protected

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

◆ $fullday

bool ilCalendarEntry::$fullday = false

protected

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

Referenced by isFullday().

◆ $further_informations

string ilCalendarEntry::$further_informations = ''

protected

Definition at line 44 of file class.ilCalendarEntry.php.

Referenced by getFurtherInformations().

◆ $is_auto_generated

bool ilCalendarEntry::$is_auto_generated = false

protected

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

Referenced by isAutoGenerated().

◆ $is_milestone

bool ilCalendarEntry::$is_milestone = false

protected

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

Referenced by isMilestone().

◆ $last_update

ilDateTime ilCalendarEntry::$last_update = null

protected

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

◆ $lng

ilLanguage ilCalendarEntry::$lng

protected

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

Referenced by appointmentToMailString().

◆ $location

string ilCalendarEntry::$location = ''

protected

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

Referenced by getLocation().

◆ $log

ilLogger ilCalendarEntry::$log

protected

Definition at line 32 of file class.ilCalendarEntry.php.

◆ $notification

bool ilCalendarEntry::$notification = false

protected

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

Referenced by isNotificationEnabled().

◆ $presentation_style

string ilCalendarEntry::$presentation_style = ''

protected

Definition at line 40 of file class.ilCalendarEntry.php.

Referenced by getPresentationStyle().

◆ $responsible_users

array ilCalendarEntry::$responsible_users = []

protected

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

◆ $start

ilDateTime ilCalendarEntry::$start = null

protected

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

Referenced by getStart().

◆ $subtitle

string ilCalendarEntry::$subtitle = ''

protected

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

Referenced by getPresentationTitle(), and getSubtitle().

◆ $title

string ilCalendarEntry::$title = ''

protected

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

Referenced by getPresentationTitle(), getTitle(), and parseDynamicTitle().

◆ $translation_type

int ilCalendarEntry::$translation_type = ilCalendarEntry::TRANSLATION_NONE

protected

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

Referenced by getTranslationType().

◆ TRANSLATION_NONE

const ilCalendarEntry::TRANSLATION_NONE = 0

Definition at line 29 of file class.ilCalendarEntry.php.

Referenced by getPresentationTitle(), and ilObjSession\prepareCalendarAppointments().

◆ TRANSLATION_SYSTEM

const ilCalendarEntry::TRANSLATION_SYSTEM = 1

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

Referenced by ilConsultationHoursGUI\createAppointments(), ilObjGroup\prepareAppointments(), and ilObjCourse\prepareAppointments().

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

Services/Calendar/classes/class.ilCalendarEntry.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ _delete()

◆ appointmentToMailString()

◆ delete()

◆ enableNotification()

◆ getCompletion()

◆ getContextId()

◆ getContextInfo()

◆ getDescription()

◆ getEnd()

◆ getEntryId()

◆ getFurtherInformations()

◆ getLastUpdate()

◆ getLocation()

◆ getPresentationStyle()

◆ getPresentationTitle()

◆ getStart()

◆ getSubtitle()

◆ getTitle()

◆ getTranslationType()

◆ isAutoGenerated()

◆ isFullday()

◆ isMilestone()

◆ isNotificationEnabled()

◆ parseDynamicTitle()

◆ read()

◆ readResponsibleUsers()

◆ save()

◆ setAutoGenerated()

◆ setCompletion()

◆ setContextId()

◆ setContextInfo()

◆ setDescription()

◆ setEnd()

◆ setFullday()

◆ setFurtherInformations()

◆ setLastUpdate()

◆ setLocation()

◆ setMilestone()

◆ setStart()

◆ setSubtitle()

◆ setTitle()

◆ setTranslationType()

◆ update()

◆ validate()

◆ writeResponsibleUsers()

Field Documentation

◆ $completion

◆ $context_id

◆ $context_info

◆ $db

◆ $description

◆ $end

◆ $entry_id

◆ $error

◆ $fullday

◆ $further_informations

◆ $is_auto_generated

◆ $is_milestone

◆ $last_update

◆ $lng

◆ $location

◆ $log

◆ $notification

◆ $presentation_style

◆ $responsible_users

◆ $start

◆ $subtitle

◆ $title

◆ $translation_type

◆ TRANSLATION_NONE