Docs For Class Kronolith_Storage

Description

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

$Horde: kronolith/lib/Storage/sql.php,v 1.7.10.7 2009/02/17 18:52:00 chuck Exp $

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

Located in /lib/Storage/sql.php (line 11)

Kronolith_Storage
   |
   --Kronolith_Storage_sql

Variable Summary

DB $_db

array $_params

DB $_write_db

Method Summary

Kronolith_Storage_sql Kronolith_Storage_sql ( $user, [array $params = array()])

boolean initialize ()

object Horde_iCalendar_vFreebusy search (string $email, [boolean $private_only = false])

boolean store (string $email, Horde_iCalendar_vFreebusy $vfb, [ $public = false], boolean $private_only)

Variables

DB $_db (line 18)

Handle for the current database connection, used for reading.

array $_params = array() (line 33)

Hash containing connection parameters.

DB $_write_db (line 26)

Handle for the current database connection, used for writing. Defaults to the same handle as $_db if a separate write database is not required.

Inherited Variables

Inherited from Kronolith_Storage

Kronolith_Storage::$_user

Methods

Constructor Kronolith_Storage_sql (line 40)

Constructs a new Kronolith_Storage SQL instance.

Kronolith_Storage_sql Kronolith_Storage_sql ( $user, [array $params = array()])

array $params: A hash containing connection parameters.
$user

initialize (line 54)

Connect to the database

return: True on success or PEAR_Error on failure.

boolean initialize ()

Redefinition of:

Kronolith_Storage::initialize(): Stub to initiate a driver.

search (line 126)

Search for a user's free/busy information.

return: on success PEAR_Error on error or not found

object Horde_iCalendar_vFreebusy search (string $email, [boolean $private_only = false])

string $email: The email address to lookup
boolean $private_only: (optional) Only return free/busy information owned by this used.

Redefinition of:

Kronolith_Storage::search(): Stub to be overridden in the child class.

store (line 170)

Store the freebusy information for a given email address.

return: True on success PEAR_Error on error or not found

boolean store (string $email, Horde_iCalendar_vFreebusy $vfb, [ $public = false], boolean $private_only)

string $email: The email address to store fb info for.
Horde_iCalendar_vFreebusy $vfb: TODO
boolean $private_only: (optional) TODO
$public

Redefinition of:

Kronolith_Storage::store(): Stub to be overridden in the child class.

Inherited Methods

Inherited From Kronolith_Storage

Kronolith_Storage::factory()
Kronolith_Storage::initialize()
Kronolith_Storage::search()
Kronolith_Storage::singleton()
Kronolith_Storage::store()