API Documentation
\

\Horde_Kolab_Storage_Decorator_Log

A log decorator for the Kolab storage handler.

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.

Summary

Methods
Properties
Constants
__construct()
getList()
getSystemList()
getFolder()
getData()
No public properties found
No constants found
No protected methods found
$_storage
$_logger
N/A
No private methods found
No private properties found
N/A

Properties

$_storage

$_storage : \Horde_Kolab_Storage

The decorated storage handler.

Type

\Horde_Kolab_Storage

$_logger

$_logger : \Horde_Log_Logger

A log handler.

Type

\Horde_Log_Logger

Methods

__construct()

__construct(\Horde_Kolab_Storage  $storage, mixed  $logger)

Constructor.

Parameters

\Horde_Kolab_Storage $storage

The storage handler.
mixed $logger

The log handler. This instance must provide the debug() method.

getList()

getList() : \Horde_Kolab_Storage_List

Get the folder list object.

Returns

\Horde_Kolab_Storage_List —

The handler for the list of folders present in the Kolab backend.

getSystemList()

getSystemList(string  $type) : \Horde_Kolab_Storage_List

Get a folder list object for a "system" user.

Parameters

string $type

The type of system user.

Returns

\Horde_Kolab_Storage_List —

The handler for the list of folders present in the Kolab backend.

getFolder()

getFolder(string  $folder) : \Horde_Kolab_Storage_Folder

Get a Folder object.

Parameters

string $folder

The folder name.

Returns

\Horde_Kolab_Storage_Folder —

The Kolab folder object.

getData()

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.

Parameters

string $folder

The name of the folder.
string $object_type

The type of data we want to access in the folder.
integer $data_version

Format version of the object data.

Returns

\Horde_Kolab_Storage_Data —

The data object.