API Documentation
\

\Horde_Dav_Calendar_Backend

The calendar and task list backend wrapper.

Summary

Methods
Properties
Constants
__construct()
getCalendarsForUser()
createCalendar()
deleteCalendar()
getCalendarObjects()
getCalendarObject()
createCalendarObject()
updateCalendarObject()
deleteCalendarObject()
No public properties found
No constants found
_interface()
$_registry
$_storage
$_interfaces
N/A
No private methods found
No private properties found
N/A

Properties

$_registry

$_registry : \Horde_Registry

A registry object.

Type

\Horde_Registry

$_interfaces

$_interfaces : array

List of available interfaces and the providing applications.

Type

array

Methods

__construct()

__construct(\Horde_Registry  $registry, \Horde_Dav_Storage_Base  $storage)

Constructor.

Parameters

\Horde_Registry $registry

A registry object.
\Horde_Dav_Storage_Base $storage

A storage object.

getCalendarsForUser()

getCalendarsForUser(string  $principalUri) : array

Returns a list of calendars for a principal.

Parameters

string $principalUri

Returns

array

createCalendar()

createCalendar(string  $principalUri, string  $calendarUri, array  $properties) : void

Creates a new calendar for a principal.

If the creation was a success, an id must be returned that can be used to reference this calendar in other methods, such as updateCalendar.

Parameters

string $principalUri
string $calendarUri
array $properties

deleteCalendar()

deleteCalendar(mixed  $calendarId) : void

Delete a calendar and all it's objects

Parameters

mixed $calendarId

getCalendarObjects()

getCalendarObjects(mixed  $calendarId) : array

Returns all calendar objects within a calendar.

Parameters

mixed $calendarId

Returns

array

getCalendarObject()

getCalendarObject(mixed  $calendarId, string  $objectUri) : array

Returns information from a single calendar object, based on it's object uri.

Parameters

mixed $calendarId
string $objectUri

Returns

array

createCalendarObject()

createCalendarObject(mixed  $calendarId, string  $objectUri, string  $calendarData) : string|null

Creates a new calendar object.

Parameters

mixed $calendarId
string $objectUri
string $calendarData

Returns

string|null

updateCalendarObject()

updateCalendarObject(mixed  $calendarId, string  $objectUri, string  $calendarData) : string|null

Updates an existing calendarobject, based on it's uri.

Parameters

mixed $calendarId
string $objectUri
string $calendarData

Returns

string|null

deleteCalendarObject()

deleteCalendarObject(mixed  $calendarId, string  $objectUri) : void

Deletes an existing calendar object.

Parameters

mixed $calendarId
string $objectUri

_interface()

_interface(string  $calendarId) : string

Returns the application that owns a certain calendar or task list.

Parameters

string $calendarId

An external calendar or task list id.

Throws

\Sabre\DAV\Exception

if the application cannot be found.

Returns

string —

The application that owns the calendar or task list.