Implements interfaces
Inherited Variables
Inherited Constants
Inherited Methods
Class Details
This object represents a CalDAV calendar.
A calendar can contain multiple TODO and or Events. These are represented as Sabre_CalDAV_CalendarObject objects.
Tags:
- author - Evert Pot (http://www.rooftopsolutions.nl/)
- copyright - Copyright (C) 2007-2009 Rooftop Solutions. All rights reserved.
- license - Modified BSD License
[ Top ]
Class Variables
Class Methods
__construct
void __construct(
Sabre_DAV_Auth_Backend_Abstract
$authBackend, Sabre_CalDAV_Backend_Abstract
$caldavBackend, array
$calendarInfo)
[line 45]
Constructor
Tags:
- access - public
Parameters:
- Sabre_CalDAV_Backend_Abstract $caldavBackend -
- array $calendarInfo -
- Sabre_DAV_Auth_Backend_Abstract $authBackend -
[ Top ]
createDirectory
void createDirectory(
string
$name)
[line 153]
Creates a new directory
We actually block this, as subdirectories are not allowed in calendars.
Tags:
- access - public
- Sabre_DAV_ICollection::createDirectory()
- Creates a new subdirectory
Parameters:
- string $name -
[ Top ]
createFile
void createFile(
string
$name, [resource
$calendarData = null])
[line 169]
Creates a new file
The contents of the new file must be a valid ICalendar string.
Tags:
- access - public
- Sabre_DAV_ICollection::createFile()
- Creates a new file in the directory
Parameters:
- string $name -
- resource $calendarData -
[ Top ]
delete
void delete(
)
[line 186]
Deletes the calendar.
Tags:
- access - public
- Sabre_DAV_INode::delete()
- Deleted the current node
Parameters:
[ Top ]
getChild
Sabre_DAV_ICalendarObject getChild(
string
$name)
[line 121]
Returns a calendar object
The contained calendar objects are for example Events or Todo's.
Tags:
- access - public
- Sabre_DAV_ICollection::getChild()
- Returns a specific child node, referenced by its name
Parameters:
- string $name -
[ Top ]
getChildren
array getChildren(
)
[line 133]
Returns the full list of calendar objects
Tags:
- access - public
- Sabre_DAV_ICollection::getChildren()
- Returns an array with all the child nodes
Parameters:
[ Top ]
getLastModified
void getLastModified(
)
[line 212]
Returns the last modification date as a unix timestamp.
Tags:
- access - public
- Sabre_DAV_INode::getLastModified()
- Returns the last modification time, as a unix timestamp
Parameters:
[ Top ]
getName
string getName(
)
[line 59]
Returns the name of the calendar
Tags:
- access - public
- Sabre_DAV_INode::getName()
- Returns the name of the node
Parameters:
[ Top ]
getProperties
array getProperties(
$requestedProperties, array
$properties)
[line 84]
Returns the list of properties
Tags:
- access - public
- Sabre_DAV_IProperties::getProperties()
- Returns a list of properties for this nodes.
Parameters:
- array $properties -
- $requestedProperties -
[ Top ]
hasPrivilege
bool hasPrivilege(
)
[line 227]
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.
Tags:
- access - protected
Parameters:
[ Top ]
setName
void setName(
string
$newName)
[line 200]
Renames the calendar. Note that most calendars use the {DAV:}displayname to display a name to display a name.
Tags:
- access - public
- Sabre_DAV_INode::setName()
- Renames the node
Parameters:
- string $newName -
[ Top ]
updateProperties
array updateProperties(
array
$mutations)
[line 71]
Updates properties such as the display name and description
Tags:
- access - public
- Sabre_DAV_IProperties::updateProperties()
- Updates properties on this node,
Parameters:
- array $mutations -
[ Top ]