Horde_Dav_Calendar_Backend
extends AbstractBackend
in package
The calendar and task list backend wrapper.
Tags
Table of Contents
- $_interfaces : array<string|int, mixed>
- List of available interfaces and the providing applications.
- $_registry : Horde_Registry
- A registry object.
- $_storage : Horde_Dav_Storage_Base
- A storage object.
- __construct() : mixed
- Constructor.
- createCalendar() : void
- Creates a new calendar for a principal.
- createCalendarObject() : string|null
- Creates a new calendar object.
- deleteCalendar() : void
- Delete a calendar and all it's objects
- deleteCalendarObject() : void
- Deletes an existing calendar object.
- getCalendarObject() : array<string|int, mixed>
- Returns information from a single calendar object, based on it's object uri.
- getCalendarObjects() : array<string|int, mixed>
- Returns all calendar objects within a calendar.
- getCalendarsForUser() : array<string|int, mixed>
- Returns a list of calendars for a principal.
- updateCalendarObject() : string|null
- Updates an existing calendarobject, based on it's uri.
- _interface() : string
- Returns the application that owns a certain calendar or task list.
Properties
$_interfaces
List of available interfaces and the providing applications.
protected
array<string|int, mixed>
$_interfaces
= array()
$_registry
A registry object.
protected
Horde_Registry
$_registry
$_storage
A storage object.
protected
Horde_Dav_Storage_Base
$_storage
Methods
__construct()
Constructor.
public
__construct(Horde_Registry $registry, Horde_Dav_Storage_Base $storage) : mixed
Parameters
- $registry : Horde_Registry
-
A registry object.
- $storage : Horde_Dav_Storage_Base
-
A storage object.
Return values
mixed —createCalendar()
Creates a new calendar for a principal.
public
createCalendar(string $principalUri, string $calendarUri, array<string|int, mixed> $properties) : void
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
- $principalUri : string
- $calendarUri : string
- $properties : array<string|int, mixed>
Return values
void —createCalendarObject()
Creates a new calendar object.
public
createCalendarObject(mixed $calendarId, string $objectUri, string $calendarData) : string|null
Parameters
- $calendarId : mixed
- $objectUri : string
- $calendarData : string
Return values
string|null —deleteCalendar()
Delete a calendar and all it's objects
public
deleteCalendar(mixed $calendarId) : void
Parameters
- $calendarId : mixed
Return values
void —deleteCalendarObject()
Deletes an existing calendar object.
public
deleteCalendarObject(mixed $calendarId, string $objectUri) : void
Parameters
- $calendarId : mixed
- $objectUri : string
Return values
void —getCalendarObject()
Returns information from a single calendar object, based on it's object uri.
public
getCalendarObject(mixed $calendarId, string $objectUri) : array<string|int, mixed>
Parameters
- $calendarId : mixed
- $objectUri : string
Return values
array<string|int, mixed> —getCalendarObjects()
Returns all calendar objects within a calendar.
public
getCalendarObjects(mixed $calendarId) : array<string|int, mixed>
Parameters
- $calendarId : mixed
Return values
array<string|int, mixed> —getCalendarsForUser()
Returns a list of calendars for a principal.
public
getCalendarsForUser(string $principalUri) : array<string|int, mixed>
Parameters
- $principalUri : string
Return values
array<string|int, mixed> —updateCalendarObject()
Updates an existing calendarobject, based on it's uri.
public
updateCalendarObject(mixed $calendarId, string $objectUri, string $calendarData) : string|null
Parameters
- $calendarId : mixed
- $objectUri : string
- $calendarData : string
Return values
string|null —_interface()
Returns the application that owns a certain calendar or task list.
protected
_interface(string $calendarId) : string
Parameters
- $calendarId : string
-
An external calendar or task list id.
Tags
Return values
string —The application that owns the calendar or task list.