Path

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

eZ Components 2007.2alpha1

Webdav: ezcWebdavBackend

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

Class: ezcWebdavBackend

Base interface for all webdav backends serving the actual data. [source]
The backend is meant to be exxtended by an implementation for your data storage. It enforces the base features required for each backend and should be extended by further indeterfaces for other access methods, like:

Descendents

Child Class Description
ezcWebdavSimpleBackend This backend provides the generic handling of requests and dispatches the requuired actions to some basic manipulation methods, which you are required to implement.

Constants

COMPRESSION_BZIP2 = 2 Backend has native support for bzip2 compression.
COMPRESSION_GZIP = 1 Backend has native support for gzip compression.
CUSTOM_LOCK = 4 Backend performs locking itself - no handling by server is required.
MULTIPART = 16 Backend has native support for multipart requests.
PARTIAL = 8 Backend has native support for partial requests.

Method Summary

public abstract ezcWebdavResponse get( $request )
Required method to serve GET requests.
public int getFeatures( )
Return bitmap of additional features supported by the backend referenced by constants from the basic ezcWebdavBackend class.
public abstract ezcWebdavResponse head( $request )
Required method to serve HEAD requests.
public ezcWebdavResponse options( $request )
Required method to serve OPTIONS requests.
public ezcWebdavResponse performRequest( $request )
Performs the given request.
public abstract ezcWebdavResponse propFind( $request )
Required method to serve PROPFIND requests.
public abstract ezcWebdavResponse propPatch( $request )
Required method to serve PROPPATCH requests.

Methods

get

ezcWebdavResponse get( ezcWebdavGetRequest $request )
Required method to serve GET requests.
The method receives a ezcWebdavGetRequest object containing all relevant information obout the clients request and should either return an error by returning an ezcWebdavErrorResponse object, or any other ezcWebdavResponse objects.

Parameters

Name Type Description
$request ezcWebdavGetRequest  

Redefined in descendants as

Method Description
ezcWebdavSimpleBackend::get() Required method to serve GET requests.

getFeatures

int getFeatures( )
Return bitmap of additional features supported by the backend referenced by constants from the basic ezcWebdavBackend class.

Redefined in descendants as

Method Description
ezcWebdavSimpleBackend::getFeatures() Return bitmap of additional features supported by the backend referenced by constants from the basic ezcWebdavBackend class.

head

ezcWebdavResponse head( ezcWebdavHeadRequest $request )
Required method to serve HEAD requests.
The method receives a ezcWebdavHeadRequest object containing all relevant information obout the clients request and should either return an error by returning an ezcWebdavErrorResponse object, or any other ezcWebdavResponse objects.

Parameters

Name Type Description
$request ezcWebdavGetRequest  

Redefined in descendants as

Method Description
ezcWebdavSimpleBackend::head() Required method to serve HEAD requests.

options

ezcWebdavResponse options( ezcWebdavOptionsRequest $request )
Required method to serve OPTIONS requests.
The method receives a ezcWebdavOptionsRequest object containing all relevant information obout the clients request and should either return an error by returning an ezcWebdavErrorResponse object, or any other ezcWebdavResponse objects.

Parameters

Name Type Description
$request ezcWebdavOptionsRequest  

performRequest

ezcWebdavResponse performRequest( ezcWebdavRequest $request )
Performs the given request.
This method takes an instance of ezcWebdavRequest in $request and dispatches it locally to the correct handling method. A corresponding ezcWebdavResponse object will be returned. If the given request could not be dispatched, because the backend does not implement the neccessary interface or the request type is unknown, a ezcWebdavRequestNotSupportedException is thrown.

Parameters

Name Type Description
$request ezcWebdavRequest  

Throws

ClassDescription
ezcWebdavRequestNotSupportedException if the given request object could not be handled by the backend.

propFind

ezcWebdavResponse propFind( ezcWebdavPropFindRequest $request )
Required method to serve PROPFIND requests.
The method receives a ezcWebdavPropFindRequest object containing all relevant information obout the clients request and should either return an error by returning an ezcWebdavErrorResponse object, or any other ezcWebdavResponse objects.
The ezcWebdavPropFindRequest object contains a definition to find one or more properties of a given file or collection.

Parameters

Name Type Description
$request ezcWebdavPropFindRequest  

Redefined in descendants as

Method Description
ezcWebdavSimpleBackend::propFind() Required method to serve PROPFIND requests.

propPatch

ezcWebdavResponse propPatch( ezcWebdavPropPatchRequest $request )
Required method to serve PROPPATCH requests.
The method receives a ezcWebdavPropPatchRequest object containing all relevant information obout the clients request and should either return an error by returning an ezcWebdavErrorResponse object, or any other ezcWebdavResponse objects.

Parameters

Name Type Description
$request ezcWebdavPropPatchRequest  

Redefined in descendants as

Method Description
ezcWebdavSimpleBackend::propPatch() Required method to serve PROPPATCH requests.

Last updated: Mon, 12 Nov 2007