Documentation

Sabre
DAV

TreeMultiGetTester extends TreeDirectoryTester
in package

Application

implements IMultiGet

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.

Interfaces, Classes and Traits

IMultiGet: IMultiGet.

$isDeleted : mixed
$isRenamed : mixed
$newDirectories : mixed
$newFiles : mixed
$children : array<string|int, INode>: List of childnodes.
$name : string: Name of this resource.
__construct() : mixed: Creates this node.
addChild() : mixed: Adds a new childnode 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 the current node.
getChild() : INode: Returns a child object, by its name.
getChildren() : array<string|int, INode>: Returns a list of children for this collection.
getLastModified() : int: Returns the last modification time as a unix timestamp.
getMultipleChildren() : array<string|int, mixed>: This method receives a list of paths in it's first argument.
getName() : string: Returns the name of the collection.
setName() : mixed: Renames the node.

$isDeleted


    public
        mixed
    $isDeleted
     = false

$isRenamed


    public
        mixed
    $isRenamed
     = false

$newDirectories


    public
        mixed
    $newDirectories
     = []

$newFiles


    public
        mixed
    $newFiles
     = []

$children

List of childnodes.


    protected
        array<string|int, INode>
    $children
     = []

$name

Name of this resource.


    protected
        string
    $name

__construct()

Creates this node.


    public
                __construct(string $name[, array<string|int, INode> $children = [] ]) : mixed

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

Parameters

$name : string
$children : array<string|int, INode> = []

Return values

mixed —

addChild()

Adds a new childnode to this collection.


    public
                addChild(INode $child) : mixed

Parameters

$child : 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 the current node.


    public
                delete() : mixed

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

Return values

INode —

getChildren()

Returns a list of children for this collection.


    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 —

getMultipleChildren()

This method receives a list of paths in it's first argument.


    public
                getMultipleChildren(array<string|int, mixed> $paths) : array<string|int, mixed>

It must return an array with Node objects.

If any children are not found, you do not have to return them.

Parameters

$paths : array<string|int, mixed>

Return values

array<string|int, mixed> —

getName()

Returns the name of the collection.


    public
                getName() : string

Return values

string —

setName()

Renames the node.


    public
                setName(string $name) : mixed

Parameters

$name : string: The new name

Return values

mixed —