Path

ez components / documentation / api reference / 2007.2alpha1 / webdav


eZ Components 2007.2alpha1

Webdav: ezcWebdavUnlockRequest

[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcWebdavUnlockRequest

Request class generated by a LOCK request. [source]
This request represents the WebDAV LOCK action.
An object of this class may have 1 of 3 possible properties used. If none is used, it must be asumed that the $allProp property is set to true.
The $allProp property indicates, that a list of all available properties is required, including the value of each property. In contrast, the $propName property indicates, that only a list of property names, without property values, is requested. The $prop property is of type array (or null, if not set) and can contain a list of property names, which are requested to be returned, including their values.
Optional headers for this request are:
  • Depth (default: ezcWebdavRequest::DEPTH_INFINITY)

Parents

ezcWebdavRequest
   |
   --ezcWebdavUnlockRequest

Inherited Constants

From ezcWebdavRequest:
ezcWebdavRequest::DEPTH_INFINITY
ezcWebdavRequest::DEPTH_ONE
ezcWebdavRequest::DEPTH_ZERO    Constants for the 'Depth' header and property fields.

Properties

bool read/write  $allProp
Representing the <allprop /> XML element.
array(string) read/write  $prop
Representing the <prop /> XML element. Can contain a list of property names.
bool read/write  $propName
Representing the <propname /> XML element.

Inherited Member Variables

From ezcWebdavRequest:
protected  ezcWebdavRequest::$headers
protected  ezcWebdavRequest::$properties

Method Summary

public void validateHeaders( )
Validates the headers set in this request.

Inherited Methods

From ezcWebdavRequest :
public void ezcWebdavRequest::__construct()
Construct request class with requested URI
public mixed ezcWebdavRequest::getHeader()
Returns the contents of a specific header.
public void ezcWebdavRequest::setHeader()
Sets a header to a specified value.
public void ezcWebdavRequest::setHeaders()
Sets a header to a specified value.
public void ezcWebdavRequest::validateHeaders()
Validates the headers set in this request.

Methods

validateHeaders

void validateHeaders( )
Validates the headers set in this request.
This method validates that all required headers are available and that all feasible headers for this request have valid values.

Throws

ClassDescription
ezcWebdavMissingHeaderException if a required header is missing.
ezcWebdavInvalidHeaderException if a header is present, but its content does not validate.

Redefinition of

Method Description
ezcWebdavRequest::validateHeaders() Validates the headers set in this request.

Last updated: Mon, 12 Nov 2007