• Home
  • Horde_Kolab_Storage

PHP Interface Horde_Kolab_Storage, horde

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'); Copyright 2004-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
See link: http://pear.horde.org/index.php?package=Kolab_Storage
Author: Gunnar Wrobel ([email protected])
Show file Open project: horde/horde Interface Usage Examples

Public Methods

Method Description
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.
getFolder ( string $folder ) : Horde_Kolab_Storage_Folder Get a folder representation.
getList ( ) : Horde_Kolab_Storage_List Get the folder list object.
getSystemList ( string $type ) : Horde_Kolab_Storage_List Get a folder list object for a "system" user.

Method Details

getData() public method

Return a data handler for accessing data in the specified folder.
public getData ( string $folder, string $object_type = null, integer $data_version = 1 ) : Horde_Kolab_Storage_Data
$folder string The name of the folder.
$object_type string The type of data we want to access in the folder.
$data_version integer Format version of the object data.
return Horde_Kolab_Storage_Data The data object.

getFolder() public method

Get a folder representation.
public getFolder ( string $folder ) : Horde_Kolab_Storage_Folder
$folder string The folder name.
return Horde_Kolab_Storage_Folder The Kolab folder object.

getList() public method

Get the folder list object.
public getList ( ) : Horde_Kolab_Storage_List
return Horde_Kolab_Storage_List The handler for the list of folders present in the Kolab backend.

getSystemList() public method

Get a folder list object for a "system" user.
public getSystemList ( string $type ) : Horde_Kolab_Storage_List
$type string The type of system user.
return Horde_Kolab_Storage_List The handler for the list of folders present in the Kolab backend.