Stud.IP
6.0
|
Static Public Member Functions | |
static | getEvents (DateTime $begin, DateTime $end, string $range_id, array $access_levels=['PUBLIC', 'PRIVATE', 'CONFIDENTIAL'], bool $with_declined=false) |
static | getExtent (DateTimeInterface $date_begin, DateTimeInterface $date_end) |
![]() | |
static | tableScheme ($db_table) |
static | expireTableScheme () |
static | exists ($id) |
static | countBySql ($sql='1', $params=[]) |
static | create ($data) |
static | build ($data, $is_new=true) |
static | buildExisting ($data) |
static | import ($data) |
static | findBySQL ($sql, $params=[]) |
static | findOneBySQL ($where, $params=[]) |
static | findThru ($foreign_key_value, $options) |
static | findEachBySQL ($callable, $sql, $params=[]) |
static | findMany ($pks=[], $order='', $order_params=[]) |
static | findEachMany ($callable, $pks=[], $order='', $order_params=[]) |
static | findAndMapBySQL ($callable, $where, $params=[]) |
static | findAndMapMany ($callable, $pks=[], $order='', $order_params=[]) |
static | deleteBySQL ($where, $params=[]) |
static | toObject ($id_or_object) |
static | __callStatic (string $name, array $arguments) |
static | setMariadbDefaultColumnFix (bool $state=true) |
![]() | |
static | getEvents (DateTime $begin, DateTime $end, string $range_id) |
Data Fields | |
$suppress_mails = false | |
![]() | |
const | ID_SEPARATOR = '_' |
Static Protected Member Functions | |
static | configure ($config=[]) |
![]() | |
static | db_table () |
static | db_fields () |
static | pk () |
static | default_values () |
static | serialized_fields () |
static | alias_fields () |
static | i18n_fields () |
static | additional_fields () |
static | has_many () |
static | has_one () |
static | belongs_to () |
static | has_and_belongs_to_many () |
static | registered_callbacks () |
static | known_slots () |
static | notification_map () |
static | getter_setter_map () |
static | configure ($config=[]) |
static | config ($key) |
static | registerCallback ($types, $cb) |
static | unregisterCallback ($types, $cb) |
Additional Inherited Members | |
![]() | |
static | $schemes = null |
![]() | |
_getId ($field) | |
_setId ($field, $value) | |
_getAdditionalValueFromRelation ($field) | |
_setAdditionalValueFromRelation ($field, $value) | |
_getAdditionalValue ($field) | |
_setAdditionalValue ($field, $value) | |
parseRelationOptions ($type, $name, $options) | |
storeRelations ($only_these=null) | |
deleteRelations () | |
initializeContent () | |
applyCallbacks ($type) | |
cbNotificationMapper ($cb_type) | |
cbAfterInitialize ($cb_type) | |
setSerializedValue ($field, $value) | |
setI18nValue ($field, $value) | |
![]() | |
$content = [] | |
$content_db = [] | |
$is_new = true | |
$is_deleted = false | |
$relations = [] | |
$additional_data = [] | |
string | $i18n_class = I18NString::class |
![]() | |
static | $config = [] |
static | $reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id'] |
static | $performs_batch_operation = false |
static | $mariadb_column_default_fix = false |
cbSendDateDeletedMail | ( | ) |
cbSendNewDateMail | ( | ) |
|
staticprotected |
getAdditionalDescriptions | ( | ) |
Returns additional descriptions of the Event object. These are specific for each implementation.
Implements Event.
getAuthor | ( | ) |
Returns the author of this event as user object.
Implements Event.
getBegin | ( | ) |
getCreationDate | ( | ) |
Returns the creation date of the event.
Implements Event.
getDescription | ( | ) |
getDuration | ( | ) |
getDurationDays | ( | ) |
Returns the "extent" in days of this date.
getEditor | ( | ) |
Returns the editor of this event as user object.
Implements Event.
getEnd | ( | ) |
|
static |
Retrieves calendar dates inside a specified time range that are present in the calendar of a course or user. They can additionally be filtered by the access level and declined events can be filtered out, too.
DateTime | $begin | The beginning of the time range. |
DateTime | $end | The end of the time range. |
string | $range_id | The ID of the course or user whose calendar dates shall be retrieved. |
array | $access_levels | The access level filter: Only include calendar dates that have one of the access levels in the list. |
bool | $with_declined | Include declined calendar dates (true) or filter them out (false). Defaults to false. |
getExpire | ( | ) |
TODO calculate end of repetition for different types of repetition
|
static |
Returns the "extent" in days of this date. The extent is the number of days a date is displayed in a calendar.
getImportDate | ( | ) |
Returns the import date of the event.
Implements Event.
getLocation | ( | ) |
Returns the location where the event takes place, if applicable.
Implements Event.
getModificationDate | ( | ) |
Returns the modification date of the event.
Implements Event.
getNoonDate | ( | ) |
getObjectClass | ( | ) |
getObjectId | ( | ) |
Returns the ID of the event. This is the ID that is only valid inside of Stud.IP.
Implements Event.
getParticipationAsString | ( | ) |
getPrimaryObjectID | ( | ) |
Returns the ID of the primary object where this object is linked to in a primary-secondary relationship where this object is a secondary object.
Example: A course date is a secondary object and the course it belongs to is the primary object.
Implements Event.
getRangeAvatar | ( | ) |
getRangeName | ( | ) |
getRepetitionType | ( | ) |
Returns the type of repetition.
getTitle | ( | ) |
Returns the title of this event. If the user has not the permission Event::PERMISSION_READABLE, the title is "Keine Berechtigung.".
Implements Event.
getUniqueId | ( | ) |
Returns the global unique id of the event.
Implements Event.
isAllDayEvent | ( | ) |
Returns whether the event is an all day event or not.
Implements Event.
isWritable | ( | string | $user_id | ) |
Determines whether the specified user has write permissions for the event.
string | $user_id | The user for which to check write permissions. |
Implements Event.
sendParticipationStatus | ( | ) |
Sends the participation status of the calendar the date is assigned to. This is only done for user calendars and not for course calendars.
toEventData | ( | string | $user_id | ) |
Returns a JSON-encoded fullcalendar event object that represents the event.
$user_id | string The user for which to generate the fullcalendar event. |
Implements Event.
$suppress_mails = false |