Jelix 1.6
Back to top  

jResponseBinary

Extends \jResponse

Response use to send a binary file to the browser

package

jelix
subpackage

core_response

Methods

constructor

__construct()
inherited

check if the request is of type GET or HEAD

_checkRequestType()
inherited

set all headers to force download

_downloadHeader()

Normalize a date into GMT format

_normalizeDate(mixed $date) : string
inherited

Arguments

$date

mixed

Can be a jDateTime object, a DateTime object or a string understandable by strtotime

Response

string

a date in GMT format

add an http header to the response.

addHttpHeader(string $htype, string $hcontent, integer $overwrite = true)
inherited

will be send during the output of the response

Arguments

$htype

string

the header type ("Content-Type", "Date-modified"...)

$hcontent

string

value of the header type

$overwrite

integer

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

Clean the differents caches headers

cleanCacheHeaders()
inherited

delete all http headers

clearHttpHeaders()
inherited

return the format type name (eg the family type name)

getFormatType() : string
inherited

Response

string

the name

return the response type name

getType() : string
inherited final

Response

string

the name

Use the HTPP headers Last-Modified to see if the ressource in client cache is fresh

isValidCache(mixed $dateLastModified = null,  $etag = null, boolean $cleanCacheHeader = true) : boolean
inherited

Arguments

$dateLastModified

mixed

Can be a jDateTime object, a DateTime object or a string understandable by strtotime

$etag

$cleanCacheHeader

boolean

True for clean/delete other cache headers. Default : true.

Response

boolean

True if the client ressource version is fresh, false otherwise

send the content or the file to the browser.

output() : boolean
Throws
\jException

Response

boolean

true it it's ok

Send a response with a generic error message.

outputErrors()
inherited

send http headers

sendHttpHeaders()
inherited

Set an expires header to the page/ressource.

setExpires( $date,  $cleanCacheHeader = true)
inherited
see \_normalizeDate

Arguments

$date

$cleanCacheHeader

set the http status code for the http header

setHttpStatus(string $code, string $msg)
inherited

Arguments

$code

string

the status code (200, 404...)

$msg

string

the message following the status code ("OK", "Not Found"..)

Set a life time for the page/ressource.

setLifetime(integer $time, boolean $sharedCache = false,  $cleanCacheHeader = true)
inherited

Arguments

$time

integer

Time during which the page will be cached. Express in seconds.

$sharedCache

boolean

True if the lifetime concern a public/shared cache. Default : false.

$cleanCacheHeader

Properties

ident of the response type

_type : string
inherited
var

ident of the response type

Type(s)

string

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

fileName : string
var

Type(s)

string

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

outputFileName : string
var

Type(s)

string

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

content : string
var

Type(s)

string

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

doDownload : boolean

if false, specify the mime type in $mimetype

var

Type(s)

boolean

The mimeType of the current binary file.

mimeType : string

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

var

Type(s)

string

list of http headers that will be send to the client

_httpHeaders : array
inherited
var

list of http headers that will be send to the client

Type(s)

array

indicates if http headers have already been sent to the client

_httpHeadersSent : boolean
inherited
var

indicates if http headers have already been sent to the client

Type(s)

boolean

the http status code to send

_httpStatusCode : string
inherited
var

the http status code to send

Type(s)

string

the http status message to send

_httpStatusMsg : string
inherited
var

the http status message to send

Type(s)

string

Should we output only the headers or the entire response

_outputOnlyHeaders : boolean
inherited
var

Should we output only the headers or the entire response

Type(s)

boolean

httpVersion

httpVersion :
inherited

Type(s)

forcedHttpVersion

forcedHttpVersion :
inherited

Type(s)