\Horde_Kolab_Storage_Factory

A generic factory for the various Kolab_Storage classes.

Summary

Methods
Properties
Constants
__construct()
create()
createDriver()
createNamespace()
createCache()
createHistory()
getHistoryPrefixGenerator()
getDriver()
No public properties found
No constants found
No protected methods found
$_params
$_driver
N/A
No private methods found
No private properties found
N/A

Properties

$_params

$_params : array

A set of parameters for this factory.

Type

array

Methods

__construct()

__construct(array  $params = array()) 

Constructor.

Parameters

array $params

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.
 

create()

create() : \Horde_Kolab_Storage

Create the storage handler.

Returns

\Horde_Kolab_Storage

The storage handler.

createDriver()

createDriver(array  $params = array()) : \Horde_Kolab_Storage_Driver

Create the storage backend driver.

Parameters

array $params

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

Returns

\Horde_Kolab_Storage_Driver

The storage handler.

createNamespace()

createNamespace(string  $type, string  $user, array  $params = array()) : \Horde_Kolab_Storage_Folder_Namespace

Create a namespace handler.

Parameters

string $type

The namespace type.

string $user

The current user.

array $params

The parameters for the namespace.

Returns

\Horde_Kolab_Storage_Folder_Namespace

The namespace handler.

createCache()

createCache() : \Horde_Kolab_Storage_Cache

Create the cache handler.

Returns

\Horde_Kolab_Storage_Cache

The cache handler.

createHistory()

createHistory(string  $user) : \Horde_History

Create the history handler.

Parameters

string $user

The current user.

Returns

\Horde_History —

The history handler.

getHistoryPrefixGenerator()

getHistoryPrefixGenerator() : \Horde_Kolab_Storage_HistoryPrefix|\Horde_Support_Stub

Create a prefix factory.

Returns

\Horde_Kolab_Storage_HistoryPrefix|\Horde_Support_Stub

getDriver()

getDriver()