Collection
extends Node
in package
implements
ICollection
Collection class.
This is a helper class, that should aid in getting collections classes setup. Most of its methods are implemented, and throw permission denied exceptions
Tags
Interfaces, Classes and Traits
- ICollection
- The ICollection Interface.
Table of Contents
- 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 the current node.
- getChild() : INode
- Returns a child object, by its name.
- getLastModified() : int
- Returns the last modification time as a unix timestamp.
- setName() : mixed
- Renames the node.
Methods
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
Tags
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 the current node.
public
delete() : mixed
Tags
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 —getLastModified()
Returns the last modification time as a unix timestamp.
public
getLastModified() : int
If the information is not available, return null.
Return values
int —setName()
Renames the node.
public
setName(string $name) : mixed
Parameters
- $name : string
-
The new name