Docs For Class Sabre_CalDAV

Description

Implements interfaces:

Sabre_DAV_IExtendedCollection

The UserCalenders class contains all calendars associated to one user

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/UserCalendars.php (line 12)

Variable Summary

Sabre_DAV_Auth_Backend_Abstract $authBackend

Sabre_CalDAV_Backend_Abstract $caldavBackend

array $userUri

Method Summary

Sabre_CalDAV_UserCalendars __construct (Sabre_DAV_Auth_Backend_Abstract $authBackend, Sabre_CalDAV_Backend_Abstract $caldavBackend, mixed $userUri)

bool childExists (string $name)

void createDirectory (string $filename)

void createExtendedCollection (string $name, $resourceType, $properties)

void createFile (string $filename, [resource $data = null])

void delete ()

Sabre_CalDAV_Calendar getChild (string $name)

array getChildren ()

int getLastModified ()

string getName ()

void setName (string $name)

Variables

Sabre_DAV_Auth_Backend_Abstract $authBackend (line 19)

Authentication backend

access: protected

Sabre_CalDAV_Backend_Abstract $caldavBackend (line 33)

CalDAV backend

access: protected

array $userUri (line 26)

Array with user information

access: protected

Methods

Constructor __construct (line 42)

Constructor

access: public

Sabre_CalDAV_UserCalendars __construct (Sabre_DAV_Auth_Backend_Abstract $authBackend, Sabre_CalDAV_Backend_Abstract $caldavBackend, mixed $userUri)

Sabre_DAV_Auth_Backend_Abstract $authBackend
Sabre_CalDAV_Backend_Abstract $caldavBackend
mixed $userUri

childExists (line 150)

Checks if a calendar exists.

todo: needs optimizing
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 119)

Creates a new directory under this object.

This is currently not allowed.

access: public

void createDirectory (string $filename)

string $filename

Implementation of:

Sabre_DAV_ICollection::createDirectory(): Creates a new subdirectory

createExtendedCollection (line 184)

Creates a new calendar

access: public

void createExtendedCollection (string $name, $resourceType, $properties)

string $name
string $properties
array $resourceType

Implementation of:

Sabre_DAV_IExtendedCollection::createExtendedCollection(): Creates a new collection

createFile (line 105)

Creates a new file under this object.

This is currently not allowed

access: public

void createFile (string $filename, [resource $data = null])

string $filename
resource $data

Implementation of:

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

delete (line 79)

Deletes this object

access: public

void delete ()

Implementation of:

Sabre_DAV_INode::delete(): Deleted the current node

getChild (line 132)

Returns a single calendar, by name

todo: needs optimizing
access: public

Sabre_CalDAV_Calendar getChild (string $name)

string $name

Implementation of:

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

getChildren (line 166)

Returns a list of calendars

access: public

array getChildren ()

Implementation of:

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

getLastModified (line 90)

Returns the last modification date

access: public

int getLastModified ()

Implementation of:

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

getName (line 55)

Returns the name of this object

access: public

string getName ()

Implementation of:

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

setName (line 68)

Updates the name of this object

access: public

void setName (string $name)

string $name

Implementation of:

Sabre_DAV_INode::setName(): Renames the node

Class Sabre_CalDAV_UserCalendars