Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
CalendarWriterICalendar Class Reference
Inheritance diagram for CalendarWriterICalendar:
CalendarWriter

Public Member Functions

 __construct ()
 
 writeHeader ()
 
 writeFooter ()
 
 write (Event &$event)
 
 _exportUtcOffset ($value)
 
 _exportPeriod ($value)
 
 _exportDateTime ($value, $utc=false)
 
 _exportTime ($value, $utc=false)
 
 _exportDate ($value)
 
 _exportDuration ($value)
 
 _exportRecurrence ($value)
 
 _exportWdays ($value)
 
 _exportExDate ($value, $param)
 
 _exportExDateTime ($value, $param)
 
 getFacultyEmail ($user_id)
 
 _exportCategories ($event)
 
 _foldLine ($line)
 
- Public Member Functions inherited from CalendarWriter
 __construct ()
 
 write (Event &$event)
 
 writeHeader ()
 
 writeFooter ()
 
 getDefaultFilenameSuffix ()
 
 getFormat ()
 

Data Fields

 $newline = "\r\n"
 
- Data Fields inherited from CalendarWriter
 $default_filename_suffix
 
 $format
 
 $client_identifier
 

Constructor & Destructor Documentation

__construct ( )

Member Function Documentation

_exportCategories (   $event)
_exportDate (   $value)

Export a Date field

_exportDateTime (   $value,
  $utc = false 
)

Export a DateTime field

Parameters
int$valueUnix timestamp
Returns
String Date and time (UTC) iCalendar formatted
_exportDuration (   $value)

Export a duration value

_exportExDate (   $value,
  $param 
)
_exportExDateTime (   $value,
  $param 
)
_exportPeriod (   $value)

Export a Time Period field

Parameters
array$value
Returns
String Period field iCalendar formatted
_exportRecurrence (   $value)

Export a recurrence rule

_exportTime (   $value,
  $utc = false 
)

Export a Time field

Parameters
int$valueUnix timestamp
Returns
String Time (UTC) iCalendar formatted
_exportUtcOffset (   $value)

Export a UTC Offset field

Parameters
array$value
Returns
String UTC offset field iCalendar formatted
_exportWdays (   $value)

Return the Stud.IP calendar wdays attribute of a event recurrence

_foldLine (   $line)

Return the folded version of a line

getFacultyEmail (   $user_id)
write ( Event $event)

Export this component as iCalendar format

Parameters
object$eventThe event to export.
Returns
String iCalendar formatted data
writeFooter ( )
writeHeader ( )

Field Documentation

$newline = "\r\n"

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