SVEvent Class Reference
[Calendar Generators]

A calendar event that can be exported in VCalendar format. More...

List of all members.

Public Member Functions
	render ()
	Render this event in VCalendar format.
	setAllDay ($allDay)
	Set whether this is an all day event.
	setEndDate ($date)
	Set the end date of the event.
	setRepeat ($frequency, $endRepeat='')
	Set whether and how this event repeats.
	setStartDate ($date)
	Set the start date of the event.

---

Detailed Description

A calendar event that can be exported in VCalendar format.

This class represents a calendar event, exportable in VCalendar (iCal-compatible) format for inclusion in a complete calendar file. An event has a start and end date/time, and can be all day or can repeat.

Author:

Valerie Gartland <valerie@shodor.org>

Jonathan Stuart-Moore <jwsm@shodor.org>

---

Member Function Documentation

SVEvent::render

(

)

Render this event in VCalendar format.

Render this event in VCalendar format for inclusion in a complete VCalendar file with proper headers, etc.

Returns:

[string]: This object encoded in VCalendar format

SVEvent::setAllDay

(

$

allDay

)

Set whether this is an all day event.

Parameters:

$allDay

[bool]: True if an all day event, false otherwise (default is false)

SVEvent::setEndDate

(

$

date

)

Set the end date of the event.

Parameters:

$date

[string]: The end date of this event, in the format, 'YYYY-MM-DD'

SVEvent::setRepeat	(	$	frequency,
		$	endRepeat = ''
	)

Set whether and how this event repeats.

Update the repeat frequency to one of the allowed frequencies:

• SVEvent::FREQ_NONE -- Don't repeat
• SVEvent::FREQ_YEAR -- Repeat yearly
• SVEvent::FREQ_MONTH -- Repeat monthly
• SVEvent::FREQ_WEEK -- Repeat weekly
• SVEvent::FREQ_DAY -- Repeat daily Also, set an end date when the repeating event should stop.

Parameters:

	$frequency	[string]: A repeat frequency (one of the class constants)
	$endRepeat	[string]: The date for ending repeats, in the format, 'YYYY-MM-DD'

SVEvent::setStartDate

(

$

date

)

Set the start date of the event.

Parameters:

$date

[string]: The start date of this event, in the format, 'YYYY-MM-DD'

---

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

• content/SVEvent.php5