jResponseBinary
extends jResponse
in package
Response use to send a binary file to the browser.
Tags
Table of Contents
- $content : string
- the content you want to send. Keep empty if you indicate a filename.
- $deleteFileAfterSending : mixed
- Delete file after the upload.
- $doDownload : bool
- Says if the "save as" dialog appear or not to the user.
- $fileName : string
- The path of the file you want to send. Keep empty if you provide the content.
- $forcedHttpVersion : mixed
- $httpVersion : mixed
- $mimeType : string
- The mimeType of the current binary file.
- $outputFileName : string
- name of the file under which the content will be send to the user.
- $_httpHeaders : array<string|int, mixed>
- $_httpHeadersSent : bool
- $_httpStatusCode : string
- $_httpStatusMsg : string
- $_outputOnlyHeaders : bool
- $_type : string
- __construct() : mixed
- constructor.
- addHttpHeader() : mixed
- add an http header to the response.
- cleanCacheHeaders() : mixed
- Clean the differents caches headers.
- clearHttpHeaders() : mixed
- delete all http headers.
- getFormatType() : string
- return the format type name (eg the family type name).
- getHttpHeaders() : mixed
- getType() : string
- return the response type name.
- isValidCache() : bool
- Use the HTTP headers Last-Modified to see if the resource in client cache is fresh.
- output() : bool
- send the content or the file to the browser.
- outputErrors() : mixed
- Send a response with a generic error message.
- setExpires() : mixed
- Set an expires header to the page/ressource.
- setHttpStatus() : mixed
- set the http status code for the http header.
- setLifetime() : mixed
- Set a life time for the page/ressource.
- _checkRequestType() : mixed
- check if the request is of type GET or HEAD.
- _downloadHeader() : mixed
- set all headers to force download.
- _normalizeDate() : string
- Normalize a date into GMT format.
- sendHttpHeaders() : mixed
- send http headers.
Properties
$content
the content you want to send. Keep empty if you indicate a filename.
public
string
$content
$deleteFileAfterSending
Delete file after the upload.
public
mixed
$deleteFileAfterSending
= alse
$doDownload
Says if the "save as" dialog appear or not to the user.
public
bool
$doDownload
= rue
if false, specify the mime type in $mimetype.
$fileName
The path of the file you want to send. Keep empty if you provide the content.
public
string
$fileName
= ''
$forcedHttpVersion
public
mixed
$forcedHttpVersion
= alse
$httpVersion
public
mixed
$httpVersion
= '1.1'
$mimeType
The mimeType of the current binary file.
public
string
$mimeType
= 'application/octet-stream'
It will be sent in the header "Content-Type".
$outputFileName
name of the file under which the content will be send to the user.
public
string
$outputFileName
= ''
$_httpHeaders
protected
array<string|int, mixed>
$_httpHeaders
= array()
list of http headers that will be send to the client
$_httpHeadersSent
protected
bool
$_httpHeadersSent
= alse
indicates if http headers have already been sent to the client
$_httpStatusCode
protected
string
$_httpStatusCode
= '200'
the http status code to send
$_httpStatusMsg
protected
string
$_httpStatusMsg
= 'OK'
the http status message to send
$_outputOnlyHeaders
protected
bool
$_outputOnlyHeaders
= alse
Should we output only the headers or the entire response
$_type
protected
string
$_type
= 'binary'
Methods
__construct()
constructor.
public
__construct() : mixed
Return values
mixed —addHttpHeader()
add an http header to the response.
public
addHttpHeader(string $htype, string $hcontent[, int $overwrite = true ]) : mixed
will be send during the output of the response.
Parameters
- $htype : string
-
the header type ("Content-Type", "Date-modified"...)
- $hcontent : string
-
value of the header type
- $overwrite : int = true
-
false or 0 if the value should be set only if it doesn't still exist -1 to add the header with the existing values true or 1 to replace the existing header
Return values
mixed —cleanCacheHeaders()
Clean the differents caches headers.
public
cleanCacheHeaders() : mixed
Return values
mixed —clearHttpHeaders()
delete all http headers.
public
clearHttpHeaders() : mixed
Return values
mixed —getFormatType()
return the format type name (eg the family type name).
public
getFormatType() : string
Return values
string —the name
getHttpHeaders()
public
getHttpHeaders() : mixed
Return values
mixed —getType()
return the response type name.
public
final getType() : string
Return values
string —the name
isValidCache()
Use the HTTP headers Last-Modified to see if the resource in client cache is fresh.
public
isValidCache([mixed $dateLastModified = null ][, null|mixed $etag = null ][, bool $cleanCacheHeader = true ]) : bool
Parameters
- $dateLastModified : mixed = null
-
Can be a jDateTime object, a DateTime object or a string understandable by strtotime
- $etag : null|mixed = null
- $cleanCacheHeader : bool = true
-
True for clean/delete other cache headers. Default : true.
Return values
bool —True if the client resource version is fresh, false otherwise
output()
send the content or the file to the browser.
public
output() : bool
Tags
Return values
bool —true it it's ok
outputErrors()
Send a response with a generic error message.
public
outputErrors() : mixed
Return values
mixed —setExpires()
Set an expires header to the page/ressource.
public
setExpires(mixed $date[, mixed $cleanCacheHeader = true ]) : mixed
Parameters
- $date : mixed
- $cleanCacheHeader : mixed = true
Tags
Return values
mixed —setHttpStatus()
set the http status code for the http header.
public
setHttpStatus(string $code, string $msg) : mixed
Parameters
- $code : string
-
the status code (200, 404...)
- $msg : string
-
the message following the status code ("OK", "Not Found"..)
Return values
mixed —setLifetime()
Set a life time for the page/ressource.
public
setLifetime(int $time[, bool $sharedCache = false ][, mixed $cleanCacheHeader = true ]) : mixed
Parameters
- $time : int
-
Time during which the page will be cached. Express in seconds.
- $sharedCache : bool = false
-
True if the lifetime concern a public/shared cache. Default : false.
- $cleanCacheHeader : mixed = true
Return values
mixed —_checkRequestType()
check if the request is of type GET or HEAD.
protected
_checkRequestType() : mixed
Return values
mixed —_downloadHeader()
set all headers to force download.
protected
_downloadHeader() : mixed
Return values
mixed —_normalizeDate()
Normalize a date into GMT format.
protected
_normalizeDate(mixed $date) : string
Parameters
- $date : mixed
-
Can be a jDateTime object, a DateTime object or a string understandable by strtotime
Return values
string —a date in GMT format
sendHttpHeaders()
send http headers.
protected
sendHttpHeaders() : mixed