Interface: Sabre_DAV_IProperties

Source Location: /includes/classes/SabreDAV/lib/Sabre/DAV/IProperties.php

Interface Overview [line 14]

Sabre_DAV_INode
   |
   --Sabre_DAV_IProperties

IProperties interface

Author(s):

  • Evert Pot (http://www.rooftopsolutions.nl/)

Version:

Copyright:

  • Copyright (C) 2007-2010 Rooftop Solutions. All rights reserved.

Variables

Constants

Methods


Inherited Variables

Inherited Constants

Inherited Methods

Class: Sabre_DAV_INode

Sabre_DAV_INode::delete()
Deleted the current node
Sabre_DAV_INode::getLastModified()
Returns the last modification time, as a unix timestamp
Sabre_DAV_INode::getName()
Returns the name of the node
Sabre_DAV_INode::setName()
Renames the node


Class Details

IProperties interface

Implement this interface to support custom WebDAV properties requested and sent from clients.

Tags:

[ Top ]


Class Variables


Class Methods

getProperties

void getProperties( array $properties)

[line 64]

Returns a list of properties for this nodes.

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.

Parameters:

  • array $properties -

[ Top ]

updateProperties

bool|array updateProperties( $properties, array $mutations)

[line 51]

Updates properties on this node,

The properties array uses the propertyName in clark-notation as key, and the array value for the property value. In the case a property should be deleted, the property value will be null.

This method must be atomic. If one property cannot be changed, the entire operation must fail.

If the operation was successful, true can be returned. If the operation failed, false can be returned.

Deletion of a non-existant property is always succesful.

Lastly, it is optional to return detailed information about any failures. In this case an array should be returned with the following structure:

array( 403 => array( '{DAV:}displayname' => null, ), 424 => array( '{DAV:}owner' => null, ) )

In this example it was forbidden to update {DAV:}displayname. (403 Forbidden), which in turn also caused {DAV:}owner to fail (424 Failed Dependency) because the request needs to be atomic.

Parameters:

  • array $mutations -
  • $properties -

[ Top ]


Class Constants


Documentation generated on Mon, 31 May 2010 12:53:34 -0400 by phpDocumentor 1.4.3