Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
SingleDate Class Reference

Public Member Functions

 getInstance ($singledate_id)
 
 __construct ($data= '')
 
 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 ($keepIssues=false)
 
 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 (   $data = '')

Member Function Documentation

addIssueID (   $issue_id)
addRelatedGroup (   $statusgruppe_id)

adds a given statusgruppe_id as a related group to the date

Parameters
string$statusgruppe_idstatusgruppe_id from statusgruppen of the group to be added
addRelatedPerson (   $user_id)

adds a given user_id as a related person to the date

Parameters
string$user_iduser_id from auth_user_md5 of the person to be added
bookRoom (   $room_id,
  $preparation_time = 0 
)
clearRelatedGroups ( )

clears all related groups

clearRelatedPersons ( )

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

delete (   $keepIssues = false)
deleteIssueID (   $issue_id)
deleteRelatedGroup (   $statusgruppe_id)

unsets a given statusgruppe_id from the array of related statusgruppen

Parameters
string$statusgruppe_idstatusgruppe_id from statusgruppen of the group to be removed
deleteRelatedPerson (   $user_id)

unsets a given user_id from the array of related persons

Parameters
string$user_iduser_id from auth_user_md5 of the person to be added
fillValuesFromArray (   $daten)
getAuthorID ( )
getChDate ( )
getComment ( )
getCycleID ( )
getDatesExport (   $params = [])

returns a representation without html of the date

Parameters
arrayoptional 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 (   $params = [])

returns a html representation of the date

Parameters
arrayoptional 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 (   $template)

returns a representation of the date with a specifiable template

Parameters
mixedthis 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 (   $params = [])

returns a xml-representation of the date

Parameters
arrayoptional 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 ( )
getEndTime ( )
getFreeRoomText ( )
getInstance (   $singledate_id)

Return the SingleDate instance of the given id

Parameters
stringthe id of the instance
Returns
SingleDate the SingleDate instance
getIssueIDs ( )
getMessages ( )
getMetaDateID ( )
getMkDate ( )
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$bookingThe overlapping booking.
Returns
string A string representation of the overlap.
getRangeID ( )
getRelatedGroups ( )

gets all statusgruppe_ids of related groups of this date

Returns
array of statusgruppe_ids
getRelatedPersons ( )

gets all user_ids of related persons of this date

Returns
array of user_ids
getResourceID ( )
getRoom ( )

Returns the room name for this SingleDate object.

Returns
string The room name.
getSeminarID ( )
getSingleDateID ( )
getStartTime ( )
getTerminID ( )
getTypeName ( )
isExTermin ( )
isHoliday ( )
isPresence ( )
isUpdate ( )
killAssign ( )
killIssue ( )
readIssueIDs ( )
restore ( )
setComment (   $comment)
setDateType (   $typ)
setExTermin (   $ex)
setFreeRoomText (   $freeRoomText)
setMetaDateID (   $id)
setSeminarID (   $seminar_id)
setTime (   $start,
  $end 
)
store ( )
toString ( )
validate (   $start = 0,
  $end = 0 
)

Field Documentation

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

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