Class Kolab_Storage

Description

The Kolab_Storage class provides the means to access the Kolab server storage for groupware objects.

To get access to the folder handling you would do the following:

  1.      require_once 'Horde/Kolab/Storage.php';
  2.      $folder Kolab_Storage::getFolder('INBOX/Calendar');

or (in case you are dealing with share identifications):

  1.      require_once 'Horde/Kolab/Storage.php';
  2.      $folder Kolab_Storage::getShare(Auth::getAuth()'event');

To access data in a share (or folder) you need to retrieve the corresponding data object:

  1.      require_once 'Horde/Kolab/Storage.php';
  2.      $folder Kolab_Storage::getShareData(Auth::getAuth()'event');

$Horde: framework/Kolab_Storage/lib/Horde/Kolab/Storage.php,v 1.2.2.3 2009/01/06 15:23:17 jan Exp $

Copyright 2004-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.fsf.org/copyleft/lgpl.html.

Located in /Kolab_Storage/lib/Horde/Kolab/Storage.php (line 47)


	
			
Direct descendents
Class Description
 class Kolab_Storage_Deprecated The Kolab_Storage class provides the means to access the Kolab server storage for groupware objects.
Method Summary
 Kolab_Data|PEAR_Error &getData ( &$folder, [string $data_type = null], [int $data_format = 1], Kolab_Folder $folder)
 Kolab_Folder|PEAR_Error &getFolder (string $folder)
 Kolab_Data|PEAR_Error &getFolderData (string $folder, [string $data_type = null], [int $data_format = 1])
 Kolab_Folder|PEAR_Error &getShare (string $share, string $type)
 Kolab_Data|PEAR_Error &getShareData (string $share, string $type, [string $data_type = null], [int $data_format = 1])
Methods
getData (line 92)

Return a data object for accessing data in the specified folder.

  • return: The data object.
Kolab_Data|PEAR_Error &getData ( &$folder, [string $data_type = null], [int $data_format = 1], Kolab_Folder $folder)
  • Kolab_Folder $folder: The folder object.
  • string $data_type: The type of data we want to access in the folder.
  • int $data_format: The version of the data format we want to access in the folder.
  • &$folder
getFolder (line 73)

Return the folder object.

  • return: The folder object.
Kolab_Folder|PEAR_Error &getFolder (string $folder)
  • string $folder: The name of the folder.
getFolderData (line 136)

Return a data object for accessing data in the specified folder.

  • return: The data object.
Kolab_Data|PEAR_Error &getFolderData (string $folder, [string $data_type = null], [int $data_format = 1])
  • string $folder: The name of the folder.
  • string $data_type: The type of data we want to access in the folder.
  • int $data_format: The version of the data format we want to access in the folder.
getShare (line 59)

Return the folder object corresponding to the share of the specified type (e.g. "contact", "event" etc.).

  • return: The folder object representing the share.
Kolab_Folder|PEAR_Error &getShare (string $share, string $type)
  • string $share: The id of the share.
  • string $type: The share type.
getShareData (line 114)

Return a data object for accessing data in the specified share.

  • return: The data object.
Kolab_Data|PEAR_Error &getShareData (string $share, string $type, [string $data_type = null], [int $data_format = 1])
  • string $share: The id of the share.
  • string $type: The share type.
  • string $data_type: The type of data we want to access in the folder.
  • int $data_format: The version of the data format we want to access in the folder.

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