Class Kronolith_Driver_Ical

The Kronolith_Driver_Ical class implements the Kronolith_Driver API for iCalendar data.

Possible driver parameters: - url: The location of the remote calendar. - proxy: A hash with HTTP proxy information. - user: The user name for HTTP Basic Authentication. - password: The password for HTTP Basic Authentication.

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_Ical

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

Methods summary
`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. Overrides `Kronolith_Driver::open()`
`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`	# `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` Overrides `Kronolith_Driver::listAlarms()`
`public array`	# `listEvents( Horde_Date $startDate = null, Horde_Date $endDate = null, boolean $showRecurrence = false, boolean $hasAlarm = false, boolean $json = false, boolean $coverDates = true )` 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` $startInterval Start of range date object. `$endDate` $endInterval 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> Returns `array` Events in the given time range. Throws `Kronolith_Exception` Overrides `Kronolith_Driver::listEvents()`
`public`	# `getEvent( mixed $eventId = null )` Throws `Kronolith_Exception` Horde_Exception_NotFound Overrides `Kronolith_Driver::getEvent()`
`public`	# `deleteEvent( string $eventId, boolean $silent = false )` Deletes an event. Deletes 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 Horde_Icalendar`	# `getRemoteCalendar( boolean $cache = true )` Fetches a remote calendar into the cache and return the data. Fetches a remote calendar into the cache and return the data. Parameters `$cache` Whether to return data from the cache. Returns `Horde_Icalendar` The calendar data. Throws `Kronolith_Exception`
`public boolean`	# `isCalDAV( )` Returns whether the remote calendar is a CalDAV server, and propagates the $_davSupport propery with the server's DAV capabilities. Returns whether the remote calendar is a CalDAV server, and propagates the $_davSupport propery with the server's DAV capabilities. Returns `boolean` True if the remote calendar is a CalDAV server. Throws `Kronolith_Exception`
`public integer`	# `getPermission( )` Returns the permissions for the current calendar. Returns the permissions for the current calendar. Returns `integer` A Horde_Perms permission bit mask.

Methods inherited from Kronolith_Driver
`__construct(), colors(), countEvents(), delete(), exists(), filterEventsByCalendar(), getByUID(), getParam(), initialize(), move(), nextRecurrence(), saveEvent(), search(), setParam(), setParams()`

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

Packages

Classes

Class Kronolith_Driver_Ical

Parameters

Overrides

Returns

Overrides

Throws

Overrides

Parameters

Returns

Throws

Overrides

Throws

Overrides

Parameters

Throws

Overrides

Parameters

Returns

Throws

Returns

Throws

Returns