Helper Class Reference

Static Public Member Functions
static	getCalendarSlotDuration (string $calendar_type='week', string $user_id='')
static	getDefaultCalendarDate ()
static	getScheduleFullcalendar (string $semester_id='', bool $show_hidden_courses=false)
static	getPersonalFullcalendar ()

Member Function Documentation

getCalendarSlotDuration()

static getCalendarSlotDuration ( string  $calendar_type = 'week', string  $user_id = ''  )

static

Retrieves the time slot duration in the calendar for a specified calendar type and either the current user or a specific user.

Parameters

string	$calendar_type	The calendar type for which to retrieve the slot duration. Valid values: 'week', 'day', 'week_group' (week group calendar), 'week_day' (day group calendar). Defaults to 'week'.
string	$user_id	The user for which to retrieve the slot duration. Defaults to an empty string which then in turn means the current users slot duration is retrieved.

Returns

string The slot duration as a time string in the form HH:MM:SS.

getDefaultCalendarDate()

static getDefaultCalendarDate ( )

static

Retrieves the default calendar date by various methods.

Returns

The default date for the calendar. This defaults to the current date if no other date can be retrieved.

getPersonalFullcalendar()

static getPersonalFullcalendar ( )

static

getScheduleFullcalendar()

static getScheduleFullcalendar ( string  $semester_id = '', bool  $show_hidden_courses = false  )

static

Constructs a Fullcalendar instance of the schedule for the current user.

Parameters

string	$semester_id	The ID of the semester to be used. Defaults to an empty string which in turn means that the current semester shall be used.
bool	$show_hidden_courses	Whether to include hidden courses in the schedule (true) or not (false). Defaults to false.

Returns

A fullcalendar instance for the schedule of the current user.

---

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

• lib/classes/calendar/Helper.php