FreeMED. vCalendarEvent

Class to encapsulate a single vCalendar event.

Summary
Class to encapsulate a single vCalendar event.
Produce the text of a singular vCalendar event.
Form a proper description of the event so that it is human-readable.
Generate text location.
Generate vCalendar formatted start time.
Generate vCalendar formatted end time.
Internal method to convert timestamps into vCalendar format times.
Internal method to convert regular text into vCalendar formatted text.

Functions

vCalendarEvent constructor

Parameters

$eventIf passed as a number, this denotes the scheduler table identifier.  If passed as an array, this is the record from the scheduler table, as returned by freemed::get_link_rec.

generate

function generate ( )

Produce the text of a singular vCalendar event.

Returns

vCalendar event to be included in vCalendar export.

description

function description ( )

Form a proper description of the event so that it is human-readable.

Returns

Human readable event description.

location

function location ( )

Generate text location.

Returns

Textual location.

start_time

function start_time ( )

Generate vCalendar formatted start time.

Returns

vCalendar formatted start time for this event.

end_time

function end_time ( )

Generate vCalendar formatted end time.

Returns

vCalendar formatted end time for this event.

_ts2vcal

function _ts2vcal ($timestamp)

Internal method to convert timestamps into vCalendar format times.

Parameters

$timestampUNIX timestamp

Returns

vCalendar format date.

See Also

_txt2vcal

_text2vcal

Internal method to convert regular text into vCalendar formatted text. vCalendar uses MIME-style line breaks.

For now, we break it into comma separated lines for ease of reading.

Parameters

$textStandard text.

Returns

vCalendar format text.

See Also

_ts2vcal

function generate ( )
Produce the text of a singular vCalendar event.
function description ( )
Form a proper description of the event so that it is human-readable.
function location ( )
Generate text location.
function start_time ( )
Generate vCalendar formatted start time.
function end_time ( )
Generate vCalendar formatted end time.
function _ts2vcal ($timestamp)
Internal method to convert timestamps into vCalendar format times.
Get a database table record by its “id” field.