• Home
  • Kronolith_Driver_Sql

PHP Class Kronolith_Driver_Sql, horde

Copyright 1999-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.
Author: Luc Saillard ([email protected])
Author: Chuck Hagenbuch ([email protected])
Author: Jan Schneider ([email protected])
Inheritance: extends Kronolith_Driver
Datei anzeigen Open project: horde/horde

Protected Properties

Property Type Description
$_cache array Cache events as we fetch them to avoid fetching the same event from the DB twice.
$_columns array Column information as Horde_Db_Adapter_Base_Column objects.
$_db Horde_Db_Adapter The object handle for the current database connection.
$_eventClass string Can be overwritten by sub-classes.

Public Methods

Method Description
backgroundColor ( ) : string Returns the background color of the current calendar.
convertBlobs ( array $event ) : array Converts TEXT/CLOB fields in an event.
convertFromDriver ( mixed $value ) : mixed Converts a value from the driver's charset to the default charset.
convertToDriver ( mixed $value ) : mixed Converts a value from the default charset to the driver's charset.
countEvents ( ) : integer Returns the number of events in the current calendar.
delete ( string $calendar ) Delete all of a calendar's events.
exists ( string $uid, string $calendar_id = null ) : string | boolean Checks if the event's UID already exists and returns all event ids with that UID.
filterEventsByCalendar ( array $uids, array $calendar ) : array Filters a list of events to return only those that belong to certain calendars.
getByUID ( string $uid, array $calendars = null, boolean $getAll = false ) : Kronolith_Event Get an event or events with the given UID value.
getEvent ( $eventId = null )
initialize ( ) Attempts to open a connection to the SQL server.
listAlarms ( Horde_Date $date, boolean $fullevent = false ) : array
search ( object $query, boolean $json = false ) : mixed Searches a calendar.
supportsTimezones ( ) : boolean Returns whether this driver supports per-event timezones.

Protected Methods

Method Description
_addEvent ( Kronolith_Event $event ) : string Adds an event to the backend.
_buildEventHistory ( Kronolith_Event $event ) : array Builds a history hash for a modified event.
_deleteEvent ( string $eventId, boolean $silent = false ) Deletes an event.
_listEvents ( Horde_Date $startDate = null, Horde_Date $endDate = null, array $options = [] ) Lists all events in the time range, optionally restricting results to only events with alarms.
_move ( string $eventId, string $newCalendar ) : Kronolith_Event Moves an event to a new calendar.
_updateEvent ( Kronolith_Event $event ) : string Updates an existing event in the backend.

Private Methods

Method Description
_listEventsConditional ( Horde_Date $startInterval = null, Horde_Date $endInterval = null, string $conditions = '', array $vals = [] ) : array Lists all events that satisfy the given conditions.

Method Details

_addEvent() protected method

Adds an event to the backend.
protected _addEvent ( Kronolith_Event $event ) : string
$event Kronolith_Event The event to save.
return string The event id.

_buildEventHistory() protected method

We don't write it in here because we don't want to commit history before the actual changes are made.
protected _buildEventHistory ( Kronolith_Event $event ) : array
$event Kronolith_Event The event to log.
return array The change log.

_deleteEvent() protected method

Deletes an event.
protected _deleteEvent ( string $eventId, boolean $silent = false )
$eventId string The ID of the event to delete.
$silent boolean Don't send notifications, used when deleting events in bulk from maintenance tasks.

_listEvents() protected method

Lists all events in the time range, optionally restricting results to only events with alarms.
protected _listEvents ( Horde_Date $startDate = null, Horde_Date $endDate = null, array $options = [] )
$startDate Horde_Date The start of range date.
$endDate Horde_Date The end of date range.
$options array Additional options: - show_recurrence: (boolean) Return every instance of a recurring event? DEFAULT: false (Only return recurring events once inside $startDate - $endDate range) - has_alarm: (boolean) Only return events with alarms. DEFAULT: false (Return all events) - json: (boolean) Store the results of the event's toJson() method? DEFAULT: false - cover_dates: (boolean) Add the events to all days that they cover? DEFAULT: true - hide_exceptions: (boolean) Hide events that represent exceptions to a recurring event. DEFAULT: false (Do not hide exception events) - fetch_tags: (boolean) Fetch tags for all events. DEFAULT: false (Do not fetch event tags)

_move() protected method

Moves an event to a new calendar.
protected _move ( string $eventId, string $newCalendar ) : Kronolith_Event
$eventId string The event to move.
$newCalendar string The new calendar.
return Kronolith_Event The old event.

_updateEvent() protected method

Updates an existing event in the backend.
protected _updateEvent ( Kronolith_Event $event ) : string
$event Kronolith_Event The event to save.
return string The event id.

backgroundColor() public method

Returns the background color of the current calendar.
public backgroundColor ( ) : string
return string The calendar color.

convertBlobs() public method

Converts TEXT/CLOB fields in an event.
public convertBlobs ( array $event ) : array
$event array An event hash with TEXT/CLOB columns.
return array The event with TEXT/CLOB columns converted to strings.

convertFromDriver() public method

Converts a value from the driver's charset to the default charset.
public convertFromDriver ( mixed $value ) : mixed
$value mixed A value to convert.
return mixed The converted value.

convertToDriver() public method

Converts a value from the default charset to the driver's charset.
public convertToDriver ( mixed $value ) : mixed
$value mixed A value to convert.
return mixed The converted value.

countEvents() public method

Returns the number of events in the current calendar.
public countEvents ( ) : integer
return integer The number of events.

delete() public method

Delete all of a calendar's events.
public delete ( string $calendar )
$calendar string The name of the calendar to delete.

exists() public method

Checks if the event's UID already exists and returns all event ids with that UID.
public exists ( string $uid, string $calendar_id = null ) : string | boolean
$uid string The event's uid.
$calendar_id string Calendar to search in.
return string | boolean Returns a string with event_id or false if not found.

filterEventsByCalendar() public method

Filters a list of events to return only those that belong to certain calendars.
public filterEventsByCalendar ( array $uids, array $calendar ) : array
$uids array A list of event UIDs.
$calendar array A list of calendar IDs.
return array Event UIDs filtered by calendar IDs.

getByUID() public method

Get an event or events with the given UID value.
public getByUID ( string $uid, array $calendars = null, boolean $getAll = false ) : Kronolith_Event
$uid string The UID to match
$calendars array A restricted array of calendar ids to search
$getAll boolean Return all matching events?
return Kronolith_Event

getEvent() public method

public getEvent ( $eventId = null )

initialize() public method

Attempts to open a connection to the SQL server.
public initialize ( )

listAlarms() public method

public listAlarms ( Horde_Date $date, boolean $fullevent = false ) : array
$date Horde_Date The date to list alarms for
$fullevent boolean Return the full event objects?
return array An array of event ids, or Kronolith_Event objects

supportsTimezones() public method

Returns whether this driver supports per-event timezones.
public supportsTimezones ( ) : boolean
return boolean Whether this drivers suppports per-event timezones.

Property Details

$_cache protected_oe property

Cache events as we fetch them to avoid fetching the same event from the DB twice.
protected array $_cache
return array

$_columns protected_oe property

Column information as Horde_Db_Adapter_Base_Column objects.
protected array $_columns
return array

$_db protected_oe property

The object handle for the current database connection.
protected Horde_Db_Adapter $_db
return Horde_Db_Adapter

$_eventClass protected_oe property

Can be overwritten by sub-classes.
protected string $_eventClass
return string