Docs For Class Kronolith_Driver

Description

Horde Kronolith driver for the Kolab IMAP Server.

$Horde: kronolith/lib/Driver/kolab.php,v 1.16.2.32 2010-09-23 17:59:12 wrobel Exp $

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

author: Thomas Jarosch <thomas.jarosch@intra2net.com>
author: Gunnar Wrobel <wrobel@pardus.de>
author: Stuart Binge <omicron@mighty.co.za>
since: Kronolith 2.0

Located in /lib/Driver/kolab.php (line 21)

Kronolith_Driver
   |
   --Kronolith_Driver_kolab

Variable Summary

Kolab $_kolab

Kronolith_Driver_kolab_wrapper $_wrapper

Method Summary

mixed delete (string $calendar)

mixed deleteEvent ( $eventID, [ $silent = false], string $eventId)

mixed exists (string $uid, [string $calendar_id = null])

Kronolith_Event &getByUID (string $uid, [array $calendars = null], [boolean $getAll = false])

void &getEvent ([ $eventID = null])

boolean initialize ()

void listAlarms ( $date, [ $fullevent = false])

array listEvents ([ $startDate = null], [ $endDate = null], [boolean $hasAlarm = false], Horde_Date $startInterval, Horde_Date $endInterval)

void move ( $eventID, string $newCalendar, string $eventId)

void open ( $calendar)

mixed rename (string $from, string $to)

void saveEvent ( &$event)

Variables

Kolab $_kolab = null (line 28)

Our Kolab server connection.

Kronolith_Driver_kolab_wrapper $_wrapper = null (line 35)

The wrapper to decide between the Kolab implementation

Inherited Variables

Inherited from Kronolith_Driver

Kronolith_Driver::$_calendar
Kronolith_Driver::$_errormsg
Kronolith_Driver::$_params

Methods

delete (line 147)

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 172)

Delete an event.

return: True or a PEAR_Error on failure.

mixed deleteEvent ( $eventID, [ $silent = false], string $eventId)

string $eventId: The ID of the event to delete.
$eventID
$silent

exists (line 83)

Checks if the event's UID already exists and returns all event ids with that UID.

return: Returns a string with event_id or false if not found.

mixed exists (string $uid, [string $calendar_id = null])

string $uid: The event's uid.
string $calendar_id: Calendar to search in.

getByUID (line 119)

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 104)

void &getEvent ([ $eventID = null])

$eventID

Redefinition of:

Kronolith_Driver::getEvent(): Stub to be overridden in the child class.

initialize (line 42)

Attempts to open a Kolab Groupware folder.

return: True on success, PEAR_Error on failure.

boolean initialize ()

Redefinition of:

Kronolith_Driver::initialize(): Stub to initiate a driver.

listAlarms (line 69)

void listAlarms ( $date, [ $fullevent = false])

$date
$fullevent

Redefinition of:

Kronolith_Driver::listAlarms(): Stub to be overridden in the child class.

listEvents (line 99)

Lists all events in the time range, optionally restricting results to only events with alarms.

return: Events in the given time range.

array listEvents ([ $startDate = null], [ $endDate = null], [boolean $hasAlarm = false], Horde_Date $startInterval, Horde_Date $endInterval)

Horde_Date $startInterval: Start of range date object.
Horde_Date $endInterval: End of range date object.
boolean $hasAlarm
: Only return events with alarms? Defaults to
1. false
.
$startDate
$endDate

Redefinition of:

Kronolith_Driver::listEvents(): Stub to be overridden in the child class.

move (line 135)

Move an event to a new calendar.

void move ( $eventID, string $newCalendar, string $eventId)

string $eventId: The event to move.
string $newCalendar: The new calendar.
$eventID

open (line 59)

Change current calendar

void open ( $calendar)

$calendar

Redefinition of:

Kronolith_Driver::open()

rename (line 160)

Rename a calendar.

return: True or a PEAR_Error on failure.

mixed rename (string $from, string $to)

string $from: The current name of the calendar.
string $to: The new name of the calendar.

Redefinition of:

Kronolith_Driver::rename(): Renames a calendar.

saveEvent (line 124)

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()