Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
EventSource Interface Reference
Inheritance diagram for EventSource:
ResourceBooking ResourceRequest RoomRequest

Public Member Functions

 getAllEventData ()
 
 getEventDataForTimeRange (\DateTime $begin,\DateTime $end)
 
 getFilteredEventData ($user_id=null, $range_id=null, $range_type=null, $begin=null, $end=null)
 

Detailed Description

This interface defines methods that can be implemented by classes that can provide calendar event data in a standardised format. The methods are meant to be called on a "per-object base", meaning that filtering of the event sources has to be done before calling methods of this interface.

Member Function Documentation

getAllEventData ( )

Returns all event data this event source can provide.

Returns
EventData[] An array of Studip objects.

Implemented in ResourceRequest, and ResourceBooking.

getEventDataForTimeRange ( \DateTime  $begin,
\DateTime  $end 
)

Returns event data that fall in the specified time range.

Returns
EventData[] An array of Studip objects.
getFilteredEventData (   $user_id = null,
  $range_id = null,
  $range_type = null,
  $begin = null,
  $end = null 
)

Allows a filtered output of event data based on a specified user, a specified range-ID and range type (must be supported by the Context class) or a specified time range. If no filters are applied the result should be the same as if the getAllEventData method from this interface is called.

Parameters
string$user_idThe user for whom the event data shall be retrieved. Depending on the implementation, this parameter might be necessary to check permissions for event objects.
string$range_idAn optional range-ID that may be necessary for an implementation to check for permissions.
string$range_typeAn optional range type that may be necessary for an implementation to check for permissions.
DateTime | int | string$beginThe begin date as DateTime object or unix timestamp.
DateTime | int | string$endThe end date as DateTime object or unix timestamp.
Returns
EventData[] An array of Studip objects.

Implemented in ResourceRequest, and ResourceBooking.


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