Static Public Member Functions
static	storeEntry ($data)

static	storeSeminarEntry ($data)

static	deleteEntry ($id)

static	getScheduleEntries ($user_id, $start_hour, $end_hour, $id=false)

static	getSeminarEntry ($seminar_id, $user_id, $cycle_id=false, $semester=false)

static	deleteSeminarEntries ($user_id, $seminar_id)

static	getSeminarEntries ($user_id, $semester, $start_hour, $end_hour, $show_hidden=false)

static	getSeminarEntriesForInstitute ($user_id, $semester, $start_hour, $end_hour, $institute_id)

static	getSeminarCycleId (Seminar $seminar, $start, $end, $day)

static	isSeminarVisible ($seminar_id, $cycle_id)

static	getInstituteEntries ($user_id, $semester, $start_hour, $end_hour, $institute_id, $days, $show_hidden=false)

static	getEntries ($user_id, $semester, $start_hour, $end_hour, $days, $show_hidden=false)

static	addDayChooser ($entries, $days, $controller='schedule')

static	adminBind ($seminar_id, $cycle_id, $visible=true)

static	unbind ($seminar_id, $cycle_id=null)

static	bind ($seminar_id, $cycle_id)

static	getScheduleSettings ($user_id=false)

static	getDisplayedDays (array $input)

static	getCurrentSemester ()

static	getInstCalendarView ($institute_id, $show_hidden=false, $semester=false, $days=false)

static	getUserCalendarView ($user_id, $show_hidden=false, $semester=false, $days=false)

Detailed Description

Pseudo-namespace containing helper methods for the schedule.

Since: 2.0

Member Function Documentation

◆ addDayChooser()

static addDayChooser	(	$entries,
		$days,
		$controller = `'schedule'`
	)

static

adds title and link to CalendarColumn-objects and sorts the objects to be displayed correctly in the calendar-view

Parameters

array	$entries	an array of CalendarColumn-objects
array	$days	an array of int's, denoting the days to be displayed

Returns: array

◆ adminBind()

static adminBind	(	$seminar_id,
		$cycle_id,
		$visible = `true`
	)

static

Toggle entries' visibility

Parameters

string	$seminar_id	the course's ID
string	$cycle_id	the cycle's ID
bool	$visible	the value to switch to

Returns: void

◆ bind()

static bind	(	$seminar_id,
		$cycle_id
	)

static

Switch a seminars' cycle to visible.

Parameters

string	$seminar_id	the course's ID
string	$cycle_id	the cycle's ID

Returns: void

◆ deleteEntry()

static deleteEntry ( $id )

static

delete the entry with the submitted id, belonging to the current user

Parameters

string $id

Returns: void

◆ deleteSeminarEntries()

static deleteSeminarEntries	(	$user_id,
		$seminar_id
	)

static

Deletes the schedule entries of one user for one seminar.

Parameters

string	$user_id	the user of the schedule
string	$seminar_id	the seminar which entries should be deleted

◆ getCurrentSemester()

static getCurrentSemester ( )

static

Return the semester-entry for the current semester

Returns: mixed the current semester

◆ getDisplayedDays()

static getDisplayedDays ( array $input )

static

Transforms day settings from SCHEDULE_SETTINGS::glb_days to valid days that can be displayed.

Parameters

array $input Input from SCHEDULE_SETTINGS

Returns: array

◆ getEntries()

static getEntries	(	$user_id,
		$semester,
		$start_hour,
		$end_hour,
		$days,
		$show_hidden = `false`
	)

static

Parameters

string	$user_id
mixed	$semester	the data for the semester to be displayed Returns an array of CalendarColumn's, containing the seminar-entries for the passed user (in the passed semester) and the user-defined schedule-entries. The start- and end-hour are used to constrain the returned entries to the passed time-period. The passed days constrain the entries to these. Seminar-entries can be hidden, so you can opt-in to fetch the hidden ones as well.
string	$user_id	the user's ID
string	$semester	the data for the semester to be displayed
int	$start_hour	the start hour of the entries
int	$end_hour	the end hour of the entries
array	$days	days to be displayed
bool	$show_hidden	filters hidden entries

Returns: array

◆ getInstCalendarView()

static getInstCalendarView	(	$institute_id,
		$show_hidden = `false`,
		$semester = `false`,
		$days = `false`
	)

static

Create a CalendarWeekView (a schedule) for an institute for the current user and return it.

Parameters

string	$institute_id	the institute to get the calendar for
bool	$show_hidden	show hidden entries
mixed	$semester	the semester to use
mixed	$days	the days to consider

Returns: CalendarWeekView

◆ getInstituteEntries()

static getInstituteEntries	(	$user_id,
		$semester,
		$start_hour,
		$end_hour,
		$institute_id,
		$days,
		$show_hidden = `false`
	)

static

Returns an array of CalendarColumn's, containing the seminar-entries for the passed user (in the passed semester belonging to the passed institute) and the user-defined schedule-entries. The start- and end-hour are used to constrain the returned entries to the passed time-period. The passed days constrain the entries to these. Seminar-entries can be hidden, so you can opt-in to fetch the hidden ones as well.

Parameters

string	$user_id	the user's ID
string	$semester	the data for the semester to be displayed
int	$start_hour	the start hour of the entries
int	$end_hour	the end hour of the entries
string	$institute_id	the institute's ID
array	$days	days to be displayed
bool	$show_hidden	filters hidden entries

Returns: array an array of entries

◆ getScheduleEntries()

static getScheduleEntries	(	$user_id,
		$start_hour,
		$end_hour,
		$id = `false`
	)

static

Returns an array of CalendarColumn's containing the schedule entries (optionally of a given id only). The start- and end-hour are used to constrain the returned entries to the passed time-period. If you pass an id, there will be only the single entry with that id in the CalendarColumn

Parameters

string	$user_id	the ID of the user
int	$start_hour	the start hour
int	$end_hour	the end hour
string	$id	optional; the ID of the schedule-entry

Returns: array an array containing the entries

◆ getScheduleSettings()

static getScheduleSettings ( $user_id = false )

static

Get the schedule_settings from the user's config

Parameters

string $user_id the user to get the settings for, defaults to current user

Returns: mixed the settings

◆ getSeminarCycleId()

static getSeminarCycleId	(	Seminar	$seminar,
			$start,
			$end,
			$day
	)

static

Returns the ID of the cycle of a course specified by start and end.

Parameters

Seminar	$seminar	an instance of a Seminar
string	$start	the start of the cycle
string	$end	the end of the cycle

Returns: string $day numeric day

◆ getSeminarEntries()

static getSeminarEntries	(	$user_id,
		$semester,
		$start_hour,
		$end_hour,
		$show_hidden = `false`
	)

static

Returns an array of CalendarColumn's, containing the seminar-entries for the passed user in the passed semester. The start- and end-hour are used to constrain the returned entries to the passed time-period. Seminar-entries can be hidden, so you can opt-in to fetch the hidden ones as well.

Parameters

string	$user_id	the ID of the user
string	$semester	an array containing the "beginn" of the semester
int	$start_hour	the start hour
int	$end_hour	the end hour
string	$show_hidden	optional; true to show hidden, false otherwise

Returns: array an array containing the properties of the entry

◆ getSeminarEntriesForInstitute()

static getSeminarEntriesForInstitute	(	$user_id,
		$semester,
		$start_hour,
		$end_hour,
		$institute_id
	)

static

Returns an array of CalendarColumn's, containing the seminar-entries for the passed user in the passed semester belonging to the passed institute. The start- and end-hour are used to constrain the returned entries to the passed time-period.

Parameters

string	$user_id	the ID of the user
array	$semester	an array containing the "beginn" of the semester
int	$start_hour	the start hour
int	$end_hour	the end hour
string	$institute_id	the ID of the institute

Returns: array an array containing the entries

◆ getSeminarEntry()

static getSeminarEntry	(	$seminar_id,
		$user_id,
		$cycle_id = `false`,
		$semester = `false`
	)

static

Return an entry for the specified course.

Parameters

string	$seminar_id	the ID of the course
string	$user_id	the ID of the user
mixed	$cycle_id	either false or the ID of the cycle
mixed	$semester	filter for this semester

Returns: array the course's entry

◆ getUserCalendarView()

static getUserCalendarView	(	$user_id,
		$show_hidden = `false`,
		$semester = `false`,
		$days = `false`
	)

static

Create a CalendarWeekView (a schedule) for the current user and return it.

Parameters

string	$user_id	the institute to get the calendar for
bool	$show_hidden	show hidden entries
mixed	$semester	the semester to use
mixed	$days	the days to consider

Returns: CalendarWeekView

◆ isSeminarVisible()

static isSeminarVisible	(	$seminar_id,
		$cycle_id
	)

static

check if the passed cycle of the passed id is visible for the currently logged in user int the schedule

Parameters

string	the ID of the course
string	the ID of the cycle

Returns: bool true if visible, false otherwise

◆ storeEntry()

static storeEntry ( $data )

static

update an existing entry or -if $data['id'] is not set- create a new entry

Parameters

mixed $data

◆ storeSeminarEntry()

static storeSeminarEntry ( $data )

static

Update an existing entry of a course or create a new entry if $data['id'] is not set

Parameters

mixed $data the data to store

Returns: void

◆ unbind()

static unbind	(	$seminar_id,
		$cycle_id = `null`
	)

static

Switch a seminars' cycle to invisible.

Parameters

string	$seminar_id	the course's ID
string	$cycle_id	the cycle's ID

Returns: void

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

lib/classes/calendar/CalendarScheduleModel.php

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ addDayChooser()

◆ adminBind()

◆ bind()

◆ deleteEntry()

◆ deleteSeminarEntries()

◆ getCurrentSemester()

◆ getDisplayedDays()

◆ getEntries()

◆ getInstCalendarView()

◆ getInstituteEntries()

◆ getScheduleEntries()

◆ getScheduleSettings()

◆ getSeminarCycleId()

◆ getSeminarEntries()

◆ getSeminarEntriesForInstitute()

◆ getSeminarEntry()

◆ getUserCalendarView()

◆ isSeminarVisible()

◆ storeEntry()

◆ storeSeminarEntry()

◆ unbind()