|
static | getConsecutiveNumber ($date, $semester=null) |
|
static | findByIssue_id ($issue_id) |
|
static | findBySeminar_id ($seminar_id) |
|
static | findByRange_id ($seminar_id, $order_by='ORDER BY date') |
|
static | findByStatusgruppe_id ($group_id) |
|
static | exportUserData (StoredUserData $storage) |
|
static | getEvents (DateTime $begin, DateTime $end, string $range_id) |
|
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) |
|
◆ __toString()
- Returns
- string A string representation of the course date.
◆ addTopic()
Adds a topic to this date.
- Parameters
-
mixed | $topic | Topic definition (might be an id, an array or an object) |
- Returns
- int|false number addition of all return values, false if none was called
◆ bookRoom()
bookRoom |
( |
Room |
$room, |
|
|
int |
$preparation_time = 0 |
|
) |
| |
Books a room for the course date.
- Parameters
-
Room | $room | Room The room to be booked. |
int | $preparation_time | int The preparation time for the booking. |
- Returns
- bool True, if the booking succeeded, false otherwise.
◆ cancelDate()
◆ cbStudipLog()
- Parameters
-
$type | string type of callback |
◆ configure()
static configure |
( |
|
$config = [] | ) |
|
|
staticprotected |
Configures this model.
- Parameters
-
Array | $config | Configuration array |
◆ delete()
◆ exportUserData()
Export available data of a given user into a storage object (an instance of the StoredUserData class) for that user.
- Parameters
-
Implements PrivacyObject.
◆ findByIssue_id()
static findByIssue_id |
( |
|
$issue_id | ) |
|
|
static |
Returns course dates by issue id.
- Parameters
-
String | $issue_id | Id of the issue |
- Returns
- array with the associated dates
◆ findByRange_id()
static findByRange_id |
( |
|
$seminar_id, |
|
|
|
$order_by = 'ORDER BY date' |
|
) |
| |
|
static |
Return course dates by range id (which is in many cases the course id)
- Parameters
-
String | $seminar_id | Id of the course |
String | $order_by | Optional order definition |
- Returns
- array with the associated dates
◆ findBySeminar_id()
static findBySeminar_id |
( |
|
$seminar_id | ) |
|
|
static |
Returns course dates by course id
- Parameters
-
String | $seminar_id | Id of the course |
- Returns
- array with the associated dates
◆ findByStatusgruppe_id()
static findByStatusgruppe_id |
( |
|
$group_id | ) |
|
|
static |
Returns course dates by issue id.
- Parameters
-
String | $issue_id | Id of the issue |
- Returns
- array with the associated dates
◆ getAccessibleFolderFiles()
getAccessibleFolderFiles |
( |
|
$user_or_id | ) |
|
return all filerefs belonging to this date, permissions fpr given user are checked
- Parameters
-
- Returns
- mixed[] A mixed array with FolderType and FileRef objects.
◆ getAdditionalDescriptions()
getAdditionalDescriptions |
( |
| ) |
|
Returns additional descriptions of the Event object. These are specific for each implementation.
- Returns
- array Additional descriptions for the Event implementation. Each array key represents a heading for the description and the value contains the description itself as plain text. In case this is not applicable for the implementation, an empty array is returned.
Implements Event.
◆ getAuthor()
Returns the author of this event as user object.
- Returns
- User|null The user object of the author of the event, if available.
Implements Event.
◆ getBegin()
Returns the start time of the event.
- Returns
- DateTime The start time of the event.
Implements Event.
◆ getConsecutiveNumber()
static getConsecutiveNumber |
( |
|
$date, |
|
|
|
$semester = null |
|
) |
| |
|
static |
return consecutive number for a date in its course, if semester is given only within that time range
- Parameters
-
- Returns
- int|null
◆ getCreationDate()
Returns the creation date of the event.
- Returns
- DateTime The creation date of the event.
Implements Event.
◆ getDeletionWarnings()
Returns a list of all possible warnings that should be considered when this date is deleted.
- Returns
- array of warnings
◆ getDescription()
Returns the description of the event.
- Returns
- string The description of the event.
Implements Event.
◆ getDuration()
Returns the duration of the event.
- Returns
- DateInterval The duration of the event.
Implements Event.
◆ getEditor()
Returns the editor of this event as user object.
- Returns
- User|null The user object of the editor of the event, if available.
Implements Event.
◆ getEnd()
Returns the end time of the event.
- Returns
- DateTime The end time of the event.
Implements Event.
◆ getEvents()
static getEvents |
( |
DateTime |
$begin, |
|
|
DateTime |
$end, |
|
|
string |
$range_id |
|
) |
| |
|
static |
Retrieves events that lie in a given time range.
- Parameters
-
DateTime | $begin | The beginning of the time range. |
DateTime | $end | The end of the time range. |
string | $range_id | The range for which to get the events. This may be a user-ID, course-ID or another kind of ID. |
- Returns
- Event[] An array with event objects.
Implements Event.
◆ getFullName()
getFullName |
( |
|
$format = 'default' | ) |
|
Returns the full qualified name of this date.
- Parameters
-
String | $format | Optional format type. Only 'default', 'include-room', 'long', 'long-include-room' and 'verbose' are supported by now. |
- Returns
- String containing the full name of this date.
◆ getImportDate()
Returns the import date of the event.
- Returns
- DateTime The import date of the event.
Implements Event.
◆ getLocation()
Returns the location where the event takes place, if applicable.
- Returns
- string The location of the event.
Implements Event.
◆ getModificationDate()
Returns the modification date of the event.
- Returns
- DateTime The modification date of the event.
Implements Event.
◆ getObjectClass()
Returns the class of the Event implementation.
- Returns
- string The class name of the Event instance.
Implements Event.
◆ getObjectId()
Returns the ID of the event. This is the ID that is only valid inside of Stud.IP.
- Returns
- string The ID of the event object.
Implements Event.
◆ 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.
- Returns
- string The ID of the primary object or an empty string if the implementation of the Event interface is a class of primary objects.
Implements Event.
◆ getRoom()
Returns the assigned room for this date as an object.
- Returns
- Resource Either the object or null if no room is assigned
◆ getRoomName()
Returns the name of the assigned room for this date.
- Returns
- String containing the room name
◆ getTitle()
Returns the title of this event. If the user has not the permission Event::PERMISSION_READABLE, the title is "Keine Berechtigung.".
- Returns
- string The title of the event.
Implements Event.
◆ getTypeName()
Returns the name of the type of this date.
- Parameters
-
String | containing the type name |
◆ getUniqueId()
Returns the global unique id of the event.
- Returns
- string The global unique id of the event.
Implements Event.
◆ isAllDayEvent()
Returns whether the event is an all day event or not.
- Returns
- bool True, if the event is an all day event, false otherwise.
Implements Event.
◆ isWritable()
isWritable |
( |
string |
$user_id | ) |
|
Determines whether the specified user has write permissions for the event.
- Parameters
-
string | $user_id | The user for which to check write permissions. |
- Returns
- bool True, if the user has write permissions, false otherwise.
Implements Event.
◆ removeTopic()
Removes a topic from this date.
- Parameters
-
mixed | $topic | Topic definition (might be an id, an array or an object) |
- Returns
- number addition of all return values, false if none was called
◆ store()
◆ toEventData()
toEventData |
( |
string |
$user_id | ) |
|
Returns a JSON-encoded fullcalendar event object that represents the event.
- Parameters
-
$user_id | string The user for which to generate the fullcalendar event. |
- Returns
- The EventData representation of the event.
Implements Event.
◆ FORMAT_DEFAULT
const FORMAT_DEFAULT = 'default' |
◆ FORMAT_VERBOSE
const FORMAT_VERBOSE = 'verbose' |
The documentation for this class was generated from the following file: