SingleDate Class Reference

Public Member Functions
	getInstance ($singledate_id)
	__construct ($data='')
	__toString ()
	getStartTime ()
	setTime ($start, $end)
	getEndTime ()
	setComment ($comment)
	getComment ()
	getMetaDateID ()
	setMetaDateID ($id)
	getRangeID ()
	setDateType ($typ)
	getDateType ()
	getTypeName ()
	getAuthorID ()
	getChDate ()
	getMkDate ()
	setSeminarID ($seminar_id)
	getSeminarID ()
	getSingleDateID ()
	getResourceID ()
	getTerminID ()
	getFreeRoomText ()
	setFreeRoomText ($freeRoomText)
	getCycleID ()
	killIssue ()
	delete ()
	store ()
	restore ()
	setExTermin ($ex)
	isExTermin ()
	isPresence ()
	isUpdate ()
	isHoliday ()
	fillValuesFromArray ($daten)
	toString ()
	bookRoom ($room_id, $preparation_time=0)
	killAssign ()
	getRoom ()
	readIssueIDs ()
	getIssueIDs ()
	addIssueID ($issue_id)
	deleteIssueID ($issue_id)
	getMessages ()
	validate ($start=0, $end=0)
	getDatesHTML ($params=[])
	getDatesExport ($params=[])
	getDatesXML ($params=[])
	getDatesTemplate ($template)
	addRelatedPerson ($user_id)
	deleteRelatedPerson ($user_id)
	getRelatedPersons ()
	clearRelatedPersons ()
	addRelatedGroup ($statusgruppe_id)
	deleteRelatedGroup ($statusgruppe_id)
	getRelatedGroups ()
	clearRelatedGroups ()

Data Fields
	$termin_id = ''
	$date_typ = 1
	$metadate_id = ''
	$date = 0
	$end_time = 0
	$mkdate = 0
	$chdate = 0
	$orig_ex = false
	$ex_termin = false
	$range_id = ''
	$author_id = ''
	$resource_id = ''
	$raum = ''
	$request_id = NULL
	$requestData = NULL
	$update = false
	$issues = NULL
	$messages = NULL
	$content = ''
	$room_request = NULL
	$related_persons = []
	$related_groups = []

Protected Member Functions
	getOverlapMessage (ResourceBooking $booking)

Constructor & Destructor Documentation

__construct()

__construct

(

$data = ''

)

Member Function Documentation

__toString()

__toString

(

)

addIssueID()

addIssueID

(

$issue_id

)

addRelatedGroup()

addRelatedGroup

(

$statusgruppe_id

)

adds a given statusgruppe_id as a related group to the date

Parameters

string

$statusgruppe_id

statusgruppe_id from statusgruppen of the group to be added

addRelatedPerson()

addRelatedPerson

(

$user_id

)

adds a given user_id as a related person to the date

Parameters

string

$user_id

user_id from auth_user_md5 of the person to be added

bookRoom()

bookRoom	(		$room_id,
			$preparation_time = 0
	)

clearRelatedGroups()

clearRelatedGroups

(

)

clears all related groups

clearRelatedPersons()

clearRelatedPersons

(

)

clears all related persons (in the interface this means that all dozents are marked as related to the date)

delete()

delete

(

)

deleteIssueID()

deleteIssueID

(

$issue_id

)

deleteRelatedGroup()

deleteRelatedGroup

(

$statusgruppe_id

)

unsets a given statusgruppe_id from the array of related statusgruppen

Parameters

string

$statusgruppe_id

statusgruppe_id from statusgruppen of the group to be removed

deleteRelatedPerson()

deleteRelatedPerson

(

$user_id

)

unsets a given user_id from the array of related persons

Parameters

string

$user_id

user_id from auth_user_md5 of the person to be added

fillValuesFromArray()

fillValuesFromArray

(

$daten

)

getAuthorID()

getAuthorID

(

)

getChDate()

getChDate

(

)

getComment()

getComment

(

)

getCycleID()

getCycleID

(

)

getDatesExport()

getDatesExport

(

$params = []

)

returns a representation without html of the date

Parameters

array

optional variables which are passed to the template

Returns

string the representation of the date without html

Author

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

getDatesHTML()

getDatesHTML

(

$params = []

)

returns a html representation of the date

Parameters

array

optional variables which are passed to the template

Returns

string the html-representation of the date

Author

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

getDatesTemplate()

getDatesTemplate

(

$template

)

returns a representation of the date with a specifiable template

Parameters

mixed

this can be a template-object or a string pointing to a template in path_to_studip/templates

Returns

string the template output of the date

Author

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

getDatesXML()

getDatesXML

(

$params = []

)

returns a xml-representation of the date

Parameters

array

optional variables which are passed to the template

Returns

string the xml-representation of the date

Author

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

getDateType()

getDateType

(

)

getEndTime()

getEndTime

(

)

getFreeRoomText()

getFreeRoomText

(

)

getInstance()

getInstance

(

$singledate_id

)

Return the SingleDate instance of the given id

Parameters

string

the id of the instance

Returns

SingleDate the SingleDate instance

getIssueIDs()

getIssueIDs

(

)

getMessages()

getMessages

(

)

getMetaDateID()

getMetaDateID

(

)

getMkDate()

getMkDate

(

)

getOverlapMessage()

getOverlapMessage ( ResourceBooking  $booking )

protected

This method converts overlap data about an overlapping booking to a string that can be used to output overlap information to the user. Only one overlap is converted by this method. For multiple overlaps this method must be called multiple times.

Parameters

ResourceBooking

$booking

The overlapping booking.

Returns

string A string representation of the overlap.

getRangeID()

getRangeID

(

)

getRelatedGroups()

getRelatedGroups

(

)

gets all statusgruppe_ids of related groups of this date

Returns

array of statusgruppe_ids

getRelatedPersons()

getRelatedPersons

(

)

gets all user_ids of related persons of this date

Returns

array of user_ids

getResourceID()

getResourceID

(

)

getRoom()

getRoom

(

)

Returns the room name for this SingleDate object.

Returns

string The room name.

getSeminarID()

getSeminarID

(

)

getSingleDateID()

getSingleDateID

(

)

getStartTime()

getStartTime

(

)

getTerminID()

getTerminID

(

)

getTypeName()

getTypeName

(

)

isExTermin()

isExTermin

(

)

isHoliday()

isHoliday

(

)

isPresence()

isPresence

(

)

isUpdate()

isUpdate

(

)

killAssign()

killAssign

(

)

killIssue()

killIssue

(

)

readIssueIDs()

readIssueIDs

(

)

restore()

restore

(

)

setComment()

setComment

(

$comment

)

setDateType()

setDateType

(

$typ

)

setExTermin()

setExTermin

(

$ex

)

setFreeRoomText()

setFreeRoomText

(

$freeRoomText

)

setMetaDateID()

setMetaDateID

(

$id

)

setSeminarID()

setSeminarID

(

$seminar_id

)

setTime()

setTime	(		$start,
			$end
	)

store()

store

(

)

toString()

toString

(

)

validate()

validate	(		$start = 0,
			$end = 0
	)

Field Documentation

$author_id

$author_id = ''

$chdate

$chdate = 0

$content

$content = ''

$date

$date = 0

$date_typ

$date_typ = 1

$end_time

$end_time = 0

$ex_termin

$ex_termin = false

$issues

$issues = NULL

$messages

$messages = NULL

$metadate_id

$metadate_id = ''

$mkdate

$mkdate = 0

$orig_ex

$orig_ex = false

$range_id

$range_id = ''

$raum

$raum = ''

$related_groups

$related_groups = []

$related_persons

$related_persons = []

$request_id

$request_id = NULL

$requestData

$requestData = NULL

$resource_id

$resource_id = ''

$room_request

$room_request = NULL

$termin_id

$termin_id = ''

$update

$update = false

---

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

• lib/raumzeit/SingleDate.class.php