Stud.IP  5.4
Event Interface Reference
Inheritance diagram for Event:
CalendarDateAssignment CourseDate CourseExDate CalendarCourseDate CalendarCourseExDate

Public Member Functions

 getObjectId ()
 
 getPrimaryObjectID ()
 
 getObjectClass ()
 
 getTitle ()
 
 getBegin ()
 
 getEnd ()
 
 getDuration ()
 
 getLocation ()
 
 getUniqueId ()
 
 getDescription ()
 
 getAdditionalDescriptions ()
 
 isAllDayEvent ()
 
 isWritable (string $user_id)
 
 getCreationDate ()
 
 getModificationDate ()
 
 getImportDate ()
 
 getAuthor ()
 
 getEditor ()
 
 toEventData (string $user_id)
 

Static Public Member Functions

static getEvents (DateTime $begin, DateTime $end, string $range_id)
 

Detailed Description

The Event interface represents calendar events.

Member Function Documentation

◆ 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.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.

◆ getAuthor()

getAuthor ( )

Returns the author of this event as user object.

Returns
User|null The user object of the author of the event, if available.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.

◆ getBegin()

getBegin ( )

Returns the start time of the event.

Returns
DateTime The start time of the event.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.

◆ getCreationDate()

getCreationDate ( )

Returns the creation date of the event.

Returns
DateTime The creation date of the event.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.

◆ getDescription()

getDescription ( )

Returns the description of the event.

Returns
string The description of the event.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.

◆ getDuration()

getDuration ( )

Returns the duration of the event.

Returns
DateInterval The duration of the event.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.

◆ getEditor()

getEditor ( )

Returns the editor of this event as user object.

Returns
User|null The user object of the editor of the event, if available.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.

◆ getEnd()

getEnd ( )

Returns the end time of the event.

Returns
DateTime The end time of the event.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.

◆ getEvents()

static getEvents ( DateTime  $begin,
DateTime  $end,
string  $range_id 
)
static

Retrieves events that lie in a given time range.

Parameters
DateTime$beginThe beginning of the time range.
DateTime$endThe end of the time range.
string$range_idThe 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.

Implemented in CourseDate, CourseExDate, CalendarCourseDate, and CalendarCourseExDate.

◆ getImportDate()

getImportDate ( )

Returns the import date of the event.

Returns
DateTime The import date of the event.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.

◆ getLocation()

getLocation ( )

Returns the location where the event takes place, if applicable.

Returns
string The location of the event.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.

◆ getModificationDate()

getModificationDate ( )

Returns the modification date of the event.

Returns
DateTime The modification date of the event.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.

◆ getObjectClass()

getObjectClass ( )

Returns the class of the Event implementation.

Returns
string The class name of the Event instance.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.

◆ getObjectId()

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.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.

◆ getPrimaryObjectID()

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.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.

◆ getTitle()

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.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.

◆ getUniqueId()

getUniqueId ( )

Returns the global unique id of the event.

Returns
string The global unique id of the event.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.

◆ isAllDayEvent()

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.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.

◆ isWritable()

isWritable ( string  $user_id)

Determines whether the specified user has write permissions for the event.

Parameters
string$user_idThe user for which to check write permissions.
Returns
bool True, if the user has write permissions, false otherwise.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.

◆ toEventData()

toEventData ( string  $user_id)

Returns a JSON-encoded fullcalendar event object that represents the event.

Parameters
$user_idstring The user for which to generate the fullcalendar event.
Returns
The EventData representation of the event.

Implemented in CourseDate, CalendarDateAssignment, and CourseExDate.


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