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

Variable Summary

mixed $_acceptSeveralErrors

mixed $_errorMessages

mixed $_httpHeaders

mixed $_httpHeadersSent

mixed $_httpStatusCode

mixed $_httpStatusMsg

string $_type

Method Summary

jResponse __construct ()

boolean acceptSeveralErrors ()

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

void clearHttpHeaders ()

string getFormatType ()

string getType ()

void hasErrors ()

boolean output ()

void outputErrors ()

void sendHttpHeaders ()

void setHttpStatus (string $code, string $msg)

Variables

mixed $_acceptSeveralErrors = true (line 28)

access: protected

Redefined in descendants as:

mixed $_errorMessages = array() (line 26)

access: protected

mixed $_httpHeaders = array() (line 30)

access: protected

mixed $_httpHeadersSent = false (line 32)

access: protected

mixed $_httpStatusCode = '200' (line 34)

access: protected

mixed $_httpStatusMsg = 'OK' (line 36)

access: protected

string $_type = null (line 24)

ident of the response type

access: protected

Redefined in descendants as:

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

Methods

Constructor __construct (line 41)

constructor

jResponse __construct ()

Redefined in descendants as:

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

acceptSeveralErrors (line 75)

says if the response can embed more than one error message

return: true if many
access: public

boolean acceptSeveralErrors ()

addHttpHeader (line 89)

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 98)

delete all http headers

access: public

void clearHttpHeaders ()

getFormatType (line 69)

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

return: the name
access: public

string getFormatType ()

Redefined in descendants as:

getType (line 63)

return the response type name

return: the name
access: public

string getType ()

hasErrors (line 80)

access: public

void hasErrors ()

output (line 50)

Send the response in the correct format.

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

boolean output ()

Redefined in descendants as:

jResponseJson::output()
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
jResponseCmdline::output() : output the content with the text/plain mime type
jResponseRss20::output() : Generate the content and send it.
jResponseAtom10::output() : Generate the content and send it
jResponseXul::output() : generate the xul content.
jResponseRedirectUrl::output()
jResponseCss::output() : send the css content
jResponseRedirect::output()
jResponseSoap::output()
jResponseXmlRpc::output()
jResponseHtmlFragment::output() : send the Html part
jResponseBinary::output() : send the content or the file to the browser.
jResponseTcpdf::output() : send the PDF to the browser.
jResponseXml::output() : generate the xml content and send it to the browser
jResponseJsonRpc::output()
jResponseLatexToPdf::output() : output the pdf content
jResponseHtml::output() : output the html content
jResponseRdf::output()

outputErrors (line 57)

Send a response with only error messages which appears during the action

(errors, warning, notice, exceptions...). Type and error details depend on the application configuration

abstract:
access: public

void outputErrors ()

Redefined in descendants as:

jResponseJson::outputErrors()
jResponseZip::outputErrors()
jResponseText::outputErrors() : output errors
jResponseCmdline::outputErrors() : output errors
jResponseRss20::outputErrors()
jResponseAtom10::outputErrors()
jResponseXul::outputErrors()
jResponseRedirectUrl::outputErrors()
jResponseCss::outputErrors()
jResponseRedirect::outputErrors()
jResponseSoap::outputErrors()
jResponseXmlRpc::outputErrors()
jResponseHtmlFragment::outputErrors() : output errors
jResponseBinary::outputErrors()
jResponseTcpdf::outputErrors()
jResponseXml::outputErrors() : output errors if any
jResponseJsonRpc::outputErrors()
jResponseLatexToPdf::outputErrors() : output errors
jResponseHtml::outputErrors() : output errors
jResponseRdf::outputErrors()

sendHttpHeaders (line 114)

send http headers

access: protected

void sendHttpHeaders ()

Redefined in descendants as:

jResponseCmdline::sendHttpHeaders() : No Http Header here

setHttpStatus (line 109)

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"..)