Horde_Kolab_Storage
in
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');
Tags
Table of Contents
- VERSION = '@version@'
- The package version
- getData() : Horde_Kolab_Storage_Data
- Return a data handler for accessing data in the specified folder.
- getFolder() : Horde_Kolab_Storage_Folder
- Get a folder representation.
- getList() : Horde_Kolab_Storage_List_Tools
- Get the folder list object.
- getSystemList() : Horde_Kolab_Storage_List_Tools
- Get a folder list object for a "system" user.
Constants
VERSION
The package version
public
mixed
VERSION
= '@version@'
Methods
getData()
Return a data handler for accessing data in the specified folder.
public
getData(string $folder[, string $object_type = null ][, int $data_version = 1 ]) : Horde_Kolab_Storage_Data
Parameters
- $folder : string
-
The name of the folder.
- $object_type : string = null
-
The type of data we want to access in the folder.
- $data_version : int = 1
-
Format version of the object data.
Return values
Horde_Kolab_Storage_Data —The data object.
getFolder()
Get a folder representation.
public
getFolder(string $folder) : Horde_Kolab_Storage_Folder
Parameters
- $folder : string
-
The folder name.
Return values
Horde_Kolab_Storage_Folder —The Kolab folder object.
getList()
Get the folder list object.
public
getList() : Horde_Kolab_Storage_List_Tools
Return values
Horde_Kolab_Storage_List_Tools —The handler for the list of folders present in the Kolab backend.
getSystemList()
Get a folder list object for a "system" user.
public
getSystemList(string $type) : Horde_Kolab_Storage_List_Tools
Parameters
- $type : string
-
The type of system user.
Return values
Horde_Kolab_Storage_List_Tools —The handler for the list of folders present in the Kolab backend.