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

Public Member Functions

 __construct ($cycle_data=FALSE)
 
 getDescription ()
 
 getCycleDate ()
 
 setDescription ($description)
 
 setStart ($start_stunde, $start_minute)
 
 setEnd ($end_stunde, $end_minute)
 
 getStartStunde ()
 
 getStartMinute ()
 
 getEndStunde ()
 
 getEndMinute ()
 
 getMetaDateID ()
 
 getDay ()
 
 getStartTime ()
 
 getEndTime ()
 
 setDay ($day)
 
 getIsVisible ()
 
 __get ($field)
 
 __set ($field, $value)
 
 __isset ($field)
 
 storeCycleDate ()
 
 store ()
 
 restore ()
 
 delete ($removeSingles=TRUE)
 
 deleteSingleDate ($date_id, $filterStart, $filterEnd)
 
 unDeleteSingleDate ($date_id, $filterStart, $filterEnd)
 
 readSingleDates ($start=0, $end=0)
 
 getSingleDates ()
 
 getFreeTextPredominantRoom ($filterStart=0, $filterEnd=0)
 
 getPredominantRoom ($filterStart=0, $filterEnd=0)
 
 toString ($short=false)
 
 toArray ()
 
 autoAssignIssues ($themen, $filterStart, $filterEnd)
 

Data Fields

 $termine = NULL
 

Constructor & Destructor Documentation

__construct (   $cycle_data = FALSE)

Constructor

Parameters
SeminarCycleDate|array

Member Function Documentation

__get (   $field)
__isset (   $field)
__set (   $field,
  $value 
)
autoAssignIssues (   $themen,
  $filterStart,
  $filterEnd 
)

assign single dates one by one to a list of issues seems not to be the right place for this method

Parameters
array$themen
int$filterStart
int$filterEnd
delete (   $removeSingles = TRUE)

deletes cycledate and corresponding single dates

Parameters
boolean$removeSingles
Returns
boolean
deleteSingleDate (   $date_id,
  $filterStart,
  $filterEnd 
)

this does not delete a single date, but set it to be marked as to not take place. do not use!

Parameters
sting$date_id
int$filterStart
int$filterEnd
getCycleDate ( )
getDay ( )
getDescription ( )
getEndMinute ( )
getEndStunde ( )
getEndTime ( )
getFreeTextPredominantRoom (   $filterStart = 0,
  $filterEnd = 0 
)

returns an assoc array, keys are room names values are number of dates for this room give timestamps as params to filter by time range

Parameters
int$filterStart
int$filterEnd
Returns
array|false
getIsVisible ( )

Check if there is a least one not cancelled date for this cycle data

Returns
bool true, if there is at least one not cancelled date
getMetaDateID ( )
getPredominantRoom (   $filterStart = 0,
  $filterEnd = 0 
)

returns an assoc array, keys are resource_id of rooms values are number of dates for this room give timestamps as params to filter by time range

Parameters
int$filterStart
int$filterEnd
Returns
array
getSingleDates ( )

get the currently loaded single dates, or all when no dates are loaded. you must use readSingleDates() before to be shure what to get!

Returns
array of SingleDate
getStartMinute ( )
getStartStunde ( )
getStartTime ( )
readSingleDates (   $start = 0,
  $end = 0 
)

load corresponding single dates from database give timestamps as params to filter by time range

Parameters
int$start
int$end
Returns
boolean
restore ( )

refreshes the currently loaded single dates from database, does not reload cycledate data! should be private

Returns
boolean
setDay (   $day)
setDescription (   $description)
setEnd (   $end_stunde,
  $end_minute 
)
setStart (   $start_stunde,
  $start_minute 
)
store ( )

stores the single dates belonging to this cycledate, but only the ones which are currently loaded! (see readSingleDates()) should be private

Returns
boolean
storeCycleDate ( )

stores only the cycledate data

Returns
boolean
toArray ( )

return all fields from SeminarCycleDate and old style metadata_dates, combined with info about rooms

Returns
array
toString (   $short = false)

returns a formatted string for cycledate

See Also
SeminarCycleDate::toString()
Parameters
boolean$short
Returns
string
unDeleteSingleDate (   $date_id,
  $filterStart,
  $filterEnd 
)

this should ressurect a single date whis is marked as to not take place. do not use!

Parameters
sting$date_id
int$filterStart
int$filterEnd

Field Documentation

$termine = NULL

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