Docs For Class Kronolith

Description

Kronolith_Storage:: defines an API for storing free/busy information.

$Horde: kronolith/lib/Storage.php,v 1.2.10.4 2008/06/09 03:28:06 chuck Exp $

author: Mike Cochrane <mike@graftonhall.co.nz>

Direct descendents

Class	Description
Kronolith_Storage_kolab	Horde Kronolith free/busy driver for the Kolab IMAP Server.
Kronolith_Storage_sql	Kronolith_Storage:: defines an API for storing free/busy information.

Variable Summary

string $_user

Method Summary

mixed &factory ([string $user = null], [string $driver = null], [array $params = null])

void initialize ()

void search ()

mixed &singleton ([string $user = null], [string $driver = null], [array $params = null])

void store ()

Variables

string $_user = '' (line 17)

String containing the current username.

Methods

factory (line 37)

Attempts to return a concrete Kronolith_Storage instance based on $driver.

return: The newly created concrete Kronolith_Storage instance, or false on an error.

mixed &factory ([string $user = null], [string $driver = null], [array $params = null])

string $driver: The type of concrete Kronolith_Storage subclass to return. The is based on the storage driver ($driver). The code is dynamically included.
string $user: The name of the user who owns the free/busy information
array $params: (optional) A hash containing any additional configuration or connection parameters a subclass might need.

initialize (line 121)

Stub to initiate a driver.

void initialize ()

Redefined in descendants as:

Kronolith_Storage_sql::initialize() : Connect to the database

search (line 129)

Stub to be overridden in the child class.

void search ()

Redefined in descendants as:

Kronolith_Storage_kolab::search()
Kronolith_Storage_sql::search() : Search for a user's free/busy information.

singleton (line 94)

Attempts to return a reference to a concrete Kronolith_Storage instance based on $driver. It will only create a new instance if no Kronolith_Storage instance with the same parameters currently exists.

This should be used if multiple storage sources are required.

This method must be invoked as: $var = &Kronolith_Storage::singleton()

return: The created concrete Kronolith_Storage instance, or false on error.

mixed &singleton ([string $user = null], [string $driver = null], [array $params = null])

string $driver: The type of concrete Kronolith_Storage subclass to return. The is based on the storage driver ($driver). The code is dynamically included.
string $user: The name of the user who owns the free/busy information
array $params: (optional) A hash containing any additional configuration or connection parameters a subclass might need.

store (line 137)

Stub to be overridden in the child class.

void store ()

Redefined in descendants as:

Kronolith_Storage_kolab::store()
Kronolith_Storage_sql::store() : Store the freebusy information for a given email address.