Jelix 1.6
Back to top  

jResponseXml

Extends \jResponse

XML response generator

package

jelix
subpackage

core_response

Methods

constructor

__construct()
inherited

check if the request is of type GET or HEAD

_checkRequestType()
inherited

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

to add a link to css stylesheet

addCSSStyleSheet( $src,  $params = array())
since 1.0b1

Arguments

$src

$params

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

to add a link to an xsl stylesheet

addXSLStyleSheet( $src,  $params = array())
since 1.0b1

Arguments

$src

$params

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

generate the xml content and send it to the browser

output() : boolean
final
Throws
\jException

Response

boolean

true if ok

Send a response with a generic error message.

outputErrors()
inherited

output all processing instructions (stylesheet, xsl.

outputXmlHeader()

.) before the XML content

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 template container

content : \jTpl
var

Type(s)

\jTpl

selector of the template file

contentTpl : string
var

Type(s)

string

if true, verify validity of the xml content, before to output it

checkValidity : boolean
var

Type(s)

boolean

The charset

_charset : string
var

Type(s)

string

_css

_css :

Type(s)

_xsl

_xsl :

Type(s)

say if the XML header have to be generated Usefull if the XML string to output already contain the XML header

sendXMLHeader : boolean
var
since

Type(s)

boolean

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)