Class jResponseXml

Description

XML response generator

Located in /core/response/jResponseXml.class.php (line 27)

jResponse
   |
   --jResponseXml
Variable Summary
boolean $checkValidity
string $contentTpl
boolean $sendXMLHeader
string $_charset
string $_type
Method Summary
jResponseXml __construct ()
void addCSSStyleSheet ( $src, [ $params = array()])
void addXSLStyleSheet ( $src, [ $params = array()])
boolean output ()
void outputErrors ()
void outputXmlHeader ()
Variables
boolean $checkValidity = false (line 50)

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

  • access: public
jTpl $content = null (line 38)

the template container

  • access: public
string $contentTpl = '' (line 44)

selector of the template file

  • access: public
boolean $sendXMLHeader = TRUE (line 67)

say if the XML header have to be generated

Usefull if the XML string to output already contain the XML header

  • since: 1.0.3
  • access: public
string $_charset (line 56)

The charset

  • access: protected
string $_type = 'xml' (line 32)

Id of the response

  • access: protected

Redefinition of:
jResponse::$_type

Inherited Variables

Inherited from jResponse

jResponse::$forcedHttpVersion
jResponse::$httpVersion
jResponse::$_httpHeaders
jResponse::$_httpHeadersSent
jResponse::$_httpStatusCode
jResponse::$_httpStatusMsg
jResponse::$_outputOnlyHeaders
Methods
Constructor __construct (line 72)

constructor..

jResponseXml __construct ()

Redefinition of:
jResponse::__construct()
constructor
addCSSStyleSheet (line 133)

to add a link to css stylesheet

  • since: 1.0b1
  • access: public
void addCSSStyleSheet ( $src, [ $params = array()])
  • $src
  • $params
addXSLStyleSheet (line 143)

to add a link to an xsl stylesheet

  • since: 1.0b1
  • access: public
void addXSLStyleSheet ( $src, [ $params = array()])
  • $src
  • $params
output (line 82)

generate the xml content and send it to the browser

  • return: true if ok
  • access: public
boolean output ()

Redefinition of:
jResponse::output()
Send the response in the correct format. If errors or exceptions appears during this method, outputErrors will be called. So the the content should be generated using the output buffer if errors can be appeared during this generation. Be care of http headers.
outputErrors (line 123)

output errors if any

  • access: public
void outputErrors ()

Redefinition of:
jResponse::outputErrors()
Send a response with a generic error message.
outputXmlHeader (line 152)

output all processing instructions (stylesheet, xsl..) before the XML content

  • access: protected
void outputXmlHeader ()

Inherited Methods

Inherited From jResponse

jResponse::__construct()
jResponse::addHttpHeader()
jResponse::cleanCacheHeaders()
jResponse::clearHttpHeaders()
jResponse::getFormatType()
jResponse::getType()
jResponse::isValidCache()
jResponse::output()
jResponse::outputErrors()
jResponse::sendHttpHeaders()
jResponse::setExpires()
jResponse::setHttpStatus()
jResponse::setLifetime()
jResponse::_checkRequestType()
jResponse::_normalizeDate()

Documentation generated on Wed, 04 Jan 2017 22:56:29 +0100 by phpDocumentor 1.4.3