PHP Class Horde_Kolab_Storage_Base, horde

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.
Inheritance: implements Horde_Kolab_Storage
Datei anzeigen Open project: horde/horde

Protected Properties

Property Type Description
$_cache Horde_Kolab_Storage_Cache The cache.
$_data array Data instances.
$_factory Horde_Kolab_Storage_Factory The factory for generating additional resources.
$_lists array List instances.
$_logger Horde_Log_Logger A logger.
$_master Horde_Kolab_Storage_Driver The master Kolab storage system.
$_params array Additional parameters.
$_query_set Horde_Kolab_Storage_QuerySet The query handler.

Public Methods

Method Description
__construct ( Horde_Kolab_Storage_Driver $master, Horde_Kolab_Storage_QuerySet $query_set, Horde_Kolab_Storage_Factory $factory, Horde_Kolab_Storage_Cache $cache, Horde_Log_Logger $logger, array $params = [] ) Constructor.
getData ( mixed $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_Driver $driver = null ) : 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.

Protected Methods

Method Description
_createData ( mixed $folder, Horde_Kolab_Storage_Driver $master, Horde_Kolab_Storage_Factory $factory, string $object_type = null, integer $data_version = 1 ) : Horde_Kolab_Data Return a data handler for accessing data in the specified folder.

Method Details

__construct() public method

Constructor.
public __construct ( Horde_Kolab_Storage_Driver $master, Horde_Kolab_Storage_QuerySet $query_set, Horde_Kolab_Storage_Factory $factory, Horde_Kolab_Storage_Cache $cache, Horde_Log_Logger $logger, array $params = [] )
$master Horde_Kolab_Storage_Driver The primary connection driver.
$query_set Horde_Kolab_Storage_QuerySet The query handler.
$factory Horde_Kolab_Storage_Factory The factory.
$cache Horde_Kolab_Storage_Cache The cache.
$logger Horde_Log_Logger A logger.
$params array Additional parameters.

_createData() abstract protected method

Return a data handler for accessing data in the specified folder.
abstract protected _createData ( mixed $folder, Horde_Kolab_Storage_Driver $master, Horde_Kolab_Storage_Factory $factory, string $object_type = null, integer $data_version = 1 ) : Horde_Kolab_Data
$folder mixed The name of the folder or an instance representing the folder.
$master Horde_Kolab_Storage_Driver The primary connection driver.
$factory Horde_Kolab_Storage_Factory The factory.
$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_Data The data object.

getData() public method

Return a data handler for accessing data in the specified folder.
public getData ( mixed $folder, string $object_type = null, integer $data_version = 1 ) : Horde_Kolab_Storage_Data
$folder mixed The name of the folder or an instance representing 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_Driver $driver = null ) : Horde_Kolab_Storage_List
$driver Horde_Kolab_Storage_Driver
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

$_cache protected_oe property

The cache.
protected Horde_Kolab_Storage_Cache $_cache
return Horde_Kolab_Storage_Cache

$_data protected_oe property

Data instances.
protected array $_data
return array

$_factory protected_oe property

The factory for generating additional resources.
protected Horde_Kolab_Storage_Factory $_factory
return Horde_Kolab_Storage_Factory

$_lists protected_oe property

List instances.
protected array $_lists
return array

$_logger protected_oe property

A logger.
protected Horde_Log_Logger $_logger
return Horde_Log_Logger

$_master protected_oe property

The master Kolab storage system.
protected Horde_Kolab_Storage_Driver $_master
return Horde_Kolab_Storage_Driver

$_params protected_oe property

Additional parameters.
protected array $_params
return array

$_query_set protected_oe property

The query handler.
protected Horde_Kolab_Storage_QuerySet $_query_set
return Horde_Kolab_Storage_QuerySet