Collaboration diagram for CalendarScheduleModel:

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)
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=false)
static	bind ($seminar_id, $cycle_id)

Detailed Description

Pseudo-namespace containing helper methods for the schedule.

Since: 2.0

Member Function Documentation

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Here is the call graph for this function:

Here is the caller graph for this function:

static deleteEntry ( $id )

static

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

Parameters

string $id

Returns: void

Here is the call graph for this function:

Here is the caller graph for this function:

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

static

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

Parameters

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

Returns: string the ID of the cycle

Here is the call graph for this function:

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Here is the call graph for this function:

Here is the caller graph for this function:

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