Directory
Directory class.
- Full name:
\Sabre\DAV\FS\Directory
- Parent class:
\Sabre\DAV\FS\Node
- This class implements:
\Sabre\DAV\ICollection
,\Sabre\DAV\IQuota
Methods
createFile
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:
Parameter | Type | Description |
---|---|---|
$name |
string | Name of the file |
$data |
resource|string | Initial payload |
createDirectory
Creates a new subdirectory.
Parameters:
Parameter | Type | Description |
---|---|---|
$name |
string |
getChild
Returns a specific child node, referenced by its name.
This method must throw DAV\Exception\NotFound if the node does not exist.
Parameters:
Parameter | Type | Description |
---|---|---|
$name |
string |
Throws:
getChildren
Returns an array with all the child nodes.
childExists
Checks if a child exists.
Parameters:
Parameter | Type | Description |
---|---|---|
$name |
string |
delete
Deletes all files in this directory, and then itself.
getQuotaInfo
Returns available diskspace information.
Inherited methods
__construct
Sets up the node, expects a full path name.
If $overrideName is set, this node shows up in the tree under a different name. In this case setName() will be disabled.
Parameters:
Parameter | Type | Description |
---|---|---|
$path |
string | |
$overrideName |
string |
getName
Returns the name of the node.
setName
Renames the node.
Parameters:
Parameter | Type | Description |
---|---|---|
$name |
string | The new name |
getLastModified
Returns the last modification time, as a unix timestamp.
Automatically generated on 2025-03-18