Docs For Class Kronolith_Driver_kolab_wrapper

Description

Horde Kronolith driver for the Kolab IMAP Server.

See the enclosed file LICENSE for license information (ASL). If you did not receive this file, see http://www.horde.org/licenses/asl.php.

author: Gunnar Wrobel <wrobel@pardus.de>
author: Stuart Binge <omicron@mighty.co.za>

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

Kronolith_Driver_kolab_wrapper
   |
   --Kronolith_Driver_kolab_wrapper_old

Variable Summary

boolean $_connected

Method Summary

mixed connect (int $loader)

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

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)

mixed rename (string $from, string $to)

void reset ()

void saveEvent ( &$event)

Variables

boolean $_connected = false (line 239)

Indicates if the wrapper has connected or not

Inherited Variables

Inherited from Kronolith_Driver_kolab_wrapper

Kronolith_Driver_kolab_wrapper::$_driver
Kronolith_Driver_kolab_wrapper::$_kolab

Methods

connect (line 257)

Connect to the Kolab backend

return: True on success, a PEAR error otherwise

mixed connect (int $loader)

int $loader: The version of the XML loader

delete (line 704)

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

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

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

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

void &getEvent ([ $eventID = null])

$eventID

listAlarms (line 273)

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

$date
$fullevent

listEvents (line 367)

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

move (line 683)

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

rename (line 718)

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.

reset (line 244)

Reset internal variable on share change

void reset ()

saveEvent (line 456)

void saveEvent ( &$event)

&$event

Inherited Methods

Inherited From Kronolith_Driver_kolab_wrapper

Kronolith_Driver_kolab_wrapper::Kronolith_Driver_kolab_wrapper()