ILIAS
release_4-3 Revision
|
Model for a calendar entry. More...
Public Member Functions | |
__construct ($a_id=0) | |
Constructor. | |
__clone () | |
clone instance | |
getEntryId () | |
get entry id | |
getLastUpdate () | |
get last update | |
setLastUpdate ($a_date) | |
set last update | |
getStart () | |
get start | |
setStart (ilDateTime $a_start) | |
public | |
getEnd () | |
get end public | |
setEnd ($a_end) | |
set end public | |
setTitle ($a_title) | |
set title | |
getTitle () | |
get title | |
getPresentationTitle ($a_shorten=true) | |
get title for presentation. | |
setSubtitle ($a_subtitle) | |
set subtitle Used for automatic generated appointments. | |
getSubtitle () | |
get subtitle | |
setDescription ($a_description) | |
set description | |
getDescription () | |
get description | |
setLocation ($a_location) | |
set location | |
getLocation () | |
get location | |
setFurtherInformations ($a_informations) | |
set further informations | |
getFurtherInformations () | |
get further informations | |
setFullday ($a_fullday) | |
set fullday event Fullday events do not change their time in different timezones. | |
isFullday () | |
is fullday | |
isAutoGenerated () | |
is auto generated | |
setAutoGenerated ($a_status) | |
set auto generated | |
isMilestone () | |
is milestone | |
setMilestone ($a_status) | |
set milestone | |
setCompletion ($a_completion) | |
Set Completion. | |
getCompletion () | |
Get Completion. | |
setContextId ($a_context_id) | |
set context id | |
getContextId () | |
get context id | |
setTranslationType ($a_type) | |
public | |
getTranslationType () | |
get translation type | |
enableNotification ($a_status) | |
Enable course group notification. | |
isNotificationEnabled () | |
Check if course group notification is enabled. | |
update () | |
update | |
save () | |
save one entry | |
delete () | |
delete | |
validate () | |
validate | |
appointmentToMailString ($lng) | |
writeResponsibleUsers ($a_users) | |
Write users responsible for a milestone. | |
readResponsibleUsers () | |
Read responsible users. |
Static Public Member Functions | |
static | _delete ($a_entry_id) |
delete entry |
Protected Member Functions | |
read () | |
protected |
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 | |
$translation_type = IL_CAL_TRANSLATION_NONE | |
$is_milestone = false | |
$completion = 0 | |
$notification = false |
ilCalendarEntry::__construct | ( | $a_id = 0 | ) |
ilCalendarEntry::__clone | ( | ) |
|
static |
delete entry
public
Definition at line 79 of file class.ilCalendarEntry.php.
Referenced by ilCalendarCategory\delete(), delete(), ilCalendarAppEventListener\deleteAppointments(), and ilCalendarRemoteReader\importIcal().
ilCalendarEntry::appointmentToMailString | ( | $lng | ) |
ilLanguage | $lng |
Definition at line 640 of file class.ilCalendarEntry.php.
References $lng, ilDatePresentation\formatPeriod(), getDescription(), getEnd(), getLocation(), getStart(), getTitle(), and ilDatePresentation\setUseRelativeDates().
ilCalendarEntry::delete | ( | ) |
delete
public
Definition at line 553 of file class.ilCalendarEntry.php.
References $query, $res, _delete(), and getEntryId().
ilCalendarEntry::enableNotification | ( | $a_status | ) |
Enable course group notification.
bool | $a_status |
Definition at line 457 of file class.ilCalendarEntry.php.
Referenced by read().
ilCalendarEntry::getCompletion | ( | ) |
Get Completion.
Definition at line 402 of file class.ilCalendarEntry.php.
References $completion.
Referenced by save(), and update().
ilCalendarEntry::getContextId | ( | ) |
get context id
public
Definition at line 425 of file class.ilCalendarEntry.php.
References $context_id.
Referenced by save(), and update().
ilCalendarEntry::getDescription | ( | ) |
get description
public
Definition at line 266 of file class.ilCalendarEntry.php.
References $description.
Referenced by appointmentToMailString(), save(), and update().
ilCalendarEntry::getEnd | ( | ) |
get end public
Implements ilDatePeriod.
Definition at line 157 of file class.ilCalendarEntry.php.
Referenced by appointmentToMailString(), save(), update(), and validate().
ilCalendarEntry::getEntryId | ( | ) |
get entry id
public
Definition at line 99 of file class.ilCalendarEntry.php.
References $entry_id.
Referenced by ilCalendarExport\buildAppointmentUrl(), ilCalendarAppointmentGUI\calendarEntryToCategory(), delete(), read(), readResponsibleUsers(), update(), and writeResponsibleUsers().
ilCalendarEntry::getFurtherInformations | ( | ) |
get further informations
public
Definition at line 310 of file class.ilCalendarEntry.php.
References $further_informations.
Referenced by save(), and update().
ilCalendarEntry::getLastUpdate | ( | ) |
get last update
public
@return |
Definition at line 111 of file class.ilCalendarEntry.php.
References IL_CAL_UNIX.
ilCalendarEntry::getLocation | ( | ) |
get location
public
Definition at line 288 of file class.ilCalendarEntry.php.
References $location.
Referenced by appointmentToMailString(), save(), and update().
ilCalendarEntry::getPresentationTitle | ( | $a_shorten = true | ) |
get title for presentation.
Special handling for auto generated appointments
public
Definition at line 202 of file class.ilCalendarEntry.php.
References $ilUser, $lng, $title, getSubtitle(), getTitle(), getTranslationType(), IL_CAL_TRANSLATION_NONE, ilUtil\shortenText(), and ilUtil\shortenWords().
ilCalendarEntry::getStart | ( | ) |
get start
public
Implements ilDatePeriod.
Definition at line 135 of file class.ilCalendarEntry.php.
Referenced by appointmentToMailString(), save(), update(), and validate().
ilCalendarEntry::getSubtitle | ( | ) |
get subtitle
public
Definition at line 244 of file class.ilCalendarEntry.php.
References $subtitle.
Referenced by getPresentationTitle(), save(), and update().
ilCalendarEntry::getTitle | ( | ) |
get title
public
Definition at line 190 of file class.ilCalendarEntry.php.
References $title.
Referenced by appointmentToMailString(), getPresentationTitle(), save(), update(), and validate().
ilCalendarEntry::getTranslationType | ( | ) |
get translation type
public
Definition at line 448 of file class.ilCalendarEntry.php.
References $translation_type.
Referenced by getPresentationTitle(), save(), and update().
ilCalendarEntry::isAutoGenerated | ( | ) |
is auto generated
public
@return |
Definition at line 346 of file class.ilCalendarEntry.php.
References $is_auto_generated.
Referenced by save(), and update().
ilCalendarEntry::isFullday | ( | ) |
is fullday
public
Implements ilDatePeriod.
Definition at line 334 of file class.ilCalendarEntry.php.
References $fullday.
Referenced by read(), save(), and update().
ilCalendarEntry::isMilestone | ( | ) |
is milestone
public
@return |
Definition at line 370 of file class.ilCalendarEntry.php.
References $is_milestone.
Referenced by save(), and update().
ilCalendarEntry::isNotificationEnabled | ( | ) |
Check if course group notification is enabled.
Definition at line 466 of file class.ilCalendarEntry.php.
References $notification.
Referenced by save(), and update().
|
protected |
protected
Definition at line 599 of file class.ilCalendarEntry.php.
References $query, $res, $row, DB_FETCHMODE_OBJECT, enableNotification(), getEntryId(), IL_CAL_DATETIME, isFullday(), setAutoGenerated(), setCompletion(), setContextId(), setDescription(), setFullday(), setFurtherInformations(), setLastUpdate(), setLocation(), setMilestone(), setSubtitle(), setTitle(), and setTranslationType().
Referenced by __construct().
ilCalendarEntry::readResponsibleUsers | ( | ) |
Read responsible users.
Definition at line 689 of file class.ilCalendarEntry.php.
References $n, ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), and getEntryId().
ilCalendarEntry::save | ( | ) |
save one entry
public
Definition at line 513 of file class.ilCalendarEntry.php.
References $query, $res, getCompletion(), getContextId(), getDescription(), getEnd(), getFurtherInformations(), getLocation(), getStart(), getSubtitle(), getTitle(), getTranslationType(), IL_CAL_DATETIME, IL_CAL_TIMESTAMP, IL_CAL_UNIX, isAutoGenerated(), isFullday(), isMilestone(), isNotificationEnabled(), and ilTimeZone\UTC.
ilCalendarEntry::setAutoGenerated | ( | $a_status | ) |
set auto generated
public
@return |
Definition at line 358 of file class.ilCalendarEntry.php.
Referenced by read().
ilCalendarEntry::setCompletion | ( | $a_completion | ) |
Set Completion.
int | $a_completion | Completion |
Definition at line 392 of file class.ilCalendarEntry.php.
Referenced by read().
ilCalendarEntry::setContextId | ( | $a_context_id | ) |
set context id
public
int | context id |
Definition at line 414 of file class.ilCalendarEntry.php.
Referenced by read().
ilCalendarEntry::setDescription | ( | $a_description | ) |
set description
public
string | description |
Definition at line 256 of file class.ilCalendarEntry.php.
Referenced by read().
ilCalendarEntry::setEnd | ( | $a_end | ) |
set end public
Definition at line 167 of file class.ilCalendarEntry.php.
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
bool | fullday |
Definition at line 324 of file class.ilCalendarEntry.php.
Referenced by read().
ilCalendarEntry::setFurtherInformations | ( | $a_informations | ) |
set further informations
public
string | further informations |
Definition at line 300 of file class.ilCalendarEntry.php.
Referenced by read().
ilCalendarEntry::setLastUpdate | ( | $a_date | ) |
set last update
public
@return |
Definition at line 123 of file class.ilCalendarEntry.php.
Referenced by read().
ilCalendarEntry::setLocation | ( | $a_location | ) |
set location
public
string | location |
Definition at line 278 of file class.ilCalendarEntry.php.
Referenced by read().
ilCalendarEntry::setMilestone | ( | $a_status | ) |
set milestone
public
@return |
Definition at line 382 of file class.ilCalendarEntry.php.
Referenced by read().
ilCalendarEntry::setStart | ( | ilDateTime | $a_start | ) |
public
@return |
Definition at line 147 of file class.ilCalendarEntry.php.
Referenced by ilObjBookingPoolGUI\processBooking().
ilCalendarEntry::setSubtitle | ( | $a_subtitle | ) |
set subtitle Used for automatic generated appointments.
Will be appended to the title.
public
string | subtitle |
Definition at line 233 of file class.ilCalendarEntry.php.
Referenced by read().
ilCalendarEntry::setTitle | ( | $a_title | ) |
set title
public
string | title |
Definition at line 179 of file class.ilCalendarEntry.php.
Referenced by read().
ilCalendarEntry::setTranslationType | ( | $a_type | ) |
public
@return |
Definition at line 437 of file class.ilCalendarEntry.php.
Referenced by read().
ilCalendarEntry::update | ( | ) |
update
public
Definition at line 477 of file class.ilCalendarEntry.php.
References $query, $res, getCompletion(), getContextId(), getDescription(), getEnd(), getEntryId(), getFurtherInformations(), getLocation(), getStart(), getSubtitle(), getTitle(), getTranslationType(), IL_CAL_DATETIME, IL_CAL_TIMESTAMP, IL_CAL_UNIX, isAutoGenerated(), isFullday(), isMilestone(), isNotificationEnabled(), and ilTimeZone\UTC.
ilCalendarEntry::validate | ( | ) |
validate
public
Definition at line 573 of file class.ilCalendarEntry.php.
References $ilErr, $lng, $success, ilDateTime\_before(), getEnd(), getStart(), and getTitle().
ilCalendarEntry::writeResponsibleUsers | ( | $a_users | ) |
Write users responsible for a milestone.
Definition at line 666 of file class.ilCalendarEntry.php.
References getEntryId().
|
protected |
Definition at line 40 of file class.ilCalendarEntry.php.
Referenced by getCompletion().
|
protected |
Definition at line 37 of file class.ilCalendarEntry.php.
Referenced by getContextId().
|
protected |
Definition at line 23 of file class.ilCalendarEntry.php.
|
protected |
Definition at line 30 of file class.ilCalendarEntry.php.
Referenced by getDescription().
|
protected |
Definition at line 35 of file class.ilCalendarEntry.php.
|
protected |
Definition at line 26 of file class.ilCalendarEntry.php.
Referenced by getEntryId().
|
protected |
Definition at line 34 of file class.ilCalendarEntry.php.
Referenced by isFullday().
|
protected |
Definition at line 32 of file class.ilCalendarEntry.php.
Referenced by getFurtherInformations().
|
protected |
Definition at line 36 of file class.ilCalendarEntry.php.
Referenced by isAutoGenerated().
|
protected |
Definition at line 39 of file class.ilCalendarEntry.php.
Referenced by isMilestone().
|
protected |
Definition at line 27 of file class.ilCalendarEntry.php.
|
protected |
Definition at line 31 of file class.ilCalendarEntry.php.
Referenced by getLocation().
|
protected |
Definition at line 22 of file class.ilCalendarEntry.php.
|
protected |
Definition at line 42 of file class.ilCalendarEntry.php.
Referenced by isNotificationEnabled().
|
protected |
Definition at line 33 of file class.ilCalendarEntry.php.
|
protected |
Definition at line 29 of file class.ilCalendarEntry.php.
Referenced by getSubtitle().
|
protected |
Definition at line 28 of file class.ilCalendarEntry.php.
Referenced by getPresentationTitle(), and getTitle().
|
protected |
Definition at line 38 of file class.ilCalendarEntry.php.
Referenced by getTranslationType().