ICalendarExport Class Reference

Public Member Functions
	__construct ()
	exportCalendarDates (string $range_id, DateTimeInterface $start, DateTimeInterface $end)
	exportCourseDates (string $user_id, DateTimeInterface $start, DateTimeInterface $end)
	exportCourseExDates (string $user_id, DateTimeInterface $start, DateTimeInterface $end)
	prepareCalendarDate (CalendarDate $date)
	prepareCourseDate ($date)
	writeHeader ()
	writeFooter ()
	writeICalEvent (array $properties)
	quoteText (string $text)
	_exportDateTime ($value, $utc=false)
	_exportTime ($value, $utc=false)
	_exportDate ($value)
	_exportRecurrence ($value)
	_exportWdays (string $value)
	exportExDate (string $value)
	exportExDateTime (string $value, int $begin)

Data Fields
const	NEWLINE = "\r\n"
const	WEEKSTART = 'MO'
string	$format

Constructor & Destructor Documentation

__construct()

__construct

(

)

Member Function Documentation

_exportDate()

_exportDate

(

$value

)

Export a Date field

_exportDateTime()

_exportDateTime	(		$value,
			$utc = false
	)

Export a DateTime field

Parameters

int

$value

Unix timestamp

Returns

String Date and time (UTC) iCalendar formatted

_exportRecurrence()

_exportRecurrence

(

$value

)

Export a recurrence rule

_exportTime()

_exportTime	(		$value,
			$utc = false
	)

Export a Time field

Parameters

int

$value

Unix timestamp

Returns

String Time (UTC) iCalendar formatted

_exportWdays()

_exportWdays

(

string

$value

)

Return the days from CalendarDate::days as attribute of a event recurrence.

Parameters

string

$value

Returns

string

exportCalendarDates()

exportCalendarDates	(	string	$range_id,
		DateTimeInterface	$start,
		DateTimeInterface	$end
	)

exportCourseDates()

exportCourseDates	(	string	$user_id,
		DateTimeInterface	$start,
		DateTimeInterface	$end
	)

exportCourseExDates()

exportCourseExDates	(	string	$user_id,
		DateTimeInterface	$start,
		DateTimeInterface	$end
	)

exportExDate()

exportExDate

(

string

$value

)

Formats dates of exception.

Parameters

string

$value

Date values (Y-m-d) as csv list.

Returns

string The formatted Exceptions.

exportExDateTime()

exportExDateTime	(	string	$value,
		int	$begin
	)

Formats date times of exception.

Parameters

string	$value	Date values (Y-m-d) as csv list.
int	$begin	Start date of event as unix timestamp.

Returns

string The formatted Exceptions.

prepareCalendarDate()

prepareCalendarDate

(

CalendarDate

$date

)

Parameters

CalendarDate

$date

The calendar date to export.

Returns

array Calendar date data prepared for export.

prepareCourseDate()

prepareCourseDate

(

$date

)

Parameters

CourseDate  |  CourseExDate

$date

The course date to export.

Returns

array Course date data prepared for export.

quoteText()

quoteText

(

string

$text

)

Quotes some characters accordingly to iCalendar format.

Parameters

string

$text

The text to quote.

Returns

string The quoted text.

writeFooter()

writeFooter

(

)

Returns the footer.

Returns

string

writeHeader()

writeHeader

(

)

Returns an iCalendar header with a rudimentary time zone definition.

Returns

string The iCalendar header.

writeICalEvent()

writeICalEvent

(

array

$properties

)

Export prepared calendar data as iCalendar.

Parameters

array

$properties

The event to export.

Returns

string iCalendar formatted data

Field Documentation

$format

string $format

NEWLINE

const NEWLINE = "\r\n"

Line break used in iCalendar

WEEKSTART

const WEEKSTART = 'MO'

Default start of the week

---

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

• lib/classes/calendar/ICalendarExport.php