Class Kronolith_Driver_kolab_wrapper_new

Description

Horde Kronolith driver for the Kolab IMAP Server.

Copyright 2004-2009 The Horde Project (http://www.horde.org/)

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

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

Kronolith_Driver_kolab_wrapper
   |
   --Kronolith_Driver_kolab_wrapper_new
Variable Summary
 Kolab_IMAP $_store
 boolean $_synchronized
Method Summary
 Kronolith_Driver_kolab_wrapper_new Kronolith_Driver_kolab_wrapper_new ( &$driver)
 mixed delete (string $calendar)
 mixed deleteEvent (string $eventId, [ $silent = false])
 string|boolean 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 (string $eventId, string $newCalendar)
 mixed rename (string $from, string $to)
 void reset ()
 mixed saveEvent ( &$event, Kronolith_Event_new $event)
 void synchronize ([ $force = false])
Variables
array $_events_cache (line 969)

Internal cache of Kronolith_Event_kolab_new. eventID/UID is key

Kolab_IMAP $_store (line 983)

Shortcut to the imap connection

boolean $_synchronized (line 976)

Indicates if we have synchronized this folder

Inherited Variables

Inherited from Kronolith_Driver_kolab_wrapper

Kronolith_Driver_kolab_wrapper::$_driver
Kronolith_Driver_kolab_wrapper::$_kolab
Methods
Constructor Kronolith_Driver_kolab_wrapper_new (line 988)

Constructor

Kronolith_Driver_kolab_wrapper_new Kronolith_Driver_kolab_wrapper_new ( &$driver)
  • &$driver
delete (line 1342)

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

Delete an event.

  • return: True or a PEAR_Error on failure.
mixed deleteEvent (string $eventId, [ $silent = false])
  • string $eventId: The ID of the event to delete.
  • $silent
exists (line 1089)

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.
string|boolean exists (string $uid, [string $calendar_id = null])
  • string $uid: The event's uid.
  • string $calendar_id: Calendar to search in.
getByUID (line 1211)

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 1182)
void &getEvent ([ $eventId = null])
  • $eventId
listAlarms (line 1029)
void listAlarms ( $date, [ $fullevent = false])
  • $date
  • $fullevent
listEvents (line 1120)

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 data object.
  • boolean $hasAlarm: Only return events with alarms? Defaults to all events.
  • $startDate
  • $endDate
move (line 1303)

Move an event to a new calendar.

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

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

Reset internal variable on share change

void reset ()
saveEvent (line 1248)

Saves an event in the backend.

If it is a new event, it is added, otherwise the event is updated.

  • return: UID on success, a PEAR error otherwise
mixed saveEvent ( &$event, Kronolith_Event_new $event)
  • Kronolith_Event_new $event: The event to save.
  • &$event
synchronize (line 1006)
void synchronize ([ $force = false])
  • $force

Inherited Methods

Inherited From Kronolith_Driver_kolab_wrapper

 Kronolith_Driver_kolab_wrapper::Kronolith_Driver_kolab_wrapper()

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