Docs For Class Sabre_CalDAV

Class Sabre_CalDAV_Calendar

Description

Implements interfaces:

This object represents a CalDAV calendar.

A calendar can contain multiple TODO and or Events. These are represented as Sabre_CalDAV_CalendarObject objects.

author: Evert Pot (http://www.rooftopsolutions.nl/)
copyright: Copyright (C) 2007-2010 Rooftop Solutions. All rights reserved.
license: Modified BSD License

Located in /sources_custom/Sabre/CalDAV/Calendar.php (line 15)

Method Summary

void __construct (Sabre_DAV_Auth_Backend_Abstract $authBackend, Sabre_CalDAV_Backend_Abstract $caldavBackend, array $calendarInfo)

bool childExists (string $name)

void createDirectory (string $name)

void createFile (string $name, [resource $calendarData = null])

void delete ()

Sabre_DAV_ICalendarObject getChild (string $name)

array getChildren ()

void getLastModified ()

string getName ()

array getProperties ( $requestedProperties, array $properties)

bool hasPrivilege ()

void setName (string $newName)

array updateProperties (array $mutations)

Methods

Constructor __construct (line 45)

Constructor

access: public

void __construct (Sabre_DAV_Auth_Backend_Abstract $authBackend, Sabre_CalDAV_Backend_Abstract $caldavBackend, array $calendarInfo)

Sabre_CalDAV_Backend_Abstract $caldavBackend
array $calendarInfo
Sabre_DAV_Auth_Backend_Abstract $authBackend

childExists (line 153)

Checks if a child-node exists.

access: public

bool childExists (string $name)

string $name

Implementation of:

Sabre_DAV_ICollection::childExists(): Checks if a child-node with the specified name exists

createDirectory (line 172)

Creates a new directory

We actually block this, as subdirectories are not allowed in calendars.

access: public

void createDirectory (string $name)

string $name

Implementation of:

Sabre_DAV_ICollection::createDirectory(): Creates a new subdirectory

createFile (line 188)

Creates a new file

The contents of the new file must be a valid ICalendar string.

access: public

void createFile (string $name, [resource $calendarData = null])

string $name
resource $calendarData

Implementation of:

Sabre_DAV_ICollection::createFile(): Creates a new file in the directory

delete (line 205)

Deletes the calendar.

access: public

void delete ()

Implementation of:

Sabre_DAV_INode::delete(): Deleted the current node

getChild (line 121)

Returns a calendar object

The contained calendar objects are for example Events or Todo's.

access: public

Sabre_DAV_ICalendarObject getChild (string $name)

string $name

Implementation of:

Sabre_DAV_ICollection::getChild(): Returns a specific child node, referenced by its name

getChildren (line 135)

Returns the full list of calendar objects

access: public

array getChildren ()

Implementation of:

Sabre_DAV_ICollection::getChildren(): Returns an array with all the child nodes

getLastModified (line 231)

Returns the last modification date as a unix timestamp.

access: public

void getLastModified ()

Implementation of:

Sabre_DAV_INode::getLastModified(): Returns the last modification time, as a unix timestamp

getName (line 59)

Returns the name of the calendar

access: public

string getName ()

Implementation of:

Sabre_DAV_INode::getName(): Returns the name of the node

getProperties (line 84)

Returns the list of properties

access: public

array getProperties ( $requestedProperties, array $properties)

array $properties
$requestedProperties

Implementation of:

Sabre_DAV_IProperties::getProperties(): Returns a list of properties for this nodes.

hasPrivilege (line 246)

Check if user has access.

This method does a check if the currently logged in user has permission to access this calendar. There is only read-write access, so you're in or you're out.

access: protected

bool hasPrivilege ()

setName (line 219)

Renames the calendar. Note that most calendars use the {DAV:}displayname to display a name to display a name.

access: public

void setName (string $newName)

string $newName

Implementation of:

Sabre_DAV_INode::setName(): Renames the node

updateProperties (line 71)

Updates properties such as the display name and description

access: public

array updateProperties (array $mutations)

array $mutations

Implementation of:

Sabre_DAV_IProperties::updateProperties(): Updates properties on this node,

Documentation generated on Sun, 02 Jan 2011 23:09:49 +0000 by phpDocumentor 1.4.3