Docs For Class jResponseBinary

Description

Response use to send a binary file to the browser

Located in /core/response/jResponseBinary.class.php (line 20)

jResponse
   |
   --jResponseBinary

Variable Summary

string $content

boolean $doDownload

string $fileName

string $mimeType

string $outputFileName

string $_type

Method Summary

boolean output ()

void outputErrors ()

void _downloadHeader ()

Variables

string $content = null (line 41)

the content you want to send. Keep empty if you indicate a filename

access: public

boolean $doDownload = true (line 48)

Says if the "save as" dialog appear or not to the user.

if false, specify the mime type in $mimetype

access: public

string $fileName = '' (line 30)

The path of the file you want to send. Keep empty if you provide the content

access: public

string $mimeType = 'application/octet-stream' (line 55)

The mimeType of the current binary file.

It will be sent in the header "Content-Type".

access: public

string $outputFileName = '' (line 35)

name of the file under which the content will be send to the user

access: public

string $_type = 'binary' (line 24)

access: protected

Redefinition of:

jResponse::$_type: ident of the response type

Inherited Variables

Inherited from jResponse

jResponse::$_acceptSeveralErrors
jResponse::$_errorMessages
jResponse::$_httpHeaders
jResponse::$_httpHeadersSent
jResponse::$_httpStatusCode
jResponse::$_httpStatusMsg

Methods

output (line 61)

send the content or the file to the browser.

return: true it it's ok
access: public

boolean output ()

Redefinition of:

jResponse::output(): Send the response in the correct format.

outputErrors (line 114)

access: public

void outputErrors ()

Redefinition of:

jResponse::outputErrors(): Send a response with only error messages which appears during the action

_downloadHeader (line 101)

set all headers to force download

access: protected

void _downloadHeader ()

Inherited Methods

Inherited From jResponse

jResponse::__construct()
jResponse::acceptSeveralErrors()
jResponse::addHttpHeader()
jResponse::clearHttpHeaders()
jResponse::getFormatType()
jResponse::getType()
jResponse::hasErrors()
jResponse::output()
jResponse::outputErrors()
jResponse::sendHttpHeaders()
jResponse::setHttpStatus()