Documentation

Horde_Kolab_Storage_Factory
in package

A generic factory for the various Kolab_Storage classes.

Tags
category

Kolab

author

Gunnar Wrobel wrobel@pardus.de

license

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

Table of Contents

$_driver  : Horde_Kolab_Storage_Driver
Stores the driver once created.
$_params  : array<string|int, mixed>
A set of parameters for this factory.
__construct()  : mixed
Constructor.
create()  : Horde_Kolab_Storage
Create the storage handler.
createCache()  : Horde_Kolab_Storage_Cache
Create the cache handler.
createDriver()  : Horde_Kolab_Storage_Driver
Create the storage backend driver.
createHistory()  : Horde_History
Create the history handler.
createNamespace()  : Horde_Kolab_Storage_Folder_Namespace
Create a namespace handler.
getDriver()  : mixed
getHistoryPrefixGenerator()  : Horde_Kolab_Storage_HistoryPrefix|Horde_Support_Stub
Create a prefix factory.

Properties

$_driver

Stores the driver once created.

protected Horde_Kolab_Storage_Driver $_driver
Tags
todo

Cleanup. Extract a driver factory to be placed in the driver namespace and allow to inject the driver within the storage factory.

$_params

A set of parameters for this factory.

protected array<string|int, mixed> $_params

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $params = array() ]) : mixed
Parameters
$params : array<string|int, mixed> = array()

A set of parameters.

 - storage:
 - cache:
 - queries:
 - queryset:
 - driver: (string) The type of backend driver. One of "mock", "php",
      "pear", "horde", "horde-socket", and "roundcube".
 - params: (array) Backend specific connection parameters.
 - logger: (Horde_Log_Logger) An optional log handler.
 - log: (array) An array of log decorators. Possible values include:
      'debug', 'driver_time', 'driver'.
 - format : (array)
    - factory: Name of the format parser factory class.
 - history: (Horde_History) A Horde_History driver.
 - history_prefix_generator: (Horde_Kolab_Storage_HistoryPrefix) An
       object that can provide prefix/collection mapping of the
       History system.
- sync_strategy: (Horde_Kolab_Storage_Synchronization) The strategy
        object to use for determining when we should synchronize
        with the Kolab backend. If omitted,
        Horde_Kolab_Storage_Synchronization_OncePerSession strategy is
        used.
Return values
mixed —

createDriver()

Create the storage backend driver.

public createDriver([array<string|int, mixed> $params = array() ]) : Horde_Kolab_Storage_Driver
Parameters
$params : array<string|int, mixed> = array()

Any parameters that should overwrite the default parameters provided in the factory constructor.

Return values
Horde_Kolab_Storage_Driver —

The storage handler.

createHistory()

Create the history handler.

public createHistory(string $user) : Horde_History
Parameters
$user : string

The current user.

Return values
Horde_History —

The history handler.

createNamespace()

Create a namespace handler.

public createNamespace(string $type, string $user[, array<string|int, mixed> $params = array() ]) : Horde_Kolab_Storage_Folder_Namespace
Parameters
$type : string

The namespace type.

$user : string

The current user.

$params : array<string|int, mixed> = array()

The parameters for the namespace.

Return values
Horde_Kolab_Storage_Folder_Namespace —

The namespace handler.

getDriver()

public getDriver() : mixed
Return values
mixed —

getHistoryPrefixGenerator()

Create a prefix factory.

public getHistoryPrefixGenerator() : Horde_Kolab_Storage_HistoryPrefix|Horde_Support_Stub
Tags
todo

This should probably be implemented by decorating/wrapping the Horde_History object but that can't be done in a clean BC way until Horde 6. So, until then implement a Horde_Kolab_Storage_History_Prefix interface.

Return values
Horde_Kolab_Storage_HistoryPrefix|Horde_Support_Stub —

Search results