Sabre\DAV\Tree Class Reference

The tree object is responsible for basic tree operations. More...

Inheritance diagram for Sabre\DAV\Tree:

Collaboration diagram for Sabre\DAV\Tree:

Public Member Functions
	__construct (ICollection $rootNode)
	Creates the object. More...
	getNodeForPath ($path)
	Returns the INode object for the requested path. More...
	nodeExists ($path)
	This function allows you to check if a node exists. More...
	copy ($sourcePath, $destinationPath)
	Copies a file from path to another. More...
	move ($sourcePath, $destinationPath)
	Moves a file from one location to another. More...
	delete ($path)
	Deletes a node from the tree. More...
	getChildren ($path)
	Returns a list of childnodes for a given path. More...
	markDirty ($path)
	This method is called with every tree update. More...
	getMultipleNodes ($paths)
	This method tells the tree system to pre-fetch and cache a list of children of a single parent. More...

Protected Member Functions
	copyNode (INode $source, ICollection $destinationParent, $destinationName=null)
	copyNode More...

Protected Attributes
	$rootNode
	$cache = []

Detailed Description

The tree object is responsible for basic tree operations.

It allows for fetching nodes by path, facilitates deleting, copying and moving.

Copyright

Copyright (C) fruux GmbH (https://fruux.com/)

Author

Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License

Definition at line 17 of file Tree.php.

Constructor & Destructor Documentation

__construct()

Sabre\DAV\Tree::__construct

(

ICollection

$rootNode

)

Creates the object.

This method expects the rootObject to be passed as a parameter

Parameters

ICollection

$rootNode

Definition at line 41 of file Tree.php.

References Sabre\DAV\Tree\$rootNode.

                                                {

        $this->rootNode = $rootNode;

    }

Member Function Documentation

copy()

Sabre\DAV\Tree::copy	(		$sourcePath,
			$destinationPath
	)

Copies a file from path to another.

Parameters

string	$sourcePath	The source location
string	$destinationPath	The full destination path

Returns

void

Definition at line 122 of file Tree.php.

References Sabre\DAV\Tree\copyNode(), Sabre\DAV\Tree\getNodeForPath(), Sabre\DAV\Tree\markDirty(), and Sabre\HTTP\URLUtil\splitPath().

Referenced by Sabre\DAV\Tree\move().

                                                 {

        $sourceNode = $this->getNodeForPath($sourcePath);

        // grab the dirname and basename components
        list($destinationDir, $destinationName) = URLUtil::splitPath($destinationPath);

        $destinationParent = $this->getNodeForPath($destinationDir);
        $this->copyNode($sourceNode, $destinationParent, $destinationName);

        $this->markDirty($destinationDir);

    }

Here is the call graph for this function:

Here is the caller graph for this function:

copyNode()

Sabre\DAV\Tree::copyNode ( INode  $source, ICollection  $destinationParent,   $destinationName = null  )

protected

copyNode

Parameters

INode	$source
ICollection	$destinationParent
string	$destinationName

Returns

void

Definition at line 299 of file Tree.php.

References $data, $destination, GuzzleHttp\Psr7\$stream, Sabre\DAV\ICollection\createDirectory(), Sabre\DAV\ICollection\createFile(), Sabre\DAV\ICollection\getChild(), and Sabre\DAV\INode\getName().

Referenced by Sabre\DAV\Tree\copy().

                                                                                                        {

        if (!$destinationName) $destinationName = $source->getName();

        if ($source instanceof IFile) {

            $data = $source->get();

            // If the body was a string, we need to convert it to a stream
            if (is_string($data)) {
                $stream = fopen('php://temp', 'r+');
                fwrite($stream, $data);
                rewind($stream);
                $data = $stream;
            }
            $destinationParent->createFile($destinationName, $data);
            $destination = $destinationParent->getChild($destinationName);

        } elseif ($source instanceof ICollection) {

            $destinationParent->createDirectory($destinationName);

            $destination = $destinationParent->getChild($destinationName);
            foreach ($source->getChildren() as $child) {

                $this->copyNode($child, $destination);

            }

        }
        if ($source instanceof IProperties && $destination instanceof IProperties) {

            $props = $source->getProperties([]);
            $propPatch = new PropPatch($props);
            $destination->propPatch($propPatch);
            $propPatch->commit();

        }

    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

Sabre\DAV\Tree::delete

(

$path

)

Deletes a node from the tree.

Parameters

string

$path

Returns

void

Definition at line 176 of file Tree.php.

References $path, Sabre\DAV\Tree\getNodeForPath(), Sabre\DAV\Tree\markDirty(), and Sabre\HTTP\URLUtil\splitPath().

                           {

        $node = $this->getNodeForPath($path);
        $node->delete();

        list($parent) = URLUtil::splitPath($path);
        $this->markDirty($parent);

    }

Here is the call graph for this function:

getChildren()

Sabre\DAV\Tree::getChildren

(

$path

)

Returns a list of childnodes for a given path.

Parameters

string

$path

Returns

array

Definition at line 192 of file Tree.php.

References $path, and Sabre\DAV\Tree\getNodeForPath().

                                {

        $node = $this->getNodeForPath($path);
        $children = $node->getChildren();
        $basePath = trim($path, '/');
        if ($basePath !== '') $basePath .= '/';

        foreach ($children as $child) {

            $this->cache[$basePath . $child->getName()] = $child;

        }
        return $children;

    }

Here is the call graph for this function:

getMultipleNodes()

Sabre\DAV\Tree::getMultipleNodes

(

$paths

)

This method tells the tree system to pre-fetch and cache a list of children of a single parent.

There are a bunch of operations in the WebDAV stack that request many children (based on uris), and sometimes fetching many at once can optimize this.

This method returns an array with the found nodes. It's keys are the original paths. The result may be out of order.

Parameters

array

$paths

List of nodes that must be fetched.

Returns

array

Definition at line 253 of file Tree.php.

References $path, $paths, $result, Sabre\DAV\Tree\getNodeForPath(), and Sabre\HTTP\URLUtil\splitPath().

                                      {

        // Finding common parents
        $parents = [];
        foreach ($paths as $path) {
            list($parent, $node) = URLUtil::splitPath($path);
            if (!isset($parents[$parent])) {
                $parents[$parent] = [$node];
            } else {
                $parents[$parent][] = $node;
            }
        }

        $result = [];

        foreach ($parents as $parent => $children) {

            $parentNode = $this->getNodeForPath($parent);
            if ($parentNode instanceof IMultiGet) {
                foreach ($parentNode->getMultipleChildren($children) as $childNode) {
                    $fullPath = $parent . '/' . $childNode->getName();
                    $result[$fullPath] = $childNode;
                    $this->cache[$fullPath] = $childNode;
                }
            } else {
                foreach ($children as $child) {
                    $fullPath = $parent . '/' . $child;
                    $result[$fullPath] = $this->getNodeForPath($fullPath);
                }
            }

        }

        return $result;

    }

Here is the call graph for this function:

getNodeForPath()

Sabre\DAV\Tree::getNodeForPath

(

$path

)

Returns the INode object for the requested path.

Parameters

string

$path

Returns

INode

Definition at line 53 of file Tree.php.

References $path, Sabre\DAV\Tree\$rootNode, and Sabre\HTTP\URLUtil\splitPath().

Referenced by Sabre\DAV\Tree\copy(), Sabre\DAV\Tree\delete(), Sabre\DAV\Tree\getChildren(), Sabre\DAV\Tree\getMultipleNodes(), Sabre\DAV\Tree\move(), and Sabre\DAV\Tree\nodeExists().

                                   {

        $path = trim($path, '/');
        if (isset($this->cache[$path])) return $this->cache[$path];

        // Is it the root node?
        if (!strlen($path)) {
            return $this->rootNode;
        }

        // Attempting to fetch its parent
        list($parentName, $baseName) = URLUtil::splitPath($path);

        // If there was no parent, we must simply ask it from the root node.
        if ($parentName === "") {
            $node = $this->rootNode->getChild($baseName);
        } else {
            // Otherwise, we recursively grab the parent and ask him/her.
            $parent = $this->getNodeForPath($parentName);

            if (!($parent instanceof ICollection))
                throw new Exception\NotFound('Could not find node at path: ' . $path);

            $node = $parent->getChild($baseName);

        }

        $this->cache[$path] = $node;
        return $node;

    }

Here is the call graph for this function:

Here is the caller graph for this function:

markDirty()

Sabre\DAV\Tree::markDirty

(

$path

)

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

Parameters

string

$path

Returns

void

Definition at line 226 of file Tree.php.

References $path.

Referenced by Sabre\DAV\Tree\copy(), Sabre\DAV\Tree\delete(), and Sabre\DAV\Tree\move().

                              {

        // We don't care enough about sub-paths
        // flushing the entire cache
        $path = trim($path, '/');
        foreach ($this->cache as $nodePath => $node) {
            if ($path === '' || $nodePath == $path || strpos($nodePath, $path . '/') === 0)
                unset($this->cache[$nodePath]);

        }

    }

Here is the caller graph for this function:

move()

Sabre\DAV\Tree::move	(		$sourcePath,
			$destinationPath
	)

Moves a file from one location to another.

Parameters

string	$sourcePath	The path to the file which should be moved
string	$destinationPath	The full destination path, so not just the destination parent node

Returns

int

Definition at line 143 of file Tree.php.

References $sourceDir, Sabre\DAV\Tree\copy(), Sabre\DAV\Tree\getNodeForPath(), Sabre\DAV\Tree\markDirty(), and Sabre\HTTP\URLUtil\splitPath().

                                                 {

        list($sourceDir) = URLUtil::splitPath($sourcePath);
        list($destinationDir, $destinationName) = URLUtil::splitPath($destinationPath);

        if ($sourceDir === $destinationDir) {
            // If this is a 'local' rename, it means we can just trigger a rename.
            $sourceNode = $this->getNodeForPath($sourcePath);
            $sourceNode->setName($destinationName);
        } else {
            $newParentNode = $this->getNodeForPath($destinationDir);
            $moveSuccess = false;
            if ($newParentNode instanceof IMoveTarget) {
                // The target collection may be able to handle the move
                $sourceNode = $this->getNodeForPath($sourcePath);
                $moveSuccess = $newParentNode->moveInto($destinationName, $sourcePath, $sourceNode);
            }
            if (!$moveSuccess) {
                $this->copy($sourcePath, $destinationPath);
                $this->getNodeForPath($sourcePath)->delete();
            }
        }
        $this->markDirty($sourceDir);
        $this->markDirty($destinationDir);

    }

Here is the call graph for this function:

nodeExists()

Sabre\DAV\Tree::nodeExists

(

$path

)

This function allows you to check if a node exists.

Implementors of this class should override this method to make it cheaper.

Parameters

string

$path

Returns

bool

Definition at line 94 of file Tree.php.

References $base, $path, Sabre\DAV\Tree\getNodeForPath(), and Sabre\HTTP\URLUtil\splitPath().

                               {

        try {

            // The root always exists
            if ($path === '') return true;

            list($parent, $base) = URLUtil::splitPath($path);

            $parentNode = $this->getNodeForPath($parent);
            if (!$parentNode instanceof ICollection) return false;
            return $parentNode->childExists($base);

        } catch (Exception\NotFound $e) {

            return false;

        }

    }

Here is the call graph for this function:

Field Documentation

$cache

Sabre\DAV\Tree::$cache = []

protected

Definition at line 32 of file Tree.php.

$rootNode

Sabre\DAV\Tree::$rootNode

protected

Definition at line 24 of file Tree.php.

Referenced by Sabre\DAV\Tree\__construct(), and Sabre\DAV\Tree\getNodeForPath().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/sabre/dav/lib/DAV/Tree.php