PHP Class Horde_Dav_Calendar_Backend, horde

Author: Jan Schneider ([email protected])
Inheritance: extends Sabre\CalDAV\Backend\AbstractBackend
Show file Open project: horde/horde

Protected Properties

Property Type Description
$_interfaces array List of available interfaces and the providing applications.
$_registry Horde_Registry A registry object.
$_storage Horde_Dav_Storage_Base A storage object.

Public Methods

Method Description
__construct ( Horde_Registry $registry, Horde_Dav_Storage_Base $storage ) Constructor.
createCalendar ( string $principalUri, string $calendarUri, array $properties ) : void Creates a new calendar for a principal.
createCalendarObject ( mixed $calendarId, string $objectUri, string $calendarData ) : string | null Creates a new calendar object.
deleteCalendar ( mixed $calendarId ) : void Delete a calendar and all it's objects
deleteCalendarObject ( mixed $calendarId, string $objectUri ) : void Deletes an existing calendar object.
getCalendarObject ( mixed $calendarId, string $objectUri ) : array Returns information from a single calendar object, based on it's object uri.
getCalendarObjects ( mixed $calendarId ) : array Returns all calendar objects within a calendar.
getCalendarsForUser ( string $principalUri ) : array Returns a list of calendars for a principal.
updateCalendarObject ( mixed $calendarId, string $objectUri, string $calendarData ) : string | null Updates an existing calendarobject, based on it's uri.

Protected Methods

Method Description
_interface ( string $calendarId ) : string Returns the application that owns a certain calendar or task list.

Method Details

__construct() public method

Constructor.
public __construct ( Horde_Registry $registry, Horde_Dav_Storage_Base $storage )
$registry Horde_Registry A registry object.
$storage Horde_Dav_Storage_Base A storage object.

_interface() protected method

Returns the application that owns a certain calendar or task list.
protected _interface ( string $calendarId ) : string
$calendarId string An external calendar or task list id.
return string The application that owns the calendar or task list.

createCalendar() public method

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.
public createCalendar ( string $principalUri, string $calendarUri, array $properties ) : void
$principalUri string
$calendarUri string
$properties array
return void

createCalendarObject() public method

Creates a new calendar object.
public createCalendarObject ( mixed $calendarId, string $objectUri, string $calendarData ) : string | null
$calendarId mixed
$objectUri string
$calendarData string
return string | null

deleteCalendar() public method

Delete a calendar and all it's objects
public deleteCalendar ( mixed $calendarId ) : void
$calendarId mixed
return void

deleteCalendarObject() public method

Deletes an existing calendar object.
public deleteCalendarObject ( mixed $calendarId, string $objectUri ) : void
$calendarId mixed
$objectUri string
return void

getCalendarObject() public method

Returns information from a single calendar object, based on it's object uri.
public getCalendarObject ( mixed $calendarId, string $objectUri ) : array
$calendarId mixed
$objectUri string
return array

getCalendarObjects() public method

Returns all calendar objects within a calendar.
public getCalendarObjects ( mixed $calendarId ) : array
$calendarId mixed
return array

getCalendarsForUser() public method

Returns a list of calendars for a principal.
public getCalendarsForUser ( string $principalUri ) : array
$principalUri string
return array

updateCalendarObject() public method

Updates an existing calendarobject, based on it's uri.
public updateCalendarObject ( mixed $calendarId, string $objectUri, string $calendarData ) : string | null
$calendarId mixed
$objectUri string
$calendarData string
return string | null

Property Details

$_interfaces protected property

List of available interfaces and the providing applications.
protected array $_interfaces
return array

$_registry protected property

A registry object.
protected Horde_Registry $_registry
return Horde_Registry

$_storage protected property

A storage object.
protected Horde_Dav_Storage_Base $_storage
return Horde_Dav_Storage_Base