Class Kronolith_Driver_Sql

The Kronolith_Driver_Sql class implements the Kronolith_Driver API for a SQL backend.

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

Kronolith_Driver

Kronolith_Driver_Sql

Direct known subclasses

Kronolith_Driver_Resource

Package: Kronolith
Author: Luc Saillard luc.saillard@fr.alcove.com
Author: Chuck Hagenbuch chuck@horde.org
Author: Jan Schneider jan@horde.org
Located at Driver/Sql.php

Methods summary
`public string`	# `backgroundColor( )` Returns the background color of the current calendar. Returns the background color of the current calendar. Returns `string` The calendar color. Overrides `Kronolith_Driver::backgroundColor()`
`public array`	# `listAlarms( Horde_Date $date, boolean $fullevent = false )` Parameters `$date` The date to list alarms for `$fullevent` Return the full event objects? Returns `array` An array of event ids, or Kronolith_Event objects Throws `Kronolith_Exception` Overrides `Kronolith_Driver::listAlarms()`
`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` Overrides `Kronolith_Driver::search()`
`public string\|boolean`	# `exists( string $uid, string $calendar_id = null )` Checks if the event's UID already exists and returns all event ids with that UID. Checks if the event's UID already exists and returns all event ids with that UID. Parameters `$uid` The event's uid. `$calendar_id` Calendar to search in. Returns `string\|boolean` Returns a string with event_id or false if not found. Throws `Kronolith_Exception` Overrides `Kronolith_Driver::exists()`
`public array`	# `listEvents( Horde_Date $startDate = null, Horde_Date $endDate = null, boolean $showRecurrence = false, boolean $hasAlarm = false, boolean $json = false, boolean $coverDates = true, boolean $hideExceptions = false, boolean $fetchTags = false )` Lists all events in the time range, optionally restricting results to only events with alarms. Lists all events in the time range, optionally restricting results to only events with alarms. Parameters `$startDate` Start of range date object. `$endDate` End of range data object. `$showRecurrence` <p>Return every instance of a recurring event? If false, will only return recurring events once inside the $startDate - $endDate range.</p> `$hasAlarm` Only return events with alarms? `$json` <p>Store the results of the events' toJson() method?</p> `$coverDates` <p>Whether to add the events to all days that they cover.</p> `$hideExceptions` <p>Hide events that represent exceptions to a recurring event (baseid is set)?</p> `$fetchTags` Whether to fetch tags for all events Returns `array` Events in the given time range. Throws `Kronolith_Exception` Overrides `Kronolith_Driver::listEvents()`
`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` Overrides `Kronolith_Driver::countEvents()`
`public`	# `getEvent( mixed $eventId = null )` Throws `Kronolith_Exception` Horde_Exception_NotFound Overrides `Kronolith_Driver::getEvent()`
`public Kronolith_Event`	# `getByUID( string $uid, array $calendars = null, boolean $getAll = false )` Get an event or events with the given UID value. Get an event or events with the given UID value. Parameters `$uid` The UID to match `$calendars` A restricted array of calendar ids to search `$getAll` Return all matching events? Returns `Kronolith_Event` Throws `Kronolith_Exception` Horde_Exception_NotFound Overrides `Kronolith_Driver::getByUID()`
`public`	# `delete( string $calendar )` Delete a calendar and all its events. Delete a calendar and all its events. Parameters `$calendar` The name of the calendar to delete. Throws `Kronolith_Exception` Overrides `Kronolith_Driver::delete()`
`public`	# `deleteEvent( string $eventId, boolean $silent = false )` Delete an event. Delete an event. Parameters `$eventId` The ID of the event to delete. `$silent` <p>Don't send notifications, used when deleting events in bulk from maintenance tasks.</p> Throws `Kronolith_Exception` Horde_Exception_NotFound Horde_Mime_Exception Overrides `Kronolith_Driver::deleteEvent()`
`public array`	# `filterEventsByCalendar( array $uids, array $calendar )` Filters a list of events to return only those that belong to certain calendars. Filters a list of events to return only those that belong to certain calendars. Parameters `$uids` A list of event UIDs. `$calendar` A list of calendar IDs. Returns `array` Event UIDs filtered by calendar IDs. Throws `Kronolith_Exception` Overrides `Kronolith_Driver::filterEventsByCalendar()`
`public`	# `initialize( )` Attempts to open a connection to the SQL server. Attempts to open a connection to the SQL server. Throws `Kronolith_Exception` Overrides `Kronolith_Driver::initialize()`
`public mixed`	# `convertFromDriver( mixed $value )` Converts a value from the driver's charset to the default charset. Converts a value from the driver's charset to the default charset. Parameters `$value` A value to convert. Returns `mixed` The converted value.
`public mixed`	# `convertToDriver( mixed $value )` Converts a value from the default charset to the driver's charset. Converts a value from the default charset to the driver's charset. Parameters `$value` A value to convert. Returns `mixed` The converted value.

Methods inherited from Kronolith_Driver
`__construct(), colors(), getParam(), move(), nextRecurrence(), open(), saveEvent(), setParam(), setParams()`

Properties inherited from Kronolith_Driver
`$backgroundColor, $calendar, $foregroundColor`

Packages

Classes

Class Kronolith_Driver_Sql

Direct known subclasses

Returns

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

Throws

Overrides

Throws

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Throws

Overrides

Parameters

Throws

Overrides

Parameters

Returns

Throws

Overrides

Throws

Overrides

Parameters

Returns

Parameters

Returns