Sabre\DAV\SimpleCollection Class Reference

SimpleCollection. More...

Inheritance diagram for Sabre\DAV\SimpleCollection:

Collaboration diagram for Sabre\DAV\SimpleCollection:

Public Member Functions
	__construct ($name, array $children=[])
	Creates this node. More...
	addChild (INode $child)
	Adds a new childnode to this collection. More...
	getName ()
	Returns the name of the collection. More...
	getChild ($name)
	Returns a child object, by its name. More...
	getChildren ()
	Returns a list of children for this collection. 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...

Protected Attributes
	$children = []
	$name

Detailed Description

SimpleCollection.

The SimpleCollection is used to quickly setup static directory structures. Just create the object with a proper name, and add children to use it.

Copyright

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

Author

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

Definition at line 15 of file SimpleCollection.php.

Constructor & Destructor Documentation

__construct()

Sabre\DAV\SimpleCollection::__construct	(		$name,
		array	$children = []
	)

Creates this node.

The name of the node must be passed, child nodes can also be passed. This nodes must be instances of INode

Parameters

string	$name
	INode[]	$children

Definition at line 40 of file SimpleCollection.php.

References Sabre\DAV\SimpleCollection\$children, Sabre\DAV\SimpleCollection\$name, and Sabre\DAV\SimpleCollection\addChild().

                                                      {

        $this->name = $name;
        foreach ($children as $child) {

            if (!($child instanceof INode)) throw new Exception('Only instances of Sabre\DAV\INode are allowed to be passed in the children argument');
            $this->addChild($child);

        }

    }

Here is the call graph for this function:

Member Function Documentation

addChild()

Sabre\DAV\SimpleCollection::addChild

(

INode

$child

)

Adds a new childnode to this collection.

Parameters

INode

$child

Returns

void

Definition at line 58 of file SimpleCollection.php.

References Sabre\DAV\INode\getName().

Referenced by Sabre\DAV\SimpleCollection\__construct().

                                    {

        $this->children[$child->getName()] = $child;

    }

Here is the call graph for this function:

Here is the caller graph for this function:

getChild()

Sabre\DAV\SimpleCollection::getChild

(

$name

)

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

This method must throw Sabre if the node does not exist.

Parameters

string

$name

Exceptions

Exception

Implements Sabre\DAV\ICollection.

Definition at line 88 of file SimpleCollection.php.

References Sabre\DAV\SimpleCollection\$name, and Sabre\DAV\SimpleCollection\getName().

                             {

        if (isset($this->children[$name])) return $this->children[$name];
        throw new Exception\NotFound('File not found: ' . $name . ' in \'' . $this->getName() . '\'');

    }

Here is the call graph for this function:

getChildren()

Sabre\DAV\SimpleCollection::getChildren

(

)

Returns a list of children for this collection.

Returns

INode[]

Implements Sabre\DAV\ICollection.

Definition at line 100 of file SimpleCollection.php.

Referenced by Sabre\DAV\Sync\MockSyncCollection\getChanges().

                           {

        return array_values($this->children);

    }

Here is the caller graph for this function:

getName()

Sabre\DAV\SimpleCollection::getName

(

)

Returns the name of the collection.

Returns

string

Implements Sabre\DAV\INode.

Definition at line 69 of file SimpleCollection.php.

References Sabre\DAV\SimpleCollection\$name.

Referenced by Sabre\DAV\SimpleCollection\getChild().

                       {

        return $this->name;

    }

Here is the caller graph for this function:

Field Documentation

$children

Sabre\DAV\SimpleCollection::$children = []

protected

Definition at line 22 of file SimpleCollection.php.

Referenced by Sabre\DAV\SimpleCollection\__construct().

$name

Sabre\DAV\SimpleCollection::$name

protected

Definition at line 29 of file SimpleCollection.php.

Referenced by Sabre\DAV\SimpleCollection\__construct(), Sabre\DAV\SimpleCollection\getChild(), and Sabre\DAV\SimpleCollection\getName().

---

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

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