OpenMediaVault  0.6 (Kralizec)
The open network attached storage solution
 All Classes Functions Variables Groups Pages
Protected Member Functions | List of all members
OMVDownloadRpcProxy Class Reference
Inheritance diagram for OMVDownloadRpcProxy:
OMVJsonRpcProxy OMVObject

Protected Member Functions

 getParams ()
 
 handleResponse ($response)
 
- Protected Member Functions inherited from OMVJsonRpcProxy
 getParams ()
 
 validate (&$errors)
 
 preExecute ()
 
 postExecute (&$response)
 
 handleResponse ($response)
 
- Protected Member Functions inherited from OMVObject
 setLastError ($error)
 
 debug ()
 

Additional Inherited Members

- Public Member Functions inherited from OMVJsonRpcProxy
 handle ()
 
 cleanup ()
 
- Public Member Functions inherited from OMVObject
 __construct ()
 
 getLastError ()
 
- Protected Attributes inherited from OMVJsonRpcProxy
 $params = NULL
 
 $paramsSchema
 

Detailed Description

A specialized RPC proxy that handles file downloads.

Member Function Documentation

OMVDownloadRpcProxy::handleResponse (   $response)
protected
Parameters
responseThe response must contain the following fields filename, content or filepath and contenttype which is optional. The field content contains the content to be returned, filepath contains the name of the file which content should be returned. Please note that the file must be readable for everybody. If unlink is set then the given file will be removed after use. The fields content and filepath exclude each other. Only The field contenttype contains the 'Content-Type' header string if set, otherwise it is set to 'text/plain'.

The documentation for this class was generated from the following file: