Docs For Class Sabre_DAV

Description

Implements interfaces:

Sabre_DAV_ICollection

Directory class

This is a helper class, that should aid in getting directory classes setup. Most of its methods are implemented, and throw permission denied exceptions

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

Located in /sources_custom/Sabre/DAV/Directory.php (line 15)

Sabre_DAV_Node
   |
   --Sabre_DAV_Directory

Direct descendents

Class	Description
Sabre_CalDAV_CalendarRootNode	Users collection
Sabre_DAV_Auth_PrincipalCollection	Principals Collection
Sabre_DAV_SimpleDirectory	SimpleDirectory

Method Summary

bool childExists (string $name)

void createDirectory (string $name)

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

Sabre_DAV_INode getChild (string $name)

Methods

childExists (line 46)

Checks is a child-node exists.

It is generally a good idea to try and override this. Usually it can be optimized.

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 82)

Creates a new subdirectory

throws: Sabre_DAV_Exception_Forbidden
access: public

void createDirectory (string $name)

string $name

Implementation of:

Sabre_DAV_ICollection::createDirectory(): Creates a new subdirectory

createFile (line 69)

Creates a new file in the directory

throws: Sabre_DAV_Exception_Forbidden
access: public

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

string $name: Name of the file
resource $data: Initial payload, passed as a readable stream resource.

Implementation of:

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

getChild (line 27)

Returns a child object, by its name.

This method makes use of the getChildren method to grab all the child nodes, and compares the name. Generally its wise to override this, as this can usually be optimized

throws: Sabre_DAV_Exception_FileNotFound
access: public

Sabre_DAV_INode getChild (string $name)

string $name

Implementation of:

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

Redefined in descendants as:

Sabre_DAV_SimpleDirectory::getChild() : Returns a child object, by its name.

Inherited Methods

Inherited From Sabre_DAV_Node

Sabre_DAV_Node::delete()
Sabre_DAV_Node::getLastModified()
Sabre_DAV_Node::setName()

Class Sabre_DAV_Directory

Inherited Methods