Seminar Class Reference

Collaboration diagram for Seminar:

Public Member Functions
	GetInstance ($id=false, $refresh_cache=false)
	Seminar ($id=FALSE)
	GetSemIdByDateId ($date_id)
	createId ()
	getMembers ($status= 'dozent')
	restoreMembers ($status= 'dozent')
	getAdmissionMembers ($status= 'awaiting')
	restoreAdmissionMembers ($status= 'awaiting')
	getId ()
	getName ()
	getNumber ()
	isVisible ()
	getInstitutId ()
	getSemesterStartTime ()
	getSemesterDurationTime ()
	getNextDate ($return_mode= 'string')
	getFirstDate ($return_mode= 'string')
	getUndecoratedData ($filter=false)
	getFormattedTurnus ($short=FALSE)
	getFormattedTurnusDates ($short=FALSE)
	getMetaDateCount ()
	getMetaDateType ()
	getMetaDateValue ($key, $value_name)
	setMetaDateValue ($key, $value_name, $value)
	restore ()
	getSettings ()
	store ($trigger_chdate=true)
	setStartSemester ($start)
	removeAndUpdateSingleDates ()
	getStartSemester ()
	setEndSemester ($end)
	getEndSemester ()
	getEndSemesterVorlesEnde ()
	getStartSemesterName ()
	readSingleDatesForCycle ($metadate_id)
	readSingleDates ($force=FALSE, $filter=FALSE)
&	getSingleDate ($singleDateID, $cycle_id= '')
&	getSingleDates ($filter=false, $force=false, $include_deleted_dates=false)
	getCycles ()
&	getSingleDatesForCycle ($metadate_id)
	readIssues ($force=false)
	addSingleDate (&$singledate)
	addIssue (&$issue)
	deleteSingleDate ($date_id, $cycle_id= '')
	cancelSingleDate ($date_id, $cycle_id= '')
	unDeleteSingleDate ($date_id, $cycle_id= '')
	getStackedMessages ()
	getNextMessage ()
	createError ($text)
	createInfo ($text)
	createMessage ($text)
	appendMessages ($messages)
	addCycle ($data=array())
	editCycle ($data=array())
	deleteCycle ($cycle_id)
	setTurnus ($turnus, $metadate_id=false)
	getTurnus ($metadate_id=false)
	bookRoomForSingleDate ($singleDateID, $roomID, $cycle_id= '', $append_messages=true)
	getStatOfNotBookedRooms ($cycle_id)
	getStatus ()
	getBookedRoomsTooltip ($cycle_id)
	getRequestsInfo ($cycle_id)
	getCycleColorClass ($cycle_id)
&	getIssues ($force=false)
	deleteIssue ($issue_id)
&	getIssue ($issue_id)
	changeIssuePriority ($issue_id, $new_priority)
	renumberIssuePrioritys ()
	autoAssignIssues ($themen, $cycle_id)
	hasRoomRequest ()
	getRoomRequestStatus ()
	applyTimeFilter ($start, $end)
	setFilter ($timestamp)
	registerCommand ($command, $function)
	processCommands ()
	getFreeTextPredominantRoom ($cycle_id)
	getPredominantRoom ($cycle_id, $list=FALSE)
	getFormattedPredominantRooms ($cycle_id, $link=true, $show=3)
	checkFilter ()
	removeRequest ($singledate_id, $cycle_id= '')
	hasDatesOutOfDuration ($force=false)
	getStartWeek ($metadate_id=false)
	setStartWeek ($week, $metadate_id=false)
	getGroupedDates ($singledate=null, $metadate=null)
	getRoomRequestInfo ()
	removeSeminarRequest ()
	getNumberOfParticipants ()
	getNumberOfParticipantsBySeminarId ($sem_id)
	isAdmissionEnabled ()
	isAdmissionQuotaChecked ()
	isAdmissionQuotaEnabled ()
	restoreAdmissionStudiengang ()
	getFreeAdmissionSeats ($studiengang_id=null)
	getAdmissionChance ($studiengang_id=null)
	getStudyAreas ()
	setStudyAreas ($selected)
	isPublic ()
	isStudygroup ()
	getDefaultGroup ()
	delete ()
	getDatesHTML ($params=array())
	getDatesExport ($params=array())
	getDatesXML ($params=array())
	getDatesTemplate ($template, $params=array())
	getData ()
	getInstitutes ($sem_id=null)
	setInstitutes ($institutes=array())
	addMember ($user_id, $status= 'autor', $force=false)
	deleteMember ($user_id)
	setMemberPriority ($members)
	setLabel ($user_id, $label)

Data Fields
	$id = null
	$issues = null
	$irregularSingleDates = null
	$metadate = null
	$messages = array()
	$semester = null
	$filterStart = 0
	$filterEnd = 0
	$hasDatesOutOfDuration = -1
	$message_stack = array()
	$user_number = 0

Member Function Documentation

addCycle

(

$data = array()

)

Here is the call graph for this function:

addIssue

(

&

$issue

)

Here is the call graph for this function:

addMember	(		$user_id,
			$status = 'autor',
			$force = false
	)

adds a user to the seminar with the given status

Parameters

user_id	string: ID of the user
status	string: status of the user for the seminar "user", "autor", "tutor", "dozent"
force	bool: if false (default) the user will only be upgraded and not degraded in his/her status

Here is the call graph for this function:

addSingleDate

(

&

$singledate

)

Here is the call graph for this function:

appendMessages

(

$messages

)

add an array of messages to the message-stack

Parameters

mixed	$messages	array of pre-marked message-strings
	bool	returns true on success

Here is the caller graph for this function:

applyTimeFilter	(		$start,
			$end
	)

Here is the caller graph for this function:

autoAssignIssues	(		$themen,
			$cycle_id
	)

bookRoomForSingleDate	(		$singleDateID,
			$roomID,
			$cycle_id = '',
			$append_messages = true
	)

Here is the call graph for this function:

cancelSingleDate	(		$date_id,
			$cycle_id = ''
	)

Here is the call graph for this function:

changeIssuePriority	(		$issue_id,
			$new_priority
	)

Here is the call graph for this function:

checkFilter

(

)

Here is the call graph for this function:

createError

(

$text

)

stack an error-message

Parameters

string

$text

the message to stack

Here is the caller graph for this function:

createId

(

)

creates an new id for this object private

Returns

string the unique id

Here is the caller graph for this function:

createInfo

(

$text

)

stack an info-message

Parameters

string

$text

the message to stack

Here is the caller graph for this function:

createMessage

(

$text

)

stack a success-message

Parameters

string

$text

the message to stack

Here is the caller graph for this function:

delete

(

)

Deletes the current seminar

Returns

void returns success-message if seminar could be deleted otherwise an error-message

Here is the call graph for this function:

deleteCycle

(

$cycle_id

)

Here is the call graph for this function:

deleteIssue

(

$issue_id

)

deleteMember

(

$user_id

)

deletes a user from the seminar by respecting the rule that at least one user with status "dozent" must stay there

Parameters

user_id	string: user_id of the user to delete
return,:	false or $this for chaining

Here is the call graph for this function:

deleteSingleDate	(		$date_id,
			$cycle_id = ''
	)

Here is the call graph for this function:

Here is the caller graph for this function:

editCycle

(

$data = array()

)

Change a regular timeslot of the seminar. The data is passed as an array conatining the following fields: start_stunde, start_minute, end_stunde, end_minute description, turnus, startWeek, day, sws

Parameters

array

$data

the cycle-data

Returns

void

Here is the call graph for this function:

getAdmissionChance

(

$studiengang_id = null

)

Here is the call graph for this function:

getAdmissionMembers

(

$status = 'awaiting'

)

Here is the call graph for this function:

getBookedRoomsTooltip

(

$cycle_id

)

Here is the call graph for this function:

getCycleColorClass

(

$cycle_id

)

Here is the call graph for this function:

getCycles

(

)

Here is the caller graph for this function:

getData

(

)

returns an asscociative array with the attributes of the seminar depending on the field-names in the database

Returns

array

getDatesExport

(

$params = array()

)

returns a representation without html of the seminar-dates

Parameters

array

optional variables which are passed to the template

Returns

string the representation of the dates without html

Author

Till Glöggler tgloe.nosp@m.ggl@.nosp@m.uos.d.nosp@m.e

Here is the call graph for this function:

Here is the caller graph for this function:

getDatesHTML

(

$params = array()

)

returns a html representation of the seminar-dates

Parameters

array

optional variables which are passed to the template

Returns

string the html-representation of the dates

Author

Till Glöggler tgloe.nosp@m.ggl@.nosp@m.uos.d.nosp@m.e

Here is the call graph for this function:

getDatesTemplate	(		$template,
			$params = array()
	)

returns a representation of the seminar-dates with a specifiable template

Parameters

mixed	this can be a template-object or a string pointing to a template in path_to_studip/templates
array	optional parameters which are passed to the template

Returns

string the template output of the dates

Author

Till Glöggler tgloe.nosp@m.ggl@.nosp@m.uos.d.nosp@m.e

Here is the call graph for this function:

Here is the caller graph for this function:

getDatesXML

(

$params = array()

)

returns a xml-representation of the seminar-dates

Parameters

array

optional variables which are passed to the template

Returns

string the xml-representation of the dates

Author

Till Glöggler tgloe.nosp@m.ggl@.nosp@m.uos.d.nosp@m.e

Here is the call graph for this function:

getDefaultGroup

(

)

Returns

int returns default colour group for new members (shown in meine_seminare.php)

Here is the call graph for this function:

getEndSemester

(

)

Here is the caller graph for this function:

getEndSemesterVorlesEnde

(

)

Here is the caller graph for this function:

getFirstDate

(

$return_mode = 'string'

)

Here is the call graph for this function:

Here is the caller graph for this function:

getFormattedPredominantRooms	(		$cycle_id,
			$link = true,
			$show = 3
	)

Here is the call graph for this function:

getFormattedTurnus

(

$short = FALSE

)

Here is the call graph for this function:

getFormattedTurnusDates

(

$short = FALSE

)

Here is the call graph for this function:

getFreeAdmissionSeats

(

$studiengang_id = null

)

Here is the call graph for this function:

Here is the caller graph for this function:

getFreeTextPredominantRoom

(

$cycle_id

)

getGroupedDates	(		$singledate = null,
			$metadate = null
	)

Here is the call graph for this function:

getId

(

)

Here is the caller graph for this function:

GetInstance	(		$id = false,
			$refresh_cache = false
	)

Here is the call graph for this function:

Here is the caller graph for this function:

getInstitutes

(

$sem_id = null

)

returns an array with all IDs of Institutes this seminar is related to

Parameters

sem_id

string: optional ID of a seminar, when null, this ID will be used

Returns

: array of IDs (not associative)

Here is the call graph for this function:

Here is the caller graph for this function:

getInstitutId

(

)

& getIssue

(

$issue_id

)

Here is the call graph for this function:

& getIssues

(

$force = false

)

Here is the call graph for this function:

Here is the caller graph for this function:

getMembers

(

$status = 'dozent'

)

Here is the call graph for this function:

Here is the caller graph for this function:

getMetaDateCount

(

)

getMetaDateType

(

)

always 1 since Stud.IP 1.6

Deprecated:

Returns

number

getMetaDateValue	(		$key,
			$value_name
	)

getName

(

)

getNextDate

(

$return_mode = 'string'

)

Here is the call graph for this function:

getNextMessage

(

)

return the next stacked messag-string

Returns

string a message-string

getNumber

(

)

return the field VeranstaltungsNummer for the seminar

Returns

string the seminar-number for the current seminar

getNumberOfParticipants

(

)

instance method

returns number of participants for each usergroup in seminar, total, lecturers, tutors, authors, users

Parameters

string

(optional) return count only for given usergroup

Returns

array

getNumberOfParticipantsBySeminarId

(

$sem_id

)

class method

returns number of participants for each usergroup in given seminar, total, lecturers, tutors, authors, users

Parameters

string	seminar_id
string	(optional) return count only for given usergroup

Returns

array

Here is the call graph for this function:

getPredominantRoom	(		$cycle_id,
			$list = FALSE
	)

getRequestsInfo

(

$cycle_id

)

Here is the call graph for this function:

getRoomRequestInfo

(

)

creates a textual, status-dependent representation of a room-request for a seminar.

Returns

string conatining room, responsible person, properties, current status and message / decline-message

Here is the call graph for this function:

getRoomRequestStatus

(

)

this function returns a human-readable status of a room-request, if any, false otherwise

the int-values of the states are: 0 - room-request is open 1 - room-request has been edited, but no confirmation has been sent 2 - room-request has been edited and a confirmation has been sent 3 - room-request has been declined

they are mapped with: 0 - open 1 - pending 2 - closed 3 - declined

Returns

string the mapped text

Here is the call graph for this function:

Here is the caller graph for this function:

getSemesterDurationTime

(

)

getSemesterStartTime

(

)

Here is the caller graph for this function:

GetSemIdByDateId

(

$date_id

)

Here is the call graph for this function:

Here is the caller graph for this function:

getSettings

(

)

returns an array of variables from the seminar-object, excluding variables containing objects or arrays

Returns

array

Here is the caller graph for this function:

& getSingleDate	(		$singleDateID,
			$cycle_id = ''
	)

Here is the call graph for this function:

& getSingleDates	(		$filter = false,
			$force = false,
			$include_deleted_dates = false
	)

Here is the call graph for this function:

Here is the caller graph for this function:

& getSingleDatesForCycle

(

$metadate_id

)

Here is the call graph for this function:

getStackedMessages

(

)

return all stacked messages as a multidimensional array

The array has the following structure: array( 'type' => ..., 'message' ... ) where type is one of error, info and success

Returns

mixed the array of stacked messages

getStartSemester

(

)

Here is the caller graph for this function:

getStartSemesterName

(

)

return the name of the seminars start-semester

Returns

string the name of the start-semester or false if there is no start-semester

getStartWeek

(

$metadate_id = false

)

getStatOfNotBookedRooms

(

$cycle_id

)

Here is the caller graph for this function:

getStatus

(

)

getStudyAreas

(

)

Returns the IDs of this course's study areas.

Returns

array an array of IDs

Here is the call graph for this function:

Here is the caller graph for this function:

getTurnus

(

$metadate_id = false

)

getUndecoratedData

(

$filter = false

)

This function returns an associative array of the dates owned by this seminar

Returns

mixed a multidimensional array of seminar-dates

Here is the call graph for this function:

Here is the caller graph for this function:

hasDatesOutOfDuration

(

$force = false

)

Here is the call graph for this function:

Here is the caller graph for this function:

hasRoomRequest

(

)

Here is the call graph for this function:

isAdmissionEnabled

(

)

Here is the caller graph for this function:

isAdmissionQuotaChecked

(

)

isAdmissionQuotaEnabled

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

isPublic

(

)

Returns

boolean returns TRUE if this course is publicly visible, FALSE otherwise

Here is the call graph for this function:

isStudygroup

(

)

Returns

boolean returns TRUE if this course is a studygroup, FALSE otherwise

Here is the caller graph for this function:

isVisible

(

)

processCommands

(

)

Here is the call graph for this function:

readIssues

(

$force = false

)

Here is the call graph for this function:

Here is the caller graph for this function:

readSingleDates	(		$force = FALSE,
			$filter = FALSE
	)

Here is the call graph for this function:

Here is the caller graph for this function:

readSingleDatesForCycle

(

$metadate_id

)

return an array of singledate-objects for the submitted cycle identified by metadate_id

Parameters

string

$metadate_id

the id identifying the cycle

Returns

mixed an array of singledate-objects

Here is the caller graph for this function:

registerCommand	(		$command,
			$function
	)

removeAndUpdateSingleDates

(

)

Here is the call graph for this function:

removeRequest	(		$singledate_id,
			$cycle_id = ''
	)

removes a room-request for a single date. If no cycle_id is given, the single date is an irregular date of the seminar, otherwise it is a single date of a regular entry.

Parameters

string	$singledate_id	the id of the date
string	$cycle_id	the metadate_id of the regular entry (optional)

Returns

boolean true on success

Here is the call graph for this function:

removeSeminarRequest

(

)

Here is the call graph for this function:

renumberIssuePrioritys

(

)

Here is the caller graph for this function:

restore

(

)

restore the data

the complete data of the object will be loaded from the db public

Exceptions

Exception

if there is no such course

Returns

boolean always true

Here is the call graph for this function:

Here is the caller graph for this function:

restoreAdmissionMembers

(

$status = 'awaiting'

)

Here is the call graph for this function:

Here is the caller graph for this function:

restoreAdmissionStudiengang

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

restoreMembers

(

$status = 'dozent'

)

Here is the call graph for this function:

Here is the caller graph for this function:

Seminar

(

$id = FALSE

)

Constructor

Pass nothing to create a seminar, or the seminar_id from an existing seminar to change or delete public

Parameters

string

$seminar_id

the seminar to be retrieved

Here is the call graph for this function:

Here is the caller graph for this function:

setEndSemester

(

$end

)

Here is the call graph for this function:

setFilter

(

$timestamp

)

Here is the call graph for this function:

setInstitutes

(

$institutes = array()

)

set the entries for seminar_inst table in database seminare.institut_id will always be added

Parameters

institutes

array: array of Institut_id's

Returns

bool: if something changed

Here is the call graph for this function:

setLabel	(		$user_id,
			$label
	)

Here is the call graph for this function:

setMemberPriority

(

$members

)

sets the almost never used column position in the table seminar_user

Parameters

members

array: array of user_id's - wrong IDs will be ignored

Returns

$this

Here is the call graph for this function:

setMetaDateValue	(		$key,
			$value_name,
			$value
	)

setStartSemester

(

$start

)

Here is the call graph for this function:

setStartWeek	(		$week,
			$metadate_id = false
	)

Here is the call graph for this function:

Here is the caller graph for this function:

setStudyAreas

(

$selected

)

Sets the study areas of this course.

Parameters

array

an array of IDs

Returns

void

Here is the call graph for this function:

setTurnus	(		$turnus,
			$metadate_id = false
	)

Here is the call graph for this function:

Here is the caller graph for this function:

store

(

$trigger_chdate = true

)

Here is the call graph for this function:

unDeleteSingleDate	(		$date_id,
			$cycle_id = ''
	)

Here is the call graph for this function:

Field Documentation

$filterEnd = 0

$filterStart = 0

$hasDatesOutOfDuration = -1

$id = null

$irregularSingleDates = null

$issues = null

$message_stack = array()

$messages = array()

$metadate = null

$semester = null

$user_number = 0

---

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

• lib/classes/Seminar.class.php