Docs For Class Sabre_DAV

Description

ObjectTree class

This implementation of the Tree class makes use of the INode, IFile and ICollection API's

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/DAV/ObjectTree.php (line 14)

Sabre_DAV_Tree
   |
   --Sabre_DAV_ObjectTree

Variable Summary

array $cache

Sabre_DAV_ICollection $rootNode

Method Summary

void __construct (Sabre_DAV_ICollection $rootNode)

array getChildren (string $path)

Sabre_DAV_INode getNodeForPath (string $path)

void markDirty (string $path)

bool nodeExists (string $path)

Variables

array $cache = array() (line 28)

This is the node cache. Accessed nodes are stored here

access: protected

Sabre_DAV_ICollection $rootNode (line 21)

The root node

access: protected

Methods

Constructor __construct (line 38)

Creates the object

This method expects the rootObject to be passed as a parameter

access: public

void __construct (Sabre_DAV_ICollection $rootNode)

Sabre_DAV_ICollection $rootNode

getChildren (line 104)

Returns a list of childnodes for a given path.

access: public

array getChildren (string $path)

string $path

Redefinition of:

Sabre_DAV_Tree::getChildren(): Returns a list of childnodes for a given path.

getNodeForPath (line 50)

Returns the INode object for the requested path

access: public

Sabre_DAV_INode getNodeForPath (string $path)

string $path

Redefinition of:

Sabre_DAV_Tree::getNodeForPath(): This function must return an INode object for a path If a Path doesn't exist, thrown an Exception_FileNotFound

markDirty (line 135)

This method is called with every tree update

Examples of tree updates are: * node deletions * node creations * copy * move * renaming nodes

If Tree classes implement a form of caching, this will allow them to make sure caches will be expired.

If a path is passed, it is assumed that the entire subtree is dirty

access: public

void markDirty (string $path)

string $path

Redefinition of:

Sabre_DAV_Tree::markDirty(): This method is called with every tree update

nodeExists (line 82)

This function allows you to check if a node exists.

access: public

bool nodeExists (string $path)

string $path

Redefinition of:

Sabre_DAV_Tree::nodeExists(): This function allows you to check if a node exists.

Inherited Methods

Inherited From Sabre_DAV_Tree

Sabre_DAV_Tree::copy()
Sabre_DAV_Tree::copyNode()
Sabre_DAV_Tree::delete()
Sabre_DAV_Tree::getChildren()
Sabre_DAV_Tree::getNodeForPath()
Sabre_DAV_Tree::markDirty()
Sabre_DAV_Tree::move()
Sabre_DAV_Tree::nodeExists()

Class Sabre_DAV_ObjectTree

Inherited Methods