Documentation

PropertiesCollection extends Collection
in package

Application

implements IProperties

A node specifically for testing property-related operations.

Interfaces, Classes and Traits

IProperties: IProperties interface.

$failMode : mixed
$properties : mixed
$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 the current node.
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.
getProperties() : array<string|int, mixed>: Returns a list of properties for this nodes.
propPatch() : bool|array<string|int, mixed>: Updates properties on this node.
setName() : mixed: Renames the node.

$failMode


    public
        mixed
    $failMode
     = false

$properties


    public
        mixed
    $properties

$children


    protected
        mixed
    $children

$name


    protected
        mixed
    $name

$parent


    protected
        mixed
    $parent

__construct()

Creates the object.


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

Parameters

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

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


    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

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 —

getProperties()

Returns a list of properties for this nodes.


    public
                getProperties(array<string|int, mixed> $requestedProperties) : array<string|int, mixed>

The properties list is a list of propertynames the client requested, encoded in clark-notation {xmlnamespace}tagname

If the array is empty, it means 'all properties' were requested.

Note that it's fine to liberally give properties back, instead of conforming to the list of requested properties. The Server class will filter out the extra.

Parameters

$requestedProperties : array<string|int, mixed>

Return values

array<string|int, mixed> —

propPatch()

Updates properties on this node.


    public
                propPatch(PropPatch $proppatch) : bool|array<string|int, mixed>

This method received a PropPatch object, which contains all the information about the update.

To update specific properties, call the 'handle' method on this object. Read the PropPatch documentation for more information.

Parameters

$proppatch : PropPatch

Return values

bool|array<string|int, mixed> —

setName()

Renames the node.


    public
                setName(string $name) : mixed

Parameters

$name : string: The new name

Return values

mixed —