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)
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, $show_hidden=false)
static	getEntries ($user_id, $semester, $start_hour, $end_hour, $show_hidden=false)
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 adminBind	(	$seminar_id,
		$cycle_id,
		$visible = `true`
	)

static

Toggle entries' visibility

Parameters

string	the course's ID
string	the cycle's ID
bool	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 cycle to visible.

Parameters

string	the course's ID
string	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

$user_id	the user of the schedule
$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,
		$show_hidden = `false`
	)

static

return an array of entries in the schedule (personal ones and regular seminar-dates)

Parameters

string	$user_id
mixed	$semester	the data for the semester to be displayed

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,
		$show_hidden = `false`
	)

static

Returns a merged array consisting of normal and courses' entries

Parameters

string	the user's ID
string	the course's ID
string	the start hour of the entries
string	the end hour of the entries
string	the institute's ID
bool	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 the schedule entries (optionally of a given course)

Parameters

string	the ID of the user
int	the start hour
int	the end hour
string	optional; the ID of the course

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 schedule entry of a course

Parameters

string	the ID of the user
string	the ID of the course
int	the start hour
int	the end hour
string	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 the schedule entries of the specified institute

Parameters

string	the ID of the user
array	an array containing the "beginn" of the semester
int	the start hour
int	the end hour
string	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`
	)

static

Return an entry for the specified course

Parameters

string	the ID of the course
string	the ID of the user
mixed	either false or the ID of the cycle

Returns: array the course's entry

Here is the call graph for this function:

Here is the caller graph for this function:

static isSeminarVisible	(	$seminar_id,
		$cycle_id
	)

static

Parameters

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

Returns: bool true if visible, false otherwise

Here is the call graph for this function:

static storeEntry ( $data )

static

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

Parameters

mixed $data

Here is the call graph for this function:

Here is the caller graph for this function:

static storeSeminarEntry ( $data )

static

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

Parameters

mixed the data to store

Returns: void

Here is the call graph for this function:

Here is the caller graph for this function:

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

static

Switch a cycle to invisible.

Parameters

string	the course's ID
string	the cycle's ID

Returns: void

Here is the call graph for this function:

Here is the caller graph for this function:

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

app/models/calendar/schedule.php

Static Public Member Functions

Detailed Description

Member Function Documentation