openmediavault  4.0 (Arrakis)
The open network attached storage solution
Protected Member Functions | List of all members
OMV\Rpc\Proxy\Download Class Reference
Inheritance diagram for OMV\Rpc\Proxy\Download:
OMV\Rpc\Proxy\Json

Protected Member Functions

 getParams ()
 
 handleResponse ($response)
 
- Protected Member Functions inherited from OMV\Rpc\Proxy\Json
 getParams ()
 
 validate ()
 
 preExecute ()
 
 postExecute (&$response)
 
 handleResponse ($response)
 

Additional Inherited Members

- Public Member Functions inherited from OMV\Rpc\Proxy\Json
 handle ()
 
 cleanup ()
 
- Protected Attributes inherited from OMV\Rpc\Proxy\Json
 $params = NULL
 

Detailed Description

A specialized RPC proxy that handles file downloads.

Member Function Documentation

◆ handleResponse()

OMV\Rpc\Proxy\Download::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: