IProperties
extends
INode
in
IProperties interface.
Implement this interface to support custom WebDAV properties requested and sent from clients.
Tags
Table of Contents
- delete() : mixed
- Deleted the current node.
- getLastModified() : int|null
- Returns the last modification time, as a unix timestamp. Return null if the information is not available.
- getName() : string
- Returns the name of the node.
- getProperties() : array<string|int, mixed>
- Returns a list of properties for this nodes.
- propPatch() : mixed
- Updates properties on this node.
- setName() : mixed
- Renames the node.
Methods
delete()
Deleted the current node.
public
delete() : mixed
Return values
mixed —getLastModified()
Returns the last modification time, as a unix timestamp. Return null if the information is not available.
public
getLastModified() : int|null
Return values
int|null —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> $properties) : 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
- $properties : array<string|int, mixed>
Return values
array<string|int, mixed> —propPatch()
Updates properties on this node.
public
propPatch(PropPatch $propPatch) : 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
mixed —setName()
Renames the node.
public
setName(string $name) : mixed
Parameters
- $name : string
-
The new name