Class Kronolith_Driver_Kolab

Horde Kronolith driver for the Kolab IMAP Server.

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

Kronolith_Driver

Kronolith_Driver_Kolab

Package: Kronolith
Author: Thomas Jarosch thomas.jarosch@intra2net.com
Author: Gunnar Wrobel wrobel@pardus.de
Author: Stuart Binge omicron@mighty.co.za
Located at Driver/Kolab.php

Methods summary
`public`	# `initialize( )` Attempts to open a Kolab Groupware folder. Attempts to open a Kolab Groupware folder. Throws `Kronolith_Exception` Overrides `Kronolith_Driver::initialize()`
`public`	# `open( string $calendar )` Selects a calendar as the currently opened calendar. Selects a calendar as the currently opened calendar. Parameters `$calendar` A calendar identifier. Overrides `Kronolith_Driver::open()`
`public string`	# `backgroundColor( )` Returns the background color of the current calendar. Returns the background color of the current calendar. Returns `string` The calendar color. Overrides `Kronolith_Driver::backgroundColor()`
`public`	# `reset( )` Reset internal variable on share change Reset internal variable on share change
`public`	# `synchronize( mixed $force = false )`
`public`	# `listAlarms( mixed $date, mixed $fullevent = false )` Throws `Kronolith_Exception` Overrides `Kronolith_Driver::listAlarms()`
`public string\|boolean`	# `exists( string $uid, string $calendar_id = null )` Checks if the event's UID already exists and returns all event ids with that UID. Checks if the event's UID already exists and returns all event ids with that UID. Parameters `$uid` The event's uid. `$calendar_id` Calendar to search in. Returns `string\|boolean` Returns a string with event_id or false if not found. Throws `Kronolith_Exception` Overrides `Kronolith_Driver::exists()`
`public array`	# `listEvents( Horde_Date $startDate = null, Horde_Date $endDate = null, boolean $showRecurrence = false, boolean $hasAlarm = false, boolean $json = false, boolean $coverDates = true, mixed $fetchTags = false )` Lists all events in the time range, optionally restricting results to only events with alarms. Lists all events in the time range, optionally restricting results to only events with alarms. Parameters `$startDate` $startInterval Start of range date object. `$endDate` $endInterval End of range data object. `$showRecurrence` <p>Return every instance of a recurring event? If false, will only return recurring events once inside the $startDate - $endDate range.</p> `$hasAlarm` Only return events with alarms? `$json` <p>Store the results of the events' toJson() method?</p> `$coverDates` <p>Whether to add the events to all days that they cover.</p> `$fetchTags` Returns `array` Events in the given time range. Throws `Kronolith_Exception` Overrides `Kronolith_Driver::listEvents()`
`public`	# `getEvent( mixed $eventId = null )` Throws `Kronolith_Exception` Horde_Exception_NotFound Overrides `Kronolith_Driver::getEvent()`
`public Kronolith_Event`	# `getByUID( string $uid, array $calendars = null, boolean $getAll = false )` Get an event or events with the given UID value. Get an event or events with the given UID value. Parameters `$uid` The UID to match `$calendars` A restricted array of calendar ids to search `$getAll` <p>Return all matching events? If this is false, an error will be returned if more than one event is found.</p> Returns `Kronolith_Event` Throws `Kronolith_Exception` Horde_Exception_NotFound Overrides `Kronolith_Driver::getByUID()`
`public`	# `delete( string $calendar )` Delete a calendar and all its events. Delete a calendar and all its events. Parameters `$calendar` The name of the calendar to delete. Throws `Kronolith_Exception` Overrides `Kronolith_Driver::delete()`
`public`	# `deleteEvent( string $eventId, mixed $silent = false )` Delete an event. Delete an event. Parameters `$eventId` The ID of the event to delete. `$silent` Throws `Kronolith_Exception` Horde_Exception_NotFound Horde_Mime_Exception Overrides `Kronolith_Driver::deleteEvent()`

Methods inherited from Kronolith_Driver
`__construct(), colors(), countEvents(), filterEventsByCalendar(), getParam(), move(), nextRecurrence(), saveEvent(), search(), setParam(), setParams()`

Properties inherited from Kronolith_Driver
`$backgroundColor, $calendar, $foregroundColor`

Packages

Classes

Class Kronolith_Driver_Kolab

Throws

Overrides

Parameters

Overrides

Returns

Overrides

Throws

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Throws

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Throws

Overrides

Parameters

Throws

Overrides