Horde_Kolab_Storage_Cached
extends Horde_Kolab_Storage_Base
in package
The cached variant for the Kolab storage handler [the default].
Copyright 2004-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
Table of Contents
- $_cache : Horde_Kolab_Storage_Cache
- The cache.
- $_data : array<string|int, mixed>
- Data instances.
- $_factory : Horde_Kolab_Storage_Factory
- The factory for generating additional resources.
- $_lists : array<string|int, mixed>
- List instances.
- $_logger : Horde_Log_Logger
- A logger.
- $_master : Horde_Kolab_Storage_Driver
- The master Kolab storage system.
- $_params : array<string|int, mixed>
- Additional parameters.
- $_query_set : Horde_Kolab_Storage_QuerySet
- The query handler.
- __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_Tools
- Get the folder list object.
- getSystemList() : Horde_Kolab_Storage_List_Tools
- Get a folder list object for a "system" user.
- _createData() : Horde_Kolab_Data
- Return a data handler for accessing data in the specified folder.
Properties
$_cache
The cache.
protected
Horde_Kolab_Storage_Cache
$_cache
$_data
Data instances.
protected
array<string|int, mixed>
$_data
$_factory
The factory for generating additional resources.
protected
Horde_Kolab_Storage_Factory
$_factory
$_lists
List instances.
protected
array<string|int, mixed>
$_lists
$_logger
A logger.
protected
Horde_Log_Logger
$_logger
$_master
The master Kolab storage system.
protected
Horde_Kolab_Storage_Driver
$_master
$_params
Additional parameters.
protected
array<string|int, mixed>
$_params
$_query_set
The query handler.
protected
Horde_Kolab_Storage_QuerySet
$_query_set
Methods
__construct()
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<string|int, mixed> $params = array() ]) : mixed
Parameters
- $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<string|int, mixed> = array()
-
Additional parameters.
Return values
mixed —getData()
Return a data handler for accessing data in the specified folder.
public
getData(mixed $folder[, string $object_type = null ][, int $data_version = 1 ]) : Horde_Kolab_Storage_Data
Parameters
- $folder : mixed
-
The name of the folder or an instance representing 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_Driver $driver = null ]) : Horde_Kolab_Storage_List_Tools
Parameters
- $driver : Horde_Kolab_Storage_Driver = null
Tags
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.
_createData()
Return a data handler for accessing data in the specified folder.
protected
_createData(mixed $folder, Horde_Kolab_Storage_Driver $master, Horde_Kolab_Storage_Factory $factory[, string $object_type = null ][, int $data_version = 1 ]) : Horde_Kolab_Data
Parameters
- $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 = 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_Data —The data object.