Class HTTP_WebDAV_Server_Horde

Description

Horde extension of the base HTTP_WebDAV_Server class.

Located in /RPC/RPC/webdav.php (line 81)

HTTP_WebDAV_Server
   |
   --HTTP_WebDAV_Server_Horde
Variable Summary
Method Summary
 void checkLock ( $resource)
 boolean check_auth (string $type, string $username, string $password)
 string|boolean DELETE (array $options)
 string|boolean GET ( &$options, array $options)
 int LOCK (array &$params)
 string MKCOL (array $options)
 string MOVE (array $options)
 boolean PROPFIND (array $options, array &$files)
 string|boolean PUT (array &$options)
 int UNLOCK (array &$params)
 integer _checkHTTPcode (integer $code)
 mixed _list (string $path, string $depth, array $properties)
Variables
string $dav_powered_by = 'Horde WebDAV Server' (line 95)

String to be used in "X-Dav-Powered-By" header

string $http_auth_realm = 'Horde WebDAV' (line 88)

Realm string to be used in authentification popups

Methods
checkLock (line 519)
void checkLock ( $resource)
  • $resource
check_auth (line 574)

Check authentication. We always return true here since we handle permissions based on the resource that's requested, but we do record the authenticated user for later use.

  • return: Authentication status. Always true.
boolean check_auth (string $type, string $username, string $password)
  • string $type: Authentication type, e.g. "basic" or "digest"
  • string $username: Transmitted username.
  • string $password: Transmitted password.
DELETE (line 182)

Performs a WebDAV DELETE.

Deletes a single object from a database. The path passed in must be in [app]/[path] format.

  • return: HTTP-Statuscode.
  • see: HTTP_WebDAV_Server::http_DELETE()
string|boolean DELETE (array $options)
  • array $options: An array of parameters from the setup method in HTTP_WebDAV_Server.
GET (line 110)

GET implementation.

  • return: HTTP-Statuscode.
string|boolean GET ( &$options, array $options)
  • array $options: Array of input and output parameters.
    <strong>input</strong>
    • path -

    <strong>output</strong>
    • size -
  • &$options
LOCK (line 415)

Attempts to set a lock on a specified resource.

  • return: HTTP status code
int LOCK (array &$params)
  • array &$params: Reference to array of parameters. These parameters should be overwritten with the lock information.
MKCOL (line 238)

MKCOL method handler

  • return: HTTP response string
string MKCOL (array $options)
  • array $options
MOVE (line 273)

MOVE method handler

  • return: HTTP response string
string MOVE (array $options)
  • array $options
PROPFIND (line 219)

PROPFIND method handler

  • return: True on success.
boolean PROPFIND (array $options, array &$files)
  • array $options: General parameter passing array.
  • array &$files: Return array for file properties.
PUT (line 136)

PUT implementation.

  • return: HTTP-Statuscode.
string|boolean PUT (array &$options)
  • array &$options: Parameter passing array.
UNLOCK (line 490)

Attempts to remove a specified lock.

  • return: HTTP status code
int UNLOCK (array &$params)
  • array &$params: Reference to array of parameters. These parameters should be overwritten with the lock information.
_checkHTTPcode (line 597)

Make sure the error code returned in the PEAR_Error object is a valid HTTP response code.

This is necessary because in pre-Horde 3.2 apps the response codes are not sanitized. This backward compatibility check can be removed when we drop support for pre-3.2 apps. Intentionally, not every valid HTTP code is listed here. Only common ones are here to reduce the possibility of an invalid code being confused with a valid HTTP code.

  • return: Either the original code if valid or 500 for internal server error.
  • todo: Remove for Horde 4.0
integer _checkHTTPcode (integer $code)
  • integer $code: Status code to check for validity.
_list (line 317)

Generates a response to a GET or PROPFIND request.

  • return: Array of objects with properties if the request is a dir, array of file metadata + data if request is a file, false if the object is not found.
mixed _list (string $path, string $depth, array $properties)
  • string $path: Path of GET or PROPFIND request.
  • string $depth: 0, 1, or infinity.
  • array $properties: A list of requested properties on the object.

Documentation generated on Sun, 30 Jan 2011 05:23:26 +0000 by phpDocumentor 1.4.3