WebDAV Class

Properties   Methods   Events   Configuration Settings   Errors  

The WebDAV Component implements an easy-to-use interface to the Web Distributed Authoring and Versioning protocol (WebDAV).

Class Name

IPWorks_WebDAV

Procedural Interface

 ipworks_webdav_open();
 ipworks_webdav_close($res);
 ipworks_webdav_register_callback($res, $id, $function);
 ipworks_webdav_get_last_error($res);
 ipworks_webdav_get_last_error_code($res);
 ipworks_webdav_set($res, $id, $index, $value);
 ipworks_webdav_get($res, $id, $index);
 ipworks_webdav_do_addcookie($res, $cookiename, $cookievalue);
 ipworks_webdav_do_addnamespace($res, $prefix, $namespaceuri);
 ipworks_webdav_do_config($res, $configurationstring);
 ipworks_webdav_do_copyresource($res, $sourceresourceuri, $destinationresourceuri);
 ipworks_webdav_do_deleteresource($res, $resourceuri);
 ipworks_webdav_do_doevents($res);
 ipworks_webdav_do_findproperties($res, $resourceuri);
 ipworks_webdav_do_findpropertynames($res, $resourceuri);
 ipworks_webdav_do_getproperty($res, $propertyname);
 ipworks_webdav_do_getresource($res, $resourceuri);
 ipworks_webdav_do_interrupt($res);
 ipworks_webdav_do_listdirectory($res, $resourceuri);
 ipworks_webdav_do_lockresource($res, $resourceuri);
 ipworks_webdav_do_makedirectory($res, $resourceuri);
 ipworks_webdav_do_moveresource($res, $sourceresourceuri, $destinationresourceuri);
 ipworks_webdav_do_patchproperties($res, $resourceuri);
 ipworks_webdav_do_posttoresource($res, $resourceuri, $postdata);
 ipworks_webdav_do_putresource($res, $resourceuri);
 ipworks_webdav_do_reset($res);
 ipworks_webdav_do_setproperty($res, $propertyname, $propertyvalue);
 ipworks_webdav_do_unlockresource($res, $resourceuri);

Remarks

The class allows remote management of resource properties and properties, including creation, deletion, listing, copying, and moving. Resource locking is also supported.

The ListDirectory and FindProperties methods will list the properties of a resource properties or resource, and a DirList or ResourceProperties event will be fired for each matching resource.

Depth is used to determine which resources or properties are retrieved from the server. A depth of ResourceOnly will return only the resource associated with ResourceURI, or its properties. A depth of Infinity will return all resources contained within hierarchy, or their collective properties.

Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return a HTTP 403 Forbidden response.

A number of operations can be performed on resources by using the various methods of the class. Please refer to the individual methods for more information.

WebDAV allows non-standard properties to be specified through XML namespaces.

The namespaces are provided in the Namespaces properties, which is filled automatically when retrieving DAV responses, but must be filled manually when requesting non-standard properties.