Model for a calendar entry. More...

Inheritance diagram for ilCalendarEntry:

Collaboration diagram for ilCalendarEntry:

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

	__clone ()
	clone instance More...

	setContextInfo ($a_info)
	Set context info. More...

	getContextInfo ()

	getEntryId ()
	get entry id More...

	getLastUpdate ()
	get last update More...

	setLastUpdate ($a_date)
	set last update More...

	getStart ()
	get start More...

	setStart ($a_start)
	public More...

	getEnd ()
	get end public More...

	setEnd ($a_end)
	set end public More...

	setTitle ($a_title)
	set title More...

	getTitle ()
	get title More...

	getPresentationTitle ($a_shorten=true)
	get title for presentation. More...

	getPresentationStyle ()

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

	getSubtitle ()
	get subtitle More...

	setDescription ($a_description)
	set description More...

	getDescription ()
	get description More...

	setLocation ($a_location)
	set location More...

	getLocation ()
	get location More...

	setFurtherInformations ($a_informations)
	set further informations More...

	getFurtherInformations ()
	get further informations More...

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

	isFullday ()
	is fullday More...

	isAutoGenerated ()
	is auto generated More...

	setAutoGenerated ($a_status)
	set auto generated More...

	isMilestone ()
	is milestone More...

	setMilestone ($a_status)
	set milestone More...

	setCompletion ($a_completion)
	Set Completion. More...

	getCompletion ()
	Get Completion. More...

	setContextId ($a_context_id)
	set context id More...

	getContextId ()
	get context id More...

	setTranslationType ($a_type)
	public More...

	getTranslationType ()
	get translation type More...

	enableNotification ($a_status)
	Enable course group notification. More...

	isNotificationEnabled ()
	Check if course group notification is enabled. More...

	update ()
	update More...

	save ()
	save one entry More...

	delete ()
	delete More...

	validate ()
	validate More...

	appointmentToMailString ($lng)

	writeResponsibleUsers ($a_users)
	Write users responsible for a milestone. More...

	readResponsibleUsers ()
	Read responsible users. More...

Static Public Member Functions
static	_delete ($a_entry_id)
	delete entry More...

Protected Member Functions
	parseDynamicTitle ($a_type)

	read ()
	protected More...

Protected Attributes
	$log

	$db

	$entry_id

	$last_update

	$title

	$subtitle

	$description

	$location

	$further_informations

	$start = null

	$fullday

	$end = null

	$is_auto_generated = false

	$context_id = 0

	$context_info = ''

	$translation_type = IL_CAL_TRANSLATION_NONE

	$is_milestone = false

	$completion = 0

	$notification = false

Detailed Description

Model for a calendar entry.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilCalendarEntry::__construct ( $a_id = 0 )

Constructor.

public

Parameters

int	cal_entry id

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

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

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         $this->log = $DIC->logger()->cal();
         
         $this->db = $ilDB;
         
         if ($this->entry_id = $a_id) {
             $this->read();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ __clone()

ilCalendarEntry::__clone ( )

clone instance

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

     {
         $this->entry_id = null;
     }

◆ _delete()

static ilCalendarEntry::_delete ( $a_entry_id )

static

delete entry

public

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

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

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

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         
         include_once('./Services/Calendar/classes/class.ilCalendarRecurrence.php');
         ilCalendarRecurrence::_delete($a_entry_id);
         
         $query = "DELETE FROM cal_entries " .
             "WHERE cal_id = " . $ilDB->quote($a_entry_id, 'integer') . " ";
         $res = $ilDB->manipulate($query);
         
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appointmentToMailString()

ilCalendarEntry::appointmentToMailString ( $lng )

Parameters

ilLanguage $lng

Returns

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

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

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

Here is the call graph for this function:

◆ delete()

ilCalendarEntry::delete ( )

delete

public

Returns

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

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

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         
         include_once('./Services/Calendar/classes/class.ilCalendarRecurrence.php');
         ilCalendarRecurrence::_delete($this->getEntryId());
         
         $query = "DELETE FROM cal_entries " .
             "WHERE cal_id = " . $this->db->quote($this->getEntryId(), 'integer') . " ";
         $res = $ilDB->manipulate($query);
         
         include_once './Services/Calendar/classes/class.ilCalendarCategoryAssignments.php';
         ilCalendarCategoryAssignments::_deleteByAppointmentId($this->getEntryId());
         
         return true;
     }

Here is the call graph for this function:

◆ enableNotification()

ilCalendarEntry::enableNotification ( $a_status )

Enable course group notification.

Parameters

bool $a_status

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

References notification().

Referenced by read().

     {
         $this->notification = $a_status;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCompletion()

ilCalendarEntry::getCompletion ( )

Get Completion.

Returns: int Completion

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

References $completion.

Referenced by save(), and update().

     {
         return $this->completion;
     }

Here is the caller graph for this function:

◆ getContextId()

ilCalendarEntry::getContextId ( )

get context id

public

Returns

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

References $context_id.

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

     {
         return $this->context_id;
     }

Here is the caller graph for this function:

◆ getContextInfo()

ilCalendarEntry::getContextInfo ( )

Returns: string

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

References $context_info.

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

     {
         return $this->context_info;
     }

Here is the caller graph for this function:

◆ getDescription()

ilCalendarEntry::getDescription ( )

get description

public

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

References $description.

Referenced by appointmentToMailString(), ilCalendarExport\createVEVENT(), save(), and update().

     {
         return $this->description;
     }

Here is the caller graph for this function:

◆ getEnd()

ilCalendarEntry::getEnd ( )

get end public

Returns: ilDateTime end

Implements ilDatePeriod.

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

References $end.

Referenced by appointmentToMailString(), ilCalendarExport\createVEVENT(), ilCalendarWeekGUI\getAppointmentTimeString(), ilCalendarScheduleFilterBookingPool\modifyEvent(), save(), update(), and validate().

     {
         return $this->end;
     }

Here is the caller graph for this function:

◆ getEntryId()

ilCalendarEntry::getEntryId ( )

get entry id

public

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

References $entry_id.

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

     {
         return $this->entry_id;
     }

Here is the caller graph for this function:

◆ getFurtherInformations()

ilCalendarEntry::getFurtherInformations ( )

get further informations

public

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

References $further_informations.

Referenced by save(), and update().

     {
         return $this->further_informations;
     }

Here is the caller graph for this function:

◆ getLastUpdate()

ilCalendarEntry::getLastUpdate ( )

get last update

public

Parameters

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

References IL_CAL_UNIX.

Referenced by ilCalendarExport\createVEVENT().

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

Here is the caller graph for this function:

◆ getLocation()

ilCalendarEntry::getLocation ( )

get location

public

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

References $location.

Referenced by appointmentToMailString(), ilCalendarExport\createVEVENT(), save(), and update().

     {
         return $this->location;
     }

Here is the caller graph for this function:

◆ getPresentationStyle()

ilCalendarEntry::getPresentationStyle ( )

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

     {
         // see parseDynamicTitle()
         return $this->presentation_style;
     }

◆ getPresentationTitle()

ilCalendarEntry::getPresentationTitle ( $a_shorten = true )

get title for presentation.

Special handling for auto generated appointments

public

Returns

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

References $DIC, $lng, $subtitle, $title, getSubtitle(), getTitle(), getTranslationType(), IL_CAL_TRANSLATION_NONE, parseDynamicTitle(), ilUtil\shortenText(), and ilUtil\shortenWords().

Referenced by ilCalendarExport\createVEVENT(), and ilCalendarScheduleFilterTimings\modifyEvent().

     {
         global $DIC;
 
         $lng = $DIC['lng'];
         
         if ($this->getTranslationType() == IL_CAL_TRANSLATION_NONE) {
             $title = $this->getTitle();
         } elseif (strlen($this->getSubtitle())) {
             // parse dynamic title?
             if (preg_match("/#([a-z]+)#/", $this->getSubtitle(), $matches)) {
                 $subtitle = $this->parseDynamicTitle($matches[1]);
             } else {
                 $subtitle = $lng->txt($this->getSubtitle());
             }
             $title = $this->getTitle() .
                 (strlen($subtitle)
                 ? ' (' . $subtitle . ')'
                 : '');
         } else {
             $title = $lng->txt($this->getTitle());
         }
 
         if ($a_shorten) {
             return ilUtil::shortenText(ilUtil::shortenWords($title, 20), 40, true);
         }
         return $title;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStart()

ilCalendarEntry::getStart ( )

get start

public

Returns

Implements ilDatePeriod.

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

References $start.

Referenced by ilCalendarExport\addCategories(), appointmentToMailString(), ilCalendarExport\createVEVENT(), ilCalendarWeekGUI\getAppointmentTimeString(), parseDynamicTitle(), save(), update(), and validate().

     {
         return $this->start;
     }

Here is the caller graph for this function:

◆ getSubtitle()

ilCalendarEntry::getSubtitle ( )

get subtitle

public

Returns

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

References $subtitle.

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

     {
         return $this->subtitle;
     }

Here is the caller graph for this function:

◆ getTitle()

ilCalendarEntry::getTitle ( )

get title

public

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

References $title.

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

     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ getTranslationType()

ilCalendarEntry::getTranslationType ( )

get translation type

public

Returns: int translation type

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

References $translation_type.

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

     {
         return $this->translation_type;
     }

Here is the caller graph for this function:

◆ isAutoGenerated()

ilCalendarEntry::isAutoGenerated ( )

is auto generated

public

Parameters

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

References $is_auto_generated.

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

     {
         return (bool) $this->is_auto_generated;
     }

Here is the caller graph for this function:

◆ isFullday()

ilCalendarEntry::isFullday ( )

is fullday

public

Implements ilDatePeriod.

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

References $fullday.

Referenced by ilCalendarExport\createVEVENT(), read(), save(), and update().

     {
         return (bool) $this->fullday;
     }

Here is the caller graph for this function:

◆ isMilestone()

ilCalendarEntry::isMilestone ( )

is milestone

public

Parameters

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

References $is_milestone.

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

     {
         return (bool) $this->is_milestone;
     }

Here is the caller graph for this function:

◆ isNotificationEnabled()

ilCalendarEntry::isNotificationEnabled ( )

Check if course group notification is enabled.

Returns: bool

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

References $notification.

Referenced by save(), and update().

     {
         return (bool) $this->notification;
     }

Here is the caller graph for this function:

◆ parseDynamicTitle()

ilCalendarEntry::parseDynamicTitle ( $a_type )

protected

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

References $DIC, $lng, $title, ilConsultationHourAppointments\getAppointmentIds(), getContextId(), getEntryId(), and getStart().

Referenced by getPresentationTitle().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilCalendarEntry::read ( )

protected

Parameters

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

References $DIC, $ilDB, $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().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = "SELECT * FROM cal_entries WHERE cal_id = " . $this->db->quote($this->getEntryId(), 'integer') . " ";
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->setLastUpdate(new ilDateTime($row->last_update, IL_CAL_DATETIME, 'UTC'));
             $this->setTitle($row->title);
             $this->setSubtitle($row->subtitle);
             $this->setDescription($row->description);
             $this->setLocation($row->location);
             $this->setFurtherInformations($row->informations);
             $this->setFullday((bool) $row->fullday);
             $this->setAutoGenerated($row->auto_generated);
             $this->setContextId($row->context_id);
             $this->setContextInfo($row->context_info);
             $this->setTranslationType($row->translation_type);
             $this->setCompletion($row->completion);
             $this->setMilestone($row->is_milestone);
             $this->enableNotification((bool) $row->notification);
             
             if ($this->isFullday()) {
                 $this->start = new ilDate($row->starta, IL_CAL_DATETIME);
                 $this->end = new ilDate($row->enda, IL_CAL_DATETIME);
             } else {
                 $this->start = new ilDateTime($row->starta, IL_CAL_DATETIME, 'UTC');
                 $this->end = new ilDateTime($row->enda, IL_CAL_DATETIME, 'UTC');
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readResponsibleUsers()

ilCalendarEntry::readResponsibleUsers ( )

Read responsible users.

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

References $DIC, $ilDB, $n, ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), and getEntryId().

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

Here is the call graph for this function:

◆ save()

ilCalendarEntry::save ( )

save one entry

public

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

References $DIC, $ilDB, $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.

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $next_id = $ilDB->nextId('cal_entries');
         $now = new ilDateTime(time(), IL_CAL_UNIX);
         $utc_timestamp = $now->get(IL_CAL_DATETIME, '', ilTimeZone::UTC);
 
         $query = "INSERT INTO cal_entries (cal_id,title,last_update,subtitle,description,location,fullday,starta,enda, " .
             "informations,auto_generated,context_id,context_info,translation_type, completion, is_milestone, notification) " .
             "VALUES( " .
             $ilDB->quote($next_id, 'integer') . ", " .
             $this->db->quote($this->getTitle(), 'text') . ", " .
             $ilDB->quote($utc_timestamp, 'timestamp') . ", " .
             $this->db->quote($this->getSubtitle(), 'text') . ", " .
             $this->db->quote($this->getDescription(), 'text') . ", " .
             $this->db->quote($this->getLocation(), 'text') . ", " .
             $ilDB->quote($this->isFullday() ? 1 : 0, 'integer') . ", " .
             $this->db->quote($this->getStart()->get(IL_CAL_DATETIME, '', 'UTC'), 'timestamp') . ", " .
             $this->db->quote($this->getEnd()->get(IL_CAL_DATETIME, '', 'UTC'), 'timestamp') . ", " .
             $this->db->quote($this->getFurtherInformations(), 'text') . ", " .
             $this->db->quote($this->isAutoGenerated(), 'integer') . ", " .
             $this->db->quote($this->getContextId(), 'integer') . ", " .
             $this->db->quote($this->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 = $ilDB->manipulate($query);
         
         $this->entry_id = $next_id;
         return true;
     }

Here is the call graph for this function:

◆ setAutoGenerated()

ilCalendarEntry::setAutoGenerated ( $a_status )

set auto generated

public

Parameters

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

Referenced by read().

     {
         $this->is_auto_generated = $a_status;
     }

Here is the caller graph for this function:

◆ setCompletion()

ilCalendarEntry::setCompletion ( $a_completion )

Set Completion.

Parameters

int $a_completion Completion

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

Referenced by read().

     {
         $this->completion = $a_completion;
     }

Here is the caller graph for this function:

◆ setContextId()

ilCalendarEntry::setContextId ( $a_context_id )

set context id

public

Parameters

int	context id

Returns

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

Referenced by read().

     {
         $this->context_id = $a_context_id;
     }

Here is the caller graph for this function:

◆ setContextInfo()

ilCalendarEntry::setContextInfo ( $a_info )

Set context info.

Parameters

$a_info

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

Referenced by read().

     {
         $this->context_info = $a_info;
     }

Here is the caller graph for this function:

◆ setDescription()

ilCalendarEntry::setDescription ( $a_description )

set description

public

Parameters

string description

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

Referenced by read().

     {
         $this->description = $a_description;
     }

Here is the caller graph for this function:

◆ setEnd()

ilCalendarEntry::setEnd ( $a_end )

set end public

Parameters

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

Referenced by ilCalendarScheduleFilterBookingPool\modifyEvent().

     {
         $this->end = $a_end;
     }

Here is the caller graph for this function:

◆ setFullday()

ilCalendarEntry::setFullday ( $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.

public

Parameters

bool fullday

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

Referenced by read().

     {
         $this->fullday = (bool) $a_fullday;
     }

Here is the caller graph for this function:

◆ setFurtherInformations()

ilCalendarEntry::setFurtherInformations ( $a_informations )

set further informations

public

Parameters

string further informations

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

Referenced by read().

     {
         $this->further_informations = $a_informations;
     }

Here is the caller graph for this function:

◆ setLastUpdate()

ilCalendarEntry::setLastUpdate ( $a_date )

set last update

public

Parameters

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

Referenced by read().

     {
         $this->last_update = $a_date;
     }

Here is the caller graph for this function:

◆ setLocation()

ilCalendarEntry::setLocation ( $a_location )

set location

public

Parameters

string location

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

Referenced by read().

     {
         $this->location = $a_location;
     }

Here is the caller graph for this function:

◆ setMilestone()

ilCalendarEntry::setMilestone ( $a_status )

set milestone

public

Parameters

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

Referenced by read().

     {
         $this->is_milestone = $a_status;
     }

Here is the caller graph for this function:

◆ setStart()

ilCalendarEntry::setStart ( $a_start )

public

Parameters

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

Referenced by ilBookingProcessGUI\processBooking().

     {
         $this->start = $a_start;
     }

Here is the caller graph for this function:

◆ setSubtitle()

ilCalendarEntry::setSubtitle ( $a_subtitle )

set subtitle Used for automatic generated appointments.

Will be appended to the title.

public

Parameters

string subtitle

Returns

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

Referenced by read().

     {
         $this->subtitle = $a_subtitle;
     }

Here is the caller graph for this function:

◆ setTitle()

ilCalendarEntry::setTitle ( $a_title )

set title

public

Parameters

string title

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

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

     {
         $this->title = $a_title;
     }

Here is the caller graph for this function:

◆ setTranslationType()

ilCalendarEntry::setTranslationType ( $a_type )

public

Parameters

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

Referenced by read().

     {
         $this->translation_type = $a_type;
     }

Here is the caller graph for this function:

◆ update()

ilCalendarEntry::update ( )

update

public

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

References $DIC, $ilDB, $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.

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $now = new ilDateTime(time(), IL_CAL_UNIX);
         $utc_timestamp = $now->get(IL_CAL_DATETIME, '', ilTimeZone::UTC);
 
 
         $query = "UPDATE cal_entries " .
             "SET title = " . $this->db->quote($this->getTitle(), 'text') . ", " .
             "last_update = " . $ilDB->quote($utc_timestamp, 'timestamp') . ", " .
             "subtitle = " . $this->db->quote($this->getSubtitle(), 'text') . ", " .
             "description = " . $this->db->quote($this->getDescription(), 'text') . ", " .
             "location = " . $this->db->quote($this->getLocation(), 'text') . ", " .
             "fullday = " . $ilDB->quote($this->isFullday() ? 1 : 0, 'integer') . ", " .
             "starta = " . $this->db->quote($this->getStart()->get(IL_CAL_DATETIME, '', 'UTC'), 'timestamp') . ", " .
             "enda = " . $this->db->quote($this->getEnd()->get(IL_CAL_DATETIME, '', 'UTC'), 'timestamp') . ", " .
             "informations = " . $this->db->quote($this->getFurtherInformations(), 'text') . ", " .
             "auto_generated =  " . $this->db->quote($this->isAutoGenerated(), 'integer') . ", " .
             "translation_type = " . $this->db->quote($this->getTranslationType(), 'integer') . ", " .
             "context_id = " . $this->db->quote($this->getContextId(), 'integer') . ", " .
             '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 = $ilDB->manipulate($query);
 
         return true;
     }

Here is the call graph for this function:

◆ validate()

ilCalendarEntry::validate ( )

validate

public

Returns

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

References $DIC, $ilErr, $lng, $success, ilDateTime\_before(), getEnd(), getStart(), and getTitle().

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

Here is the call graph for this function:

◆ writeResponsibleUsers()

ilCalendarEntry::writeResponsibleUsers ( $a_users )

Write users responsible for a milestone.

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

References $DIC, $ilDB, and getEntryId().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         
         $ilDB->manipulateF(
             "DELETE FROM cal_entry_responsible WHERE cal_id = %s",
             array("integer"),
             array($this->getEntryId())
         );
         
         if (is_array($a_users)) {
             foreach ($a_users as $user_id) {
                 $ilDB->manipulateF(
                     "INSERT INTO cal_entry_responsible (cal_id, user_id) " .
                     " VALUES (%s,%s)",
                     array("integer", "integer"),
                     array($this->getEntryId(), $user_id)
                 );
             }
         }
         
         $this->responsible_users = $a_users;
     }

Here is the call graph for this function:

Field Documentation

◆ $completion

ilCalendarEntry::$completion = 0

protected

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

Referenced by getCompletion().

◆ $context_id

ilCalendarEntry::$context_id = 0

protected

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

Referenced by getContextId().

◆ $context_info

ilCalendarEntry::$context_info = ''

protected

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

Referenced by getContextInfo().

◆ $db

ilCalendarEntry::$db

protected

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

◆ $description

ilCalendarEntry::$description

protected

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

Referenced by getDescription().

◆ $end

ilCalendarEntry::$end = null

protected

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

Referenced by getEnd().

◆ $entry_id

ilCalendarEntry::$entry_id

protected

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

Referenced by getEntryId().

◆ $fullday

ilCalendarEntry::$fullday

protected

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

Referenced by isFullday().

◆ $further_informations

ilCalendarEntry::$further_informations

protected

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

Referenced by getFurtherInformations().

◆ $is_auto_generated

ilCalendarEntry::$is_auto_generated = false

protected

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

Referenced by isAutoGenerated().

◆ $is_milestone

ilCalendarEntry::$is_milestone = false

protected

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

Referenced by isMilestone().

◆ $last_update

ilCalendarEntry::$last_update

protected

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

◆ $location

ilCalendarEntry::$location

protected

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

Referenced by getLocation().

◆ $log

ilCalendarEntry::$log

protected

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

◆ $notification

ilCalendarEntry::$notification = false

protected

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

Referenced by isNotificationEnabled().

◆ $start

ilCalendarEntry::$start = null

protected

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

Referenced by getStart().

◆ $subtitle

ilCalendarEntry::$subtitle

protected

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

Referenced by getPresentationTitle(), and getSubtitle().

◆ $title

ilCalendarEntry::$title

protected

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

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

◆ $translation_type

ilCalendarEntry::$translation_type = IL_CAL_TRANSLATION_NONE

protected

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

Referenced by getTranslationType().

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

Services/Calendar/classes/class.ilCalendarEntry.php

Public Member Functions

Static Public Member Functions

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

◆ $fullday

◆ $further_informations

◆ $is_auto_generated

◆ $is_milestone

◆ $last_update

◆ $location

◆ $log

◆ $notification

◆ $start

◆ $subtitle

◆ $title

◆ $translation_type