PHP Class Horde_Kolab_Storage_Factory, horde

See link: http://pear.horde.org/index.php?package=Kolab_Storage

Author: Gunnar Wrobel ([email protected])

Datei anzeigen Open project: horde/horde Class Usage Examples

Protected Properties

Property	Type	Description
$_driver	Horde_Kolab_Storage_Driver	Stores the driver once created.
$_params	array	A set of parameters for this factory.

Public Methods

Method	Description
__construct ( array $params = [] )	Constructor.
create ( ) : Horde_Kolab_Storage	Create the storage handler.
createCache ( ) : Horde_Kolab_Storage_Cache	Create the cache handler.
createDriver ( array $params = [] ) : Horde_Kolab_Storage_Driver	Create the storage backend driver.
createHistory ( string $user ) : Horde_History	Create the history handler.
createNamespace ( string $type, string $user, array $params = [] ) : Horde_Kolab_Storage_Folder_Namespace	Create a namespace handler.
getDriver ( )
getHistoryPrefixGenerator ( ) : Horde_Kolab_Storage_HistoryPrefix \| Horde_Support_Stub	Create a prefix factory.

Method Details

__construct() public method

Constructor.

public __construct ( array $params = [] )

$params

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.

create() public method

Create the storage handler.

public create ( ) : Horde_Kolab_Storage
return	Horde_Kolab_Storage	The storage handler.

createCache() public method

Create the cache handler.

public createCache ( ) : Horde_Kolab_Storage_Cache
return	Horde_Kolab_Storage_Cache	The cache handler.

createDriver() public method

Create the storage backend driver.

public createDriver ( array $params = [] ) : Horde_Kolab_Storage_Driver
$params	array	Any parameters that should overwrite the default parameters provided in the factory constructor.
return	Horde_Kolab_Storage_Driver	The storage handler.

createHistory() public method

Create the history handler.

public createHistory ( string $user ) : Horde_History
$user	string	The current user.
return	Horde_History	The history handler.

createNamespace() public method

Create a namespace handler.

public createNamespace ( string $type, string $user, array $params = [] ) : Horde_Kolab_Storage_Folder_Namespace
$type	string	The namespace type.
$user	string	The current user.
$params	array	The parameters for the namespace.
return	Horde_Kolab_Storage_Folder_Namespace	The namespace handler.

getDriver() public method

public getDriver ( )

getHistoryPrefixGenerator() public method

Create a prefix factory.

public getHistoryPrefixGenerator ( ) : Horde_Kolab_Storage_HistoryPrefix \| Horde_Support_Stub
return	Horde_Kolab_Storage_HistoryPrefix \| Horde_Support_Stub

Property Details

$_driver protected_oe property

Stores the driver once created.

protected Horde_Kolab_Storage_Driver $_driver
return	Horde_Kolab_Storage_Driver

$_params protected_oe property

A set of parameters for this factory.

protected array $_params
return	array