Documentation

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
category

Kolab

author

Gunnar Wrobel wrobel@pardus.de

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

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

$_data

Data instances.

protected array<string|int, mixed> $_data

$_lists

List instances.

protected array<string|int, mixed> $_lists

$_logger

A logger.

protected Horde_Log_Logger $_logger

$_params

Additional parameters.

protected array<string|int, mixed> $_params

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.

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

Search results