Docs For Class jResponse

Description

base class for response object A response object is responsible to generate a content in a specific format.

abstract:

Located in /core/jResponse.class.php (line 19)

Direct descendents

Class	Description
jResponseSoap	Response for soap web services
jResponseHtmlFragment	Send Html part
jResponseJson	Json response
jResponseCmdline	Command line response
jResponseRedirectUrl	Response To redirect to an URL
jResponseTcpdf	PDF Response based on TCPDF (http://tcpdf.sourceforge.net)
jResponseBinary	Response use to send a binary file to the browser
jResponseXul	Generate a XUL window
jResponseRedirect	Response To redirect to an action
jResponseXml	XML response generator
jResponseLatexToPdf	pdf response, generated from a latex content
jResponseBasicHtml	Basic HTML response. the HTML content should be provided by a simple php file.
jResponseXmlRpc	xmlrpc response
jResponseRdf	output RDF content.
jResponseCss	Send CSS content
jResponseXMLFeed	Responses for Syndication should inherits from jResponseXMLFeed
jResponseZip	generate a zip content and send it to the browser
jResponseText	plain Text response
jResponseSitemap	Sitemap 0.9 response
jResponseJsonRpc	Response for jsonrpc protocol

Variable Summary

mixed $forcedHttpVersion

mixed $httpVersion

array $_httpHeaders

boolean $_httpHeadersSent

string $_httpStatusCode

string $_httpStatusMsg

string $_type

Method Summary

jResponse __construct ()

void addHttpHeader (string $htype, string $hcontent, [boolean $overwrite = true])

void clearHttpHeaders ()

string getFormatType ()

string getType ()

boolean output ()

void outputErrors ()

void sendHttpHeaders ()

void setHttpStatus (string $code, string $msg)

Variables

mixed $forcedHttpVersion = false (line 46)

access: public

mixed $httpVersion = '1.1' (line 45)

access: public

array $_httpHeaders = array() (line 29)

var: list of http headers that will be send to the client
access: protected

boolean $_httpHeadersSent = false (line 34)

var: indicates if http headers have already been sent to the client
access: protected

string $_httpStatusCode = '200' (line 39)

var: the http status code to send
access: protected

string $_httpStatusMsg = 'OK' (line 43)

var: the http status message to send
access: protected

string $_type = null (line 24)

var: ident of the response type
access: protected

Redefined in descendants as:

jResponseSoap::$_type
jResponseHtmlFragment::$_type : jresponse id
jResponseCmdline::$_type
jResponseRedirectUrl::$_type
jResponseTcpdf::$_type
jResponseBinary::$_type
jResponseXul::$_type
jResponseXulPage::$_type
jResponseXulOverlay::$_type
jResponseXulDialog::$_type
jResponseRedirect::$_type
jResponseXml::$_type : Id of the response
jResponseLatexToPdf::$_type
jResponseBasicHtml::$_type : jresponse id
jResponseHtml::$_type : jresponse id
jResponseXmlRpc::$_type
jResponseRdf::$_type
jResponseCss::$_type
jResponseRss20::$_type
jResponseAtom10::$_type
jResponseZip::$_type
jResponseText::$_type
jResponseSitemap::$_type : Ident of the response type
jResponseJsonRpc::$_type

Methods

Constructor __construct (line 51)

constructor

jResponse __construct ()

Redefined in descendants as:

jResponseHtmlFragment::__construct() : constructor;
jResponseXul::__construct() : constructor
jResponseXml::__construct() : constructor..
jResponseLatexToPdf::__construct() : constructor;
jResponseBasicHtml::__construct() : constructor;
jResponseHtml::__construct() : constructor;
jResponseXMLFeed::__construct() : Class constructor
jResponseRss20::__construct() : Class constructor
jResponseAtom10::__construct() : Class constructor
jResponseZip::__construct() : constructor
jResponseSitemap::__construct() : Class constructor

addHttpHeader (line 107)

add an http header to the response.

will be send during the output of the response

access: public

void addHttpHeader (string $htype, string $hcontent, [boolean $overwrite = true])

string $htype: the header type ("Content-Type", "Date-modified"...)
string $hcontent: value of the header type
boolean $overwrite: false if the value should be set only if it doesn't still exist

clearHttpHeaders (line 116)

delete all http headers

access: public

void clearHttpHeaders ()

getFormatType (line 98)

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

return: the name
access: public

string getFormatType ()

Redefined in descendants as:

getType (line 92)

return the response type name

return: the name
access: public

string getType ()

output (line 68)

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.

return: true if the output is ok
abstract:
access: public

boolean output ()

Redefined in descendants as:

jResponseSoap::output()
jResponseHtmlFragment::output() : send the Html part
jResponseJson::output()
jResponseCmdline::output() : output the content with the text/plain mime type
jResponseRedirectUrl::output()
jResponseTcpdf::output() : send the PDF to the browser.
jResponseBinary::output() : send the content or the file to the browser.
jResponseXul::output() : generate the xul content.
jResponseRedirect::output()
jResponseXml::output() : generate the xml content and send it to the browser
jResponseLatexToPdf::output() : output the pdf content
jResponseBasicHtml::output() : output the html content
jResponseHtml::output() : output the html content
jResponseXmlRpc::output()
jResponseRdf::output()
jResponseCss::output() : send the css content
jResponseRss20::output() : Generate the content and send it.
jResponseAtom10::output() : Generate the content and send it
jResponseZip::output() : construct the zip content into zip format, and send it to the browser
jResponseText::output() : output the content with the text/plain mime type
jResponseSitemap::output() : Generate the content and send it
jResponseJsonRpc::output()

outputErrors (line 73)

Send a response with a generic error message.

access: public

void outputErrors ()

Redefined in descendants as:

jResponseSoap::outputErrors()
jResponseHtmlFragment::outputErrors() : output errors
jResponseJson::outputErrors()
jResponseCmdline::outputErrors() : output errors
jResponseXul::outputErrors()
jResponseXml::outputErrors() : output errors if any
jResponseBasicHtml::outputErrors() : output errors
jResponseXmlRpc::outputErrors()
jResponseText::outputErrors() : output errors
jResponseJsonRpc::outputErrors()

sendHttpHeaders (line 132)

send http headers

access: protected

void sendHttpHeaders ()

Redefined in descendants as:

jResponseCmdline::sendHttpHeaders() : No Http Header here

setHttpStatus (line 127)

set the http status code for the http header

access: public

void setHttpStatus (string $code, string $msg)

string $code: the status code (200, 404...)
string $msg: the message following the status code ("OK", "Not Found"..)