Horde_Kolab_Storage_Decorator_Synchronization
in package
implements
Horde_Kolab_Storage
A synchronization decorator for the Kolab storage handler.
Copyright 2011-2017 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Tags
Interfaces, Classes, Traits and Enums
- Horde_Kolab_Storage
- The Horde_Kolab_Storage class provides the means to access the Kolab server storage for groupware objects.
Table of Contents
- $_storage : Horde_Kolab_Storage
- The decorated storage handler.
- $_synchronization : Horde_Kolab_Storage_Synchronization
- The synchronization strategy
- __construct() : mixed
- Constructor.
- getData() : Horde_Kolab_Storage_Data
- Return a data handler for accessing data in the specified folder.
- getFolder() : Horde_Kolab_Storage_Folder
- Get a Folder object.
- getList() : Horde_Kolab_Storage_List
- Get the folder list object.
- getSystemList() : Horde_Kolab_Storage_List
- Get a folder list object for a "system" user.
Properties
$_storage
The decorated storage handler.
protected
Horde_Kolab_Storage
$_storage
$_synchronization
The synchronization strategy
protected
Horde_Kolab_Storage_Synchronization
$_synchronization
Methods
__construct()
Constructor.
public
__construct(Horde_Kolab_Storage $storage, Horde_Kolab_Storage_Synchronization $synchronization) : mixed
Parameters
- $storage : Horde_Kolab_Storage
-
The storage handler.
- $synchronization : Horde_Kolab_Storage_Synchronization
-
The synchronization strategy.
Return values
mixed —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 object.
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
Return values
Horde_Kolab_Storage_List —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
Parameters
- $type : string
-
The type of system user.
Return values
Horde_Kolab_Storage_List —The handler for the list of folders present in the Kolab backend.