PHP Class Horde_Kolab_Storage_Decorator_Synchronization, horde

Copyright 2011-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.
Inheritance: implements Horde_Kolab_Storage
Mostra file Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_storage Horde_Kolab_Storage The decorated storage handler.
$_synchronization Horde_Kolab_Storage_Synchronization The synchronization strategy

Public Methods

Method Description
__construct ( Horde_Kolab_Storage $storage, Horde_Kolab_Storage_Synchronization $synchronization ) Constructor.
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 object.
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

__construct() public method

Constructor.
public __construct ( Horde_Kolab_Storage $storage, Horde_Kolab_Storage_Synchronization $synchronization )
$storage Horde_Kolab_Storage The storage handler.
$synchronization Horde_Kolab_Storage_Synchronization The synchronization strategy.

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 object.
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.

Property Details

$_storage protected_oe property

The decorated storage handler.
protected Horde_Kolab_Storage $_storage
return Horde_Kolab_Storage

$_synchronization protected_oe property

The synchronization strategy
protected Horde_Kolab_Storage_Synchronization $_synchronization
return Horde_Kolab_Storage_Synchronization