Class Kronolith_Driver

Kronolith_Driver defines an API for implementing storage backends for Kronolith.

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

Direct known subclasses

Kronolith_Driver_Holidays, Kronolith_Driver_Horde, Kronolith_Driver_Ical, Kronolith_Driver_Kolab, Kronolith_Driver_Mock, Kronolith_Driver_Sql

Indirect known subclasses

Kronolith_Driver_Resource

Package: Kronolith
Author: Chuck Hagenbuch chuck@horde.org
Author: Jan Schneider jan@horde.org
Located at Driver.php

Methods summary
`public`	# `__construct( array $params = array(), string $errormsg = null )` Constructor. Constructor. Just stores the $params in our newly-created object. All other work is done by `Kronolith_Driver::initialize()`. Parameters `$params` Any parameters needed for this driver. `$errormsg` A custom error message to use.
`public mixed`	# `getParam( string $param )` Returns a configuration for this driver. Returns a configuration for this driver. Parameters `$param` A parameter name. Returns `mixed` The parameter value or null if not set.
`public`	# `setParam( string $param, mixed $value )` Sets a configuration for this driver. Sets a configuration for this driver. Parameters `$param` A parameter name. `$value` The parameter value.
`public`	# `setParams( string $params )` Sets all configuration parameters for this driver. Sets all configuration parameters for this driver. Parameters `$params` A parameters hash.
`public`	# `open( string $calendar )` Selects a calendar as the currently opened calendar. Selects a calendar as the currently opened calendar. Parameters `$calendar` A calendar identifier.
`public string`	# `backgroundColor( )` Returns the background color of the current calendar. Returns the background color of the current calendar. Returns `string` The calendar color.
`public array`	# `colors( )` Returns the colors of the current calendar. Returns the colors of the current calendar. Returns `array` The calendar background and foreground color.
`public mixed`	# `search( object $query, boolean $json = false )` Searches a calendar. Searches a calendar. Parameters `$query` An object with the criteria to search for. `$json` Store the results of the events' toJson() method? Returns `mixed` An array of Kronolith_Events. Throws `Kronolith_Exception`
`public Horde_Date\|boolean`	# `nextRecurrence( string $eventId, Horde_Date $afterDate )` Finds the next recurrence of $eventId that's after $afterDate. Finds the next recurrence of $eventId that's after $afterDate. Parameters `$eventId` The ID of the event to fetch. `$afterDate` Return events after this date. Returns `Horde_Date\|boolean` The date of the next recurrence or false if the event does not recur after $afterDate. Throws `Kronolith_Exception` Horde_Exception_NotFound
`public integer`	# `countEvents( )` Returns the number of events in the current calendar. Returns the number of events in the current calendar. Returns `integer` The number of events. Throws `Kronolith_Exception`
`public`	# `initialize( )` Stub to initiate a driver. Stub to initiate a driver. Throws `Kronolith_Exception`
`public`	# `getEvent( )` Stub to be overridden in the child class. Stub to be overridden in the child class. Throws `Kronolith_Exception` Horde_Exception_NotFound
`public`	# `getByUID( mixed $uid, mixed $calendars = null, mixed $getAll = false )` Stub to be overridden in the child class. Stub to be overridden in the child class. Throws `Kronolith_Exception` Horde_Exception_NotFound
`public`	# `listAlarms( mixed $date, mixed $fullevent = false )` Stub to be overridden in the child class. Stub to be overridden in the child class. Throws `Kronolith_Exception`
`public`	# `listEvents( )` Stub to be overridden in the child class. Stub to be overridden in the child class. Throws `Kronolith_Exception`
`public string`	# `saveEvent( Kronolith_Event $event )` Saves an event in the backend. Saves an event in the backend. If it is a new event, it is added, otherwise the event is updated. Parameters `$event` The event to save. Returns `string` The event id. Throws Horde_Mime_Exception `Kronolith_Exception`
`public`	# `exists( mixed $uid, mixed $calendar_id = null )` Stub for child class to override if it can implement. Stub for child class to override if it can implement. Throws `Kronolith_Exception`
`public`	# `move( string $eventId, string $newCalendar )` Moves an event to a new calendar. Moves an event to a new calendar. Parameters `$eventId` The event to move. `$newCalendar` The new calendar. Throws `Kronolith_Exception` Horde_Exception_NotFound
`public`	# `delete( mixed $calendar )` Stub to be overridden in the child class. Stub to be overridden in the child class. Throws `Kronolith_Exception`
`public`	# `deleteEvent( mixed $eventId )` Stub to be overridden in the child class. Stub to be overridden in the child class.
`public`	# `filterEventsByCalendar( mixed $uids, mixed $calendar )` Stub to be overridden in the child class if it can implement. Stub to be overridden in the child class if it can implement. Throws `Kronolith_Exception`

Properties summary
`public string`	`$calendar` The current calendar. The current calendar.	#
`public string`	`$backgroundColor` The HTML background color to be used for this event. The HTML background color to be used for this event.	# `'#ddd'`
`public string`	`$foregroundColor` The HTML foreground color to be used for this event. The HTML foreground color to be used for this event.	# `'#000'`

Packages

Classes

Class Kronolith_Driver

Direct known subclasses

Indirect known subclasses

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Returns

Throws

Throws

Throws

Throws

Throws

Throws

Parameters

Returns

Throws

Throws

Parameters

Throws

Throws

Throws