Depth Property

The depth associated with the current operation.

Object Oriented Interface

public function getDepth();
public function setDepth($value);

Procedural Interface

ipworks_webdav_get($res, 12 );
ipworks_webdav_set($res, 12, $value );

Default Value

0

Remarks

When performing certain operations on resource collections, the class will use Depth to instruct the server on how deep to operate within the collection. Depth is an enumerated type with the following possible values:

dpUnspecified (0)The server will use the protocol default depth for the operation (this is normally "infinity").
dpResourceOnly (1)The server will operate only on the collection resource URI, and not on any of its internal member resources.
dpImmediateChildren (2)The server will operate on the collection resource URI and all of its immediate member resources (but on none of their member resources).
dpInfinity (3)The server will recursively operate on the target resource URI and all of its internal member URIs through all levels of the collection hierarchy.

Depth is used when performing the following operations: LockResource, MoveResource CopyResource, FindProperties, PatchProperties, and ListDirectory.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 PHP Edition - Version 20.0 [Build 8161]