Class Kronolith_Driver_ical

Description

The Kronolith_Driver_ical:: class implements the Kronolith_Driver API for iCalendar data.

$Horde: kronolith/lib/Driver/ical.php,v 1.3.2.6 2008/04/30 21:33:20 chuck Exp $

Located in /lib/Driver/ical.php (line 12)

Kronolith_Driver
   |
   --Kronolith_Driver_ical
Variable Summary
 array $_cache
Method Summary
 mixed delete (string $calendar)
 mixed deleteEvent (string $eventId)
 void exists ()
 Kronolith_Event &getByUID (string $uid, [array $calendars = null], [boolean $getAll = false])
 void &getEvent ([ $eventId = null])
 void listAlarms ( $date, [ $fullevent = false])
 void listEvents ([ $startDate = null], [ $endDate = null], [ $hasAlarm = false])
 void move (string $eventId, string $newCalendar)
 void saveEvent ( $event)
Variables
array $_cache = array() (line 20)

Cache events as we fetch them to avoid fetching or parsing the same event twice.

Inherited Variables

Inherited from Kronolith_Driver

Kronolith_Driver::$_calendar
Kronolith_Driver::$_errormsg
Kronolith_Driver::$_params
Methods
delete (line 126)

Delete a calendar and all its events.

  • return: True or a PEAR_Error on failure.
mixed delete (string $calendar)
  • string $calendar: The name of the calendar to delete.
deleteEvent (line 138)

Delete an event.

  • return: True or a PEAR_Error on failure.
mixed deleteEvent (string $eventId)
  • string $eventId: The ID of the event to delete.
exists (line 98)
void exists ()
getByUID (line 93)

Get an event or events with the given UID value.

Kronolith_Event &getByUID (string $uid, [array $calendars = null], [boolean $getAll = false])
  • string $uid: The UID to match
  • array $calendars: A restricted array of calendar ids to search
  • boolean $getAll: Return all matching events? If this is false, an error will be returned if more than one event is found.
getEvent (line 57)
void &getEvent ([ $eventId = null])
  • $eventId

Redefinition of:
Kronolith_Driver::getEvent()
Stub to be overridden in the child class.
listAlarms (line 22)
void listAlarms ( $date, [ $fullevent = false])
  • $date
  • $fullevent

Redefinition of:
Kronolith_Driver::listAlarms()
Stub to be overridden in the child class.
listEvents (line 27)
void listEvents ([ $startDate = null], [ $endDate = null], [ $hasAlarm = false])
  • $startDate
  • $endDate
  • $hasAlarm

Redefinition of:
Kronolith_Driver::listEvents()
Stub to be overridden in the child class.
move (line 114)

Move an event to a new calendar.

void move (string $eventId, string $newCalendar)
  • string $eventId: The event to move.
  • string $newCalendar: The new calendar.
saveEvent (line 103)
void saveEvent ( $event)
  • $event

Redefinition of:
Kronolith_Driver::saveEvent()
Stub o be overridden in the child class.

Inherited Methods

Inherited From Kronolith_Driver

 Kronolith_Driver::Kronolith_Driver()
 Kronolith_Driver::factory()
 Kronolith_Driver::generateUID()
 Kronolith_Driver::getCalendar()
 Kronolith_Driver::getEvent()
 Kronolith_Driver::initialize()
 Kronolith_Driver::listAlarms()
 Kronolith_Driver::listEvents()
 Kronolith_Driver::nextRecurrence()
 Kronolith_Driver::open()
 Kronolith_Driver::removeUserData()
 Kronolith_Driver::rename()
 Kronolith_Driver::saveEvent()
 Kronolith_Driver::search()

Documentation generated on Sun, 30 Jan 2011 05:31:46 +0000 by phpDocumentor 1.4.3