Class Kronolith_Driver

Description

Kronolith_Driver defines an API for implementing storage backends for Kronolith.

$Horde: kronolith/lib/Driver.php,v 1.116.2.90 2010-11-10 17:08:24 jan Exp $

Located in /lib/Driver.php (line 13)


	
			
Direct descendents
Class Description
 class Kronolith_Driver_holidays The Kronolith_Driver_holidays implements support for the PEAR package Date_Holidays.
 class Kronolith_Driver_ical The Kronolith_Driver_ical:: class implements the Kronolith_Driver API for iCalendar data.
 class Kronolith_Driver_sql The Kronolith_Driver_sql:: class implements the Kronolith_Driver API for a SQL backend.
 class Kronolith_Driver_kolab Horde Kronolith driver for the Kolab IMAP Server.
Variable Summary
 string $_calendar
 string $_errormsg
 array $_params
Method Summary
 Kronolith_Driver Kronolith_Driver ([array $params = array()], [ $errormsg = null])
 Kronolith_Driver &factory ([string $driver = null], [array $params = null])
 string generateUID ()
 string getCalendar ()
 void &getEvent ()
 void initialize ()
 void listAlarms ( $date, [ $fullevent = false])
 void listEvents ()
 Horde_Date|boolean nextRecurrence (string $eventId, Horde_Date $afterDate)
 void open ( $calendar)
 void removeUserData ( $user)
 mixed rename (string $from, string $to)
 void saveEvent ()
 mixed search (object Kronolith_Event $query)
Variables
string $_calendar (line 27)

The current calendar.

string $_errormsg (line 34)

An error message to throw when something is wrong.

array $_params = array() (line 20)

A hash containing any parameters for the current driver.

Methods
Constructor Kronolith_Driver (line 44)

Constructor.

Just stores the $params in our newly-created object. All other work is done by initialize().

Kronolith_Driver Kronolith_Driver ([array $params = array()], [ $errormsg = null])
  • array $params: Any parameters needed for this driver.
  • $errormsg
factory (line 187)

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

  • return: The newly created concrete Kronolith_Driver instance, or a PEAR_Error on error.
Kronolith_Driver &factory ([string $driver = null], [array $params = null])
  • string $driver: The type of concrete Kronolith_Driver subclass to return.
  • array $params: A hash containing any additional configuration or connection parameters a subclass might need.
generateUID (line 77)

Generates a universal / unique identifier for a task.

This is NOT something that we expect to be able to parse into a calendar and an event id.

  • return: A nice unique string (should be 255 chars or less).
string generateUID ()
getCalendar (line 64)

Returns the currently open calendar.

  • return: The current calendar name.
string getCalendar ()
getEvent (line 224)

Stub to be overridden in the child class.

void &getEvent ()

Redefined in descendants as:
initialize (line 216)

Stub to initiate a driver.

void initialize ()

Redefined in descendants as:
listAlarms (line 233)

Stub to be overridden in the child class.

void listAlarms ( $date, [ $fullevent = false])
  • $date
  • $fullevent

Redefined in descendants as:
listEvents (line 241)

Stub to be overridden in the child class.

void listEvents ()

Redefined in descendants as:
nextRecurrence (line 164)

Finds the next recurrence of $eventId that's after $afterDate.

  • return: The date of the next recurrence or false if the event does not recur after $afterDate.
Horde_Date|boolean nextRecurrence (string $eventId, Horde_Date $afterDate)
  • string $eventId: The ID of the event to fetch.
  • Horde_Date $afterDate: Return events after this date.
open (line 54)
void open ( $calendar)
  • $calendar

Redefined in descendants as:
removeUserData (line 257)

Stub for child class to override if it can implement.

void removeUserData ( $user)
  • $user

Redefined in descendants as:
rename (line 92)

Renames a calendar.

  • return: True or a PEAR_Error on failure.
mixed rename (string $from, string $to)
  • string $from: The current name of the calendar.
  • string $to: The new name of the calendar.

Redefined in descendants as:
saveEvent (line 249)

Stub o be overridden in the child class.

void saveEvent ()

Redefined in descendants as:
search (line 105)

Searches a calendar.

  • return: An array of Kronolith_Events or a PEAR_Error.
mixed search (object Kronolith_Event $query)

Redefined in descendants as:

Documentation generated on Sun, 30 Jan 2011 05:31:45 +0000 by phpDocumentor 1.4.3