Inheritance diagram for Sabre\DAV\Mock\Collection:

Collaboration diagram for Sabre\DAV\Mock\Collection:

Public Member Functions
	__construct ($name, array $children=[], Collection $parent=null)
	Creates the object. More...

	getName ()
	Returns the name of the node. More...

	createFile ($name, $data=null)
	Creates a new file in the directory. More...

	createDirectory ($name)
	Creates a new subdirectory. More...

	getChildren ()
	Returns an array with all the child nodes. More...

	addNode (\Sabre\DAV\INode $node)
	Adds an already existing node to this collection. More...

	deleteChild ($name)
	Removes a childnode from this node. More...

	delete ()
	Deletes this collection and all its children,. More...

Public Member Functions inherited from Sabre\DAV\Collection
	getChild ($name)
	Returns a child object, by its name. More...

	childExists ($name)
	Checks is a child-node exists. More...

	createFile ($name, $data=null)
	Creates a new file in the directory. More...

	createDirectory ($name)
	Creates a new subdirectory. More...

Public Member Functions inherited from Sabre\DAV\Node
	getLastModified ()
	Returns the last modification time as a unix timestamp. More...

	delete ()
	Deletes the current node. More...

	setName ($name)
	Renames the node. More...

	delete ()
	Deleted the current node. More...

	getName ()
	Returns the name of the node. More...

	setName ($name)
	Renames the node. More...

	getLastModified ()
	Returns the last modification time, as a unix timestamp. More...

	createFile ($name, $data=null)
	Creates a new file in the directory. More...

	createDirectory ($name)
	Creates a new subdirectory. More...

	getChild ($name)
	Returns a specific child node, referenced by its name. More...

	getChildren ()
	Returns an array with all the child nodes. More...

	childExists ($name)
	Checks if a child-node with the specified name exists. More...

Protected Attributes
	$name

	$children

	$parent

Detailed Description

Mock Collection.

This collection quickly allows you to create trees of nodes. Children are specified as an array.

Every key a filename, every array value is either:

an array, for a sub-collection
a string, for a file
An instance of \Sabre\DAV\INode.

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

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

Definition at line 22 of file Collection.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\DAV\Mock\Collection::__construct	(		$name,
		array	$children = `[]`,
		Collection	$parent = `null`
	)

Creates the object.

Parameters

string	$name
array	$children
Collection	$parent

Returns: void

Definition at line 36 of file Collection.php.

                                                                                 {
 
        $this->name = $name;
        foreach ($children as $key => $value) {
            if (is_string($value)) {
                $this->children[] = new File($key, $value, $this);
            } elseif (is_array($value)) {
                $this->children[] = new self($key, $value, $this);
            } elseif ($value instanceof \Sabre\DAV\INode) {
                $this->children[] = $value;
            } else {
                throw new \InvalidArgumentException('Unknown value passed in $children');
            }
        }
        $this->parent = $parent;
 
    }

References Sabre\DAV\Mock\Collection\$children, $key, $name, and Sabre\DAV\Mock\Collection\$parent.

Member Function Documentation

◆ addNode()

Sabre\DAV\Mock\Collection::addNode ( \Sabre\DAV\INode $node )

Adds an already existing node to this collection.

Parameters

\Sabre\DAV\INode $node

Definition at line 129 of file Collection.php.

                                             {
 
        $this->children[] = $node;
 
    }

◆ createDirectory()

Sabre\DAV\Mock\Collection::createDirectory ( $name )

Creates a new subdirectory.

Parameters

string $name

Returns: void

Reimplemented from Sabre\DAV\Collection.

Definition at line 107 of file Collection.php.

                                    {
 
        $this->children[] = new self($name);
 
    }

References $name.

◆ createFile()

Sabre\DAV\Mock\Collection::createFile	(	$name,
		$data = `null`
	)

Creates a new file in the directory.

Data will either be supplied as a stream resource, or in certain cases as a string. Keep in mind that you may have to support either.

After successful creation of the file, you may choose to return the ETag of the new file here.

The returned ETag must be surrounded by double-quotes (The quotes should be part of the actual string).

If you cannot accurately determine the ETag, you should not return it. If you don't store the file exactly as-is (you're transforming it somehow) you should also not return an ETag.

This means that if a subsequent GET to this new file does not exactly return the same contents of what was submitted here, you are strongly recommended to omit the ETag.

Parameters

string	$name	Name of the file
resource \| string	$data	Initial payload

Returns: null|string

Reimplemented from Sabre\DAV\Collection.

Definition at line 91 of file Collection.php.

                                             {
 
        if (is_resource($data)) {
            $data = stream_get_contents($data);
        }
        $this->children[] = new File($name, $data, $this);
        return '"' . md5($data) . '"';
 
    }

References $data, and $name.

◆ delete()

Sabre\DAV\Mock\Collection::delete ( )

Deletes this collection and all its children,.

Returns: void

Reimplemented from Sabre\DAV\Node.

Definition at line 159 of file Collection.php.

                      {
 
        foreach ($this->getChildren() as $child) {
            $this->deleteChild($child->getName());
        }
        $this->parent->deleteChild($this->getName());
 
    }

References Sabre\DAV\Mock\Collection\deleteChild(), Sabre\DAV\ICollection\getChildren(), and Sabre\DAV\INode\getName().

Here is the call graph for this function:

◆ deleteChild()

Sabre\DAV\Mock\Collection::deleteChild ( $name )

Removes a childnode from this node.

Parameters

string $name

Returns: void

Definition at line 141 of file Collection.php.

                                {
 
        foreach ($this->children as $key => $value) {
 
            if ($value->getName() == $name) {
                unset($this->children[$key]);
                return;
            }
 
        }
 
    }

References $key, and $name.

Referenced by Sabre\DAV\Mock\Collection\delete().

Here is the caller graph for this function:

◆ getChildren()

Sabre\DAV\Mock\Collection::getChildren ( )

Returns an array with all the child nodes.

Returns: \Sabre\DAV\INode[]

Implements Sabre\DAV\ICollection.

Definition at line 118 of file Collection.php.

                           {
 
        return $this->children;
 
    }

◆ getName()

Sabre\DAV\Mock\Collection::getName ( )

Returns the name of the node.

This is used to generate the url.

Returns: string

Implements Sabre\DAV\INode.

Definition at line 61 of file Collection.php.

                       {
 
        return $this->name;
 
    }

References $name.

Field Documentation

◆ $children

Sabre\DAV\Mock\Collection::$children

protected

Definition at line 25 of file Collection.php.

Referenced by Sabre\DAV\Mock\Collection\__construct().

◆ $name

Sabre\DAV\Mock\Collection::$name

protected

Definition at line 24 of file Collection.php.

◆ $parent

Sabre\DAV\Mock\Collection::$parent

protected

Definition at line 26 of file Collection.php.

Referenced by Sabre\DAV\Mock\Collection\__construct().

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

libs/composer/vendor/sabre/dav/tests/Sabre/DAV/Mock/Collection.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addNode()

◆ createDirectory()

◆ createFile()

◆ delete()

◆ deleteChild()

◆ getChildren()

◆ getName()

Field Documentation

◆ $children

◆ $name

◆ $parent