Zeta Components - high quality PHP components

This basis transport class is able to interact with RFC 2518 compliant WebDAV clients. It can parse all request types defined in the RFC into the abstraction layer of the Webdav component, defined by the base classes mentioned below. An exception are LOCK related requests, which will be handled by a plugin.

To adjust this base transport layer main class to the needs of RFC-2518-inconform client implementations, there is the powerful possibility of extending this class and overwriting certain necessary protected methods. The easier way to adjust smaller issues is to replace one of the helper components during construction of via property access.

The ezcWebdavServer->xmlTool property will be used which is accessed for different XML related operations. Exchanging this one will allow you to manipulate the XML handling for the transport layer in general.

The ezcWebdavServer->propertyHandler property, of type ezcWebdavPropertyHandler will be used in the accordingly named property and is responsible for extracting WebDAV properties from a DOMElement and to serialize them back to one.

The ezcWebdavServer->pathFactory property must be an instance of ezcWebdavPathFactory and is used to convert between internal WebDAV paths (resource locations understood by the ezcWebdavBackend) and URIs that reference a resource on the web.

An instance of this class is by default capable of parsing the follwoing HTTP request methods:

• COPY
• DELETE
• GET
• HEAD
• MKCOL
• MOVE
• OPTIONS
• PROPFIND
• PROPPATCH'
• PUT

The transport implementation is capable of handling the following response classes and output the to the client:

• ezcWebdavCopyResponse
• ezcWebdavDeleteResponse
• ezcWebdavErrorResponse
• ezcWebdavGetCollectionResponse
• ezcWebdavGetResourceResponse
• ezcWebdavHeadResponse
• ezcWebdavMakeCollectionResponse
• ezcWebdavMoveResponse
• ezcWebdavMultiStatusResponse
• ezcWebdavOptionsResponse
• ezcWebdavPropFindResponse
• ezcWebdavPropPatchResponse
• ezcWebdavPutResponse

Takes a given ezcWebdavDisplayInformation object and returns an array containg the headers and body it represents.

The returned information can be processed (send out to the client) by ezcWebdavTransport::sendResponse().

Takes the given exception $e and generates a response object from it. The $uri parameter will be given to ezcWebdavErrorResponse::__construct().

For special exceptions, special responses will be generated:

• ezcWebdavBadRequestException: 400 Bad Request
• ezcWebdavInvalidRequestMethodException: 501 Not Implemented

Per default, a 500 Internal Server Error response will be generated.

Depending on where this is called, the generatedResponse hook will be issued (if during request parsing), but the processErrorResponse hooks will allways be called. NOTE: The plugin API is not public, yet, and will be part of a next release.

This method is part of the integral communication API between the WebDAV client and the ezcWebdavServer. It is declared final to ensure a minimal compatibile API between the extended classes and it is responsible to dispatch the ezcWebdavPluginRegistry hooks. NOTE: The plugin API is not public, yet, and will be part of a next release.

It currently just maps internally to processResponse() and passes the result to {@ $this->sendResponse()}. It is not recommended that the $this->processResponse() method is overwritten, because this one takes care about the dispatching. The $this->sendResponse() may be overwritten, mainly for debugging, testing and logging purposes.

This method is responsible for parsing the COPY request. It retrieves the current request URI in $path and the request body as $body. The return value, if no exception is thrown, is a valid ezcWebdavCopyRequest object.

This method may be overwritten to adjust it to special client behaviour.

This method is responsible for parsing the DELETE request. It retrieves the current request URI in $path and the request body as $body. The return value, if no exception is thrown, is a valid ezcWebdavDeleteRequest object.

This method may be overwritten to adjust it to special client behaviour.

This method is responsible for parsing the GET request. It retrieves the current request URI in $path and the request body as $body. The return value, if no exception is thrown, is a valid ezcWebdavGetResourceResponse object.

This method may be overwritten to adjust it to special client behaviour.

This method is responsible for parsing the HEAD request. It retrieves the current request URI in $path and the request body as $body. The return value, if no exception is thrown, is a valid ezcWebdavHeadRequest object.

This method may be overwritten to adjust it to special client behaviour.

This method is responsible for parsing the MKCOL request. It retrieves the current request URI in $path and the request body as $body. The return value, if no exception is thrown, is a valid ezcWebdavMakeCollectionRequest object.

This method may be overwritten to adjust it to special client behaviour.

This method is responsible for parsing the MOVE request. It retrieves the current request URI in $path and the request body as $body. The return value, if no exception is thrown, is a valid ezcWebdavMoveRequest object.

This method may be overwritten to adjust it to special client behaviour.

This method is responsible for parsing the OPTIONS request. It retrieves the current request URI in $path and the request body as $body. The return value, if no exception is thrown, is a valid ezcWebdavOptionsRequest object.

This method may be overwritten to adjust it to special client behaviour.

This element is part of the COPY and MOVE requests, which are handled by $this->parseCopyRequest() respectivly $this->parseMoveRequest().

The $dom parameter is the DOMDocument where the <propertybehavior /> content should be parsed from. The $request object submitted will get the resulting ezcWebdavRequestPropertyBehaviourContent set into its $propertyBehavior property.

This method may be overwritten to adjust it to special client behaviour. If you overwrite the $this->processCopyResponse() or $this->parseMoveRequest() methods, you might disable this method accedentally. You should explicitly use it there and overwrite it, if necessary. This makes extending your extended transport easier.

This method is responsible for parsing the PROPFIND request. It retrieves the current request URI in $path and the request body as $body. The return value, if no exception is thrown, is a valid ezcWebdavPropFindRequest object.

This method may be overwritten to adjust it to special client behaviour.

This method is responsible for parsing the PROPPATCH request. It retrieves the current request URI in $path and the request body as $body. The return value, if no exception is thrown, is a valid ezcWebdavPropPatchRequest object.

This method may be overwritten to adjust it to special client behaviour.

This method is responsible for parsing the PUT request. It retrieves the current request URI in $path and the request body as $body. The return value, if no exception is thrown, is a valid ezcWebdavPutRequest object.

This method may be overwritten to adjust it to special client behaviour.

This method is the main entry point of ezcWebdavServer and is utilized by it to parse the incoming request into an instance of ezcWebdavRequest.

The submitted $uri must be formatted in a way, that the ezcWebdavPathFactory (by default this is ezcWebdavAutomaticPathFactory) can convert it into a path absolute to the base of the WebDAV repository.

The retrieval of the request body is performed by the retrieveBody() method, the request method from $_SERVER['REQUEST_METHOD']. The latter one is mapped through the self::$parsingMap attribute to a local object method.

This method is marked final and may not be overwritten, because it belongs to the essential communication API with ezcWebdavServer and is responsible to dispatch the ezcWebdavPluginRegistry hooks of the transport layer. NOTE: The plugin API is not public, yet, and will be part of a next release.

If an error occurs during request parsing, an instance of ezcWebdavResponse may be returned instead of an instance of ezcWebdavRequest. ezcWebdavServer will handle this correctly.

This method returns the display information generated for a $response object of type ezcWebdavCopyResponse. It returns an instance of ezcWebdavDisplayInformation containing the post-processed response object and the appropriate body.

The display information returned by this method indicates, that only headers, but no response body, should be send.

This method returns the display information generated for a $response object of type ezcWebdavDeleteResponse. It returns an instance of ezcWebdavDisplayInformation containing the post-processed response object and the appropriate body.

The display information returned by this method indicates, that only headers, but no response body, should be send.

This method returns the display information generated for a $response object of type ezcWebdavErrorResponse. It returns an instance of ezcWebdavDisplayInformation containing the post-processed response object and the appropriate body.

The $xml parameter defines, if an XML representation should be generated, too (for use in $this->processMultiStatusResponse()), or if only the headers should be manipulated and an empty response body should be used.

The display information generated by this response contains the post processed $response and a DOMDocument representing the XML response body. If the $xml parameter is set to false, an empty display information is generated, to indicate that only headers should be send.

This method utilizes ezcWebdavServer->xmlTool to perform basic XML operations, so this is the place to perform such changeds. You should overwrite this method, if your client has problems specifically with the ezcWebdavErrorResponse response.

This method returns the display information generated for a $response object of type ezcWebdavGetCollectionResponse. It returns an instance of ezcWebdavDisplayInformation containing the post-processed response object and the appropriate body.

The display information returned by this method indicates, that only headers, but no response body, should be send.

This method returns the display information generated for a $response object of type ezcWebdavGetResourceResponse. It returns an instance of ezcWebdavDisplayInformation containing the post-processed response object and the appropriate body.

This response returns a very seldom (for this component) string response, since it returns the raw content of the requested resource.

This method returns the display information generated for a $response object of type ezcWebdavHeadResponse. It returns an instance of ezcWebdavDisplayInformation containing the post-processed response object and the appropriate body.

The display information returned by this method indicates, that only headers, but no response body, should be send.

This method always must be structured quite similar to $this->processGetCollectionResponse or $this->processGetResourceResponse(), since HEAD is more or less GET without a body.

This method returns the display information generated for a $response object of type ezcWebdavMakeCollectionResponse. It returns an instance of ezcWebdavDisplayInformation containing the post-processed response object and the appropriate body.

The display information returned by this method indicates, that only headers, but no response body, should be send.

This method returns the display information generated for a $response object of type ezcWebdavMoveResponse. It returns an instance of ezcWebdavDisplayInformation containing the post-processed response object and the appropriate body.

The display information returned by this method indicates, that only headers, but no response body, should be send.

This method returns the display information generated for a $response object of type ezcWebdavMultiStatusResponse. It returns an instance of ezcWebdavDisplayInformation containing the post-processed response object and the appropriate body.

The display information generated by this response contains the post processed $response and a DOMDocument representing the XML response body.

This method utilizes ezcWebdavServer->xmlTool to perform basic XML operations, so this is the place to perform such changeds. You should overwrite this method, if your client has problems specifically with the ezcWebdavMultiStatusResponse response.

This method returns the display information generated for a $response object of type ezcWebdavOptionsResponse. It returns an instance of ezcWebdavDisplayInformation containing the post-processed response object and the appropriate body.

The display information returned by this method indicates, that only headers, but no response body, should be send.

This method returns the display information generated for a $response object of type ezcWebdavPropFindResponse. It returns an instance of ezcWebdavDisplayInformation containing the post-processed response object and the appropriate body.

The display information generated by this response contains the post processed $response and a DOMDocument representing the XML response body.

This method utilizes ezcWebdavServer->xmlTool to perform basic XML operations, so this is the place to perform such changeds. You should overwrite this method, if your client has problems specifically with the ezcWebdavPropFindResponse response.

This method returns the display information generated for a $response object of type ezcWebdavPropPatchResponse. It returns an instance of ezcWebdavDisplayInformation containing the post-processed response object and the appropriate body.

The display information returned by this method indicates, that only headers, but no response body, should be send.

This method returns the display information generated for a $response object of type ezcWebdavPropStatResponse. It returns an instance of ezcWebdavDisplayInformation containing the post-processed response object and the appropriate body.

The display information generated by this response contains the post processed $response and a DOMDocument representing the XML response body.

This method utilizes ezcWebdavServer->xmlTool to perform basic XML operations, so this is the place to perform such changeds. You should overwrite this method, if your client has problems specifically with the ezcWebdavPropStatResponse response.

This method returns the display information generated for a $response object of type ezcWebdavPutResponse. It returns an instance of ezcWebdavDisplayInformation containing the post-processed response object and the appropriate body.

The display information returned by this method indicates, that only headers, but no response body, should be send.

This method is only kept for BC reasons. Please refer to retrieveBody().

This method mainly exists for unit testing purpose. It reads the request body and returns the contents as a string. This method can also be usefull to be overriden during inheritence to filter the body of missbehaving WebDAV clients.

This method calls the configured path factory to translate the submitted $uri into a local path. It can be overwritten to perform client specific path adjustments.

This method is called to finally send the response to the client. It can be overwritten in test cases to change the behaviour of printing out the result and sending the headers.