\Horde_Kolab_Storage

The Horde_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:

require_once 'Horde/Kolab/Storage.php'; $folder = Horde_Kolab_Storage::getFolder('INBOX/Calendar');

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

require_once 'Horde/Kolab/Storage.php'; $folder = Horde_Kolab_Storage::getShare(Auth::getAuth(), 'event');

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

require_once 'Horde/Kolab/Storage.php'; $folder = Horde_Kolab_Storage::getShareData(Auth::getAuth(), 'event');

Summary

Methods
Constants
getList()
getSystemList()
getFolder()
getData()
VERSION
No protected methods found
N/A
No private methods found
N/A

Constants

VERSION

VERSION

The package version

Methods

getList()

getList() : \Horde_Kolab_Storage_List_Tools

Get the folder list object.

Returns

\Horde_Kolab_Storage_List_Tools

The handler for the list of folders present in the Kolab backend.

getSystemList()

getSystemList(string  $type) : \Horde_Kolab_Storage_List_Tools

Get a folder list object for a "system" user.

Parameters

string $type

The type of system user.

Returns

\Horde_Kolab_Storage_List_Tools

The handler for the list of folders present in the Kolab backend.

getFolder()

getFolder(string  $folder) : \Horde_Kolab_Storage_Folder

Get a folder representation.

Parameters

string $folder

The folder name.

Returns

\Horde_Kolab_Storage_Folder

The Kolab folder object.

getData()

getData(string  $folder, string  $object_type = null, integer  $data_version = 1) : \Horde_Kolab_Storage_Data

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

Parameters

string $folder

The name of the folder.

string $object_type

The type of data we want to access in the folder.

integer $data_version

Format version of the object data.

Returns

\Horde_Kolab_Storage_Data

The data object.