Class Horde_Kolab_FreeBusy_Imap

Description

The Horde_Kolab_Freebusy class provides a library for quickly generating free/busy information from the Kolab IMAP data.

This class is a merged result from the Kolab free/busy package and the Horde::Kronolith free/busy driver.

$Horde: framework/Kolab_FreeBusy/lib/Horde/Kolab/FreeBusy/Imap.php,v 1.9.2.5 2010-10-10 16:26:40 wrobel Exp $

Copyright 2004-2008 Klarälvdalens Datakonsult AB Copyright 2008-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

Located in /Kolab_FreeBusy/lib/Horde/Kolab/FreeBusy/Imap.php (line 46)


	
			
Variable Summary
Method Summary
 Horde_Kolab_FreeBusy_Imap Horde_Kolab_FreeBusy_Imap ()
 void connect (string $folder)
 Horde_iCalendar &generate ([integer $startstamp = null], [integer $endstamp = null], [integer $fbpast = 0], [integer $fbfuture = 60], [string $user = null], [string $cn = null])
 array|PEAR_Error getACL ()
 array|PEAR_Error getExtendedACL ()
 void getFolder ()
 string|PEAR_Error getRelevance ()
 array listEvents ([ $startDate = null], [ $endDate = null], Horde_Date $startInterval, Horde_Date $endInterval)
Variables
string $_acl (line 81)

Store ACLs.

Kolab_Data $_data (line 67)

The link to the folder data.

Kolab_Folder $_folder (line 60)

The folder we are generating free/busy information for.

Kolab_List $_kolab = null (line 53)

Our list of Kolab server IMAP folders.

string $_relevance (line 74)

Is this store relevant only for users or admins?

string $_xacl (line 88)

Store extended attributes ACL.

Methods
Constructor Horde_Kolab_FreeBusy_Imap (line 93)

Initialize the free/busy IMAP handler.

Horde_Kolab_FreeBusy_Imap Horde_Kolab_FreeBusy_Imap ()
connect (line 106)

Connect to IMAP.

This function has been derived from the synchronize() function in the Kolab driver for Kronolith.

void connect (string $folder)
  • string $folder: The folder to generate free/busy data for.
generate (line 306)

Generates the free/busy text for $calendar. Cache it for at least an hour, as well.

  • return: The iCal object or a PEAR error.
Horde_iCalendar &generate ([integer $startstamp = null], [integer $endstamp = null], [integer $fbpast = 0], [integer $fbfuture = 60], [string $user = null], [string $cn = null])
  • integer $startstamp: The start of the time period to retrieve.
  • integer $endstamp: The end of the time period to retrieve.
  • integer $fbpast: The number of days that free/busy should be calculated for the past
  • integer $fbfuture: The number of days that free/busy should be calculated for the future
  • string $user: Set organizer to this user.
  • string $cn: Set the common name of this user.
getACL (line 234)

Fetch the ACL of this calendar folder.

  • return: IMAP ACL of this folder.
array|PEAR_Error getACL ()
getExtendedACL (line 266)

Fetch the extended ACL of this calendar folder.

  • return: Extended ACL of this folder.
array|PEAR_Error getExtendedACL ()
getFolder (line 131)
void getFolder ()
getRelevance (line 205)

Fetch the relevance of this calendar folder.

  • return: Relevance of this folder.
string|PEAR_Error getRelevance ()
listEvents (line 147)

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

Taken from the Kolab driver for Kronolith.

  • return: Events in the given time range.
array listEvents ([ $startDate = null], [ $endDate = null], Horde_Date $startInterval, Horde_Date $endInterval)
  • Horde_Date $startInterval: Start of range date object.
  • Horde_Date $endInterval: End of range data object.
  • $startDate
  • $endDate

Documentation generated on Sun, 30 Jan 2011 05:18:27 +0000 by phpDocumentor 1.4.3