Collection
extends Collection
in package
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.
Tags
Table of Contents
- $children : mixed
- $name : mixed
- $parent : mixed
- __construct() : mixed
- Creates the object.
- addNode() : mixed
- Adds an already existing node to this collection.
- childExists() : bool
- Checks is a child-node exists.
- createDirectory() : mixed
- Creates a new subdirectory.
- createFile() : string|null
- Creates a new file in the directory.
- delete() : mixed
- Deletes this collection and all its children,.
- deleteChild() : mixed
- Removes a childnode from this node.
- getChild() : INode
- Returns a child object, by its name.
- getChildren() : array<string|int, INode>
- Returns an array with all the child nodes.
- getLastModified() : int
- Returns the last modification time as a unix timestamp.
- getName() : string
- Returns the name of the node.
- setName() : mixed
- Renames the node.
Properties
$children
protected
mixed
$children
$name
protected
mixed
$name
$parent
protected
mixed
$parent
Methods
__construct()
Creates the object.
public
__construct(string $name[, array<string|int, mixed> $children = [] ][, Collection $parent = null ]) : mixed
Parameters
- $name : string
- $children : array<string|int, mixed> = []
- $parent : Collection = null
Return values
mixed —addNode()
Adds an already existing node to this collection.
public
addNode(INode $node) : mixed
Parameters
- $node : INode
Return values
mixed —childExists()
Checks is a child-node exists.
public
childExists(string $name) : bool
It is generally a good idea to try and override this. Usually it can be optimized.
Parameters
- $name : string
Return values
bool —createDirectory()
Creates a new subdirectory.
public
createDirectory(string $name) : mixed
Parameters
- $name : string
Return values
mixed —createFile()
Creates a new file in the directory.
public
createFile(string $name[, resource|string $data = null ]) : string|null
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
- $name : string
-
Name of the file
- $data : resource|string = null
-
Initial payload
Return values
string|null —delete()
Deletes this collection and all its children,.
public
delete() : mixed
Return values
mixed —deleteChild()
Removes a childnode from this node.
public
deleteChild(string $name) : mixed
Parameters
- $name : string
Return values
mixed —getChild()
Returns a child object, by its name.
public
getChild(string $name) : INode
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\DAV\Exception\NotFound if the node does not exist.
Parameters
- $name : string
Tags
Return values
INode —getChildren()
Returns an array with all the child nodes.
public
getChildren() : array<string|int, INode>
Return values
array<string|int, INode> —getLastModified()
Returns the last modification time as a unix timestamp.
public
getLastModified() : int
If the information is not available, return null.
Return values
int —getName()
Returns the name of the node.
public
getName() : string
This is used to generate the url.
Return values
string —setName()
Renames the node.
public
setName(string $name) : mixed
Parameters
- $name : string
-
The new name