Class: Sabre_CalDAV_Backend_Abstract

Source Location: /includes/classes/SabreDAV/lib/Sabre/CalDAV/Backend/Abstract.php

Class Overview [line 12]


Abstract Calendaring backend. Extend this class to create your own backends.

Author(s):

  • Evert Pot (http://www.rooftopsolutions.nl/)

Version:

Copyright:

  • Copyright (C) 2007-2009 Rooftop Solutions. All rights reserved.

Variables

Constants

Methods


Child classes:

Sabre_CalDAV_Backend_PDO
PDO CalDAV backend
Sabre_CalDAV_Backend_AbstractMock
Abstract Calendaring backend. Extend this class to create your own backends.

Inherited Variables

Inherited Constants

Inherited Methods



Class Details

Abstract Calendaring backend. Extend this class to create your own backends.

Tags:

[ Top ]


Class Variables


Class Methods

createCalendar

string|int createCalendar( string $principalUri, string $calendarUri, $properties)

[line 36]

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.

This function must return a server-wide unique id that can be used later to reference the calendar.

Tags:

  • abstract -

Overridden in child classes as:

Sabre_CalDAV_Backend_PDO::createCalendar()
Creates a new calendar for a principal.
Webcal_Sabre_CalDAV_Backend_PDO::createCalendar()
Creates a new calendar for a principal.
Sabre_CalDAV_Backend_AbstractMock::createCalendar()

Parameters:

  • string $principalUri -
  • string $calendarUri -
  • array $properties -

[ Top ]

createCalendarObject

void createCalendarObject( string $calendarId, string $objectUri, string $calendarData)

[line 113]

Creates a new calendar object.

Tags:

  • abstract -

Overridden in child classes as:

Sabre_CalDAV_Backend_PDO::createCalendarObject()
Creates a new calendar object.
Webcal_Sabre_CalDAV_Backend_PDO::createCalendarObject()
Creates a new calendar object.
Sabre_CalDAV_Backend_AbstractMock::createCalendarObject()

Parameters:

  • string $calendarId -
  • string $objectUri -
  • string $calendarData -

[ Top ]

deleteCalendar

void deleteCalendar( string $calendarId)

[line 86]

Delete a calendar and all it's objects

Tags:

  • abstract -

Overridden in child classes as:

Sabre_CalDAV_Backend_PDO::deleteCalendar()
Delete a calendar and all it's objects
Webcal_Sabre_CalDAV_Backend_PDO::deleteCalendar()
Delete a calendar and all it's objects
Sabre_CalDAV_Backend_AbstractMock::deleteCalendar()

Parameters:

  • string $calendarId -

[ Top ]

deleteCalendarObject

void deleteCalendarObject( string $calendarId, string $objectUri)

[line 132]

Deletes an existing calendar object.

Tags:

  • abstract -

Overridden in child classes as:

Sabre_CalDAV_Backend_PDO::deleteCalendarObject()
Deletes an existing calendar object.
Webcal_Sabre_CalDAV_Backend_PDO::deleteCalendarObject()
Deletes an existing calendar object.
Sabre_CalDAV_Backend_AbstractMock::deleteCalendarObject()

Parameters:

  • string $calendarId -
  • string $objectUri -

[ Top ]

getCalendarObject

array getCalendarObject( string $calendarId, string $objectUri)

[line 103]

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

Tags:

  • abstract -

Overridden in child classes as:

Sabre_CalDAV_Backend_PDO::getCalendarObject()
Returns information from a single calendar object, based on it's object uri.
Webcal_Sabre_CalDAV_Backend_PDO::getCalendarObject()
Returns information from a single calendar object, based on it's object uri.
Sabre_CalDAV_Backend_AbstractMock::getCalendarObject()

Parameters:

  • string $calendarId -
  • string $objectUri -

[ Top ]

getCalendarObjects

array getCalendarObjects( string $calendarId)

[line 94]

Returns all calendar objects within a calendar object.

Tags:

  • abstract -

Overridden in child classes as:

Sabre_CalDAV_Backend_PDO::getCalendarObjects()
Returns all calendar objects within a calendar object.
Webcal_Sabre_CalDAV_Backend_PDO::getCalendarObjects()
Returns all calendar objects within a calendar object.
Sabre_CalDAV_Backend_AbstractMock::getCalendarObjects()

Parameters:

  • string $calendarId -

[ Top ]

getCalendarsForUser

array getCalendarsForUser( $principalUri, string $userUri)

[line 20]

Returns a list of calendars for a principal

Tags:

  • abstract -

Overridden in child classes as:

Sabre_CalDAV_Backend_PDO::getCalendarsForUser()
Returns a list of calendars for a principal
Webcal_Sabre_CalDAV_Backend_PDO::getCalendarsForUser()
Returns a list of calendars for a principal
Sabre_CalDAV_Backend_AbstractMock::getCalendarsForUser()

Parameters:

  • string $userUri -
  • $principalUri -

[ Top ]

updateCalendar

bool|array updateCalendar( string $calendarId, $properties)

[line 74]

Updates properties on this node,

The properties array uses the propertyName in clark-notation as key, and the array value for the property value. In the case a property should be deleted, the property value will be null.

This method must be atomic. If one property cannot be changed, the entire operation must fail.

If the operation was successful, true can be returned. If the operation failed, false can be returned.

Deletion of a non-existant property is always succesful.

Lastly, it is optional to return detailed information about any failures. In this case an array should be returned with the following structure:

array( 403 => array( '{DAV:}displayname' => null, ), 424 => array( '{DAV:}owner' => null, ) )

In this example it was forbidden to update {DAV:}displayname. (403 Forbidden), which in turn also caused {DAV:}owner to fail (424 Failed Dependency) because the request needs to be atomic.

Tags:

  • access - public

Overridden in child classes as:

Sabre_CalDAV_Backend_PDO::updateCalendar()
Updates a calendars properties
Webcal_Sabre_CalDAV_Backend_PDO::updateCalendar()
Updates a calendars properties

Parameters:

  • string $calendarId -
  • array $properties -

[ Top ]

updateCalendarObject

void updateCalendarObject( string $calendarId, string $objectUri, string $calendarData)

[line 123]

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

Tags:

  • abstract -

Overridden in child classes as:

Sabre_CalDAV_Backend_PDO::updateCalendarObject()
Updates an existing calendarobject, based on it's uri.
Webcal_Sabre_CalDAV_Backend_PDO::updateCalendarObject()
Updates an existing calendarobject, based on it's uri.
Sabre_CalDAV_Backend_AbstractMock::updateCalendarObject()

Parameters:

  • string $calendarId -
  • string $objectUri -
  • string $calendarData -

[ Top ]


Class Constants


Documentation generated on Mon, 31 May 2010 12:52:52 -0400 by phpDocumentor 1.4.3