API DOCS

DOCS & TUTORIALS » API DOCS » xajax_core » xajaxResponseManager.inc.php » xajaxResponseManager

Class: xajaxResponseManager



This class stores and tracks the response that will be returned after
processing a request. The response manager represents a single point
of contact for working with <xajaxResponse> objects as well as
<xajaxCustomResponse> objects.

variables

functions

xajaxResponseManager

function xajaxResponseManager()

Construct and initialize the one and only xajaxResponseManager object.

getInstance

function &getInstance()

Implementation of the singleton pattern: provide a single instance of the
to all who request it.

configure

function configure($sName, $mValue)

Called by the xajax object when configuration options are set in the main script. Option
values are passed to each of the main xajax components and stored locally as needed. The
will track the characterEncoding and outputEntities settings.


clear

function clear()

Clear the current response. A new response will need to be appended
before the request processing is complete.

append

function append($mResponse)

Used, primarily internally, to append one response object onto the end of another. You can
append one xajaxResponse to the end of another, or append a xajaxCustomResponse onto the end of
another xajaxCustomResponse. However, you cannot append a standard response object onto the end
of a custom response and likewise, you cannot append a custom response onto the end of a standard
response.


debug

function debug($sMessage)

Appends a debug message on the end of the debug message queue. Debug messages
will be sent to the client with the normal response (if the response object supports
the sending of debug messages, see: )


send

function send()

Prints the response object to the output stream, thus sending the response to the client.

getCharacterEncoding

function getCharacterEncoding()

Called automatically by new response objects as they are constructed to obtain the
current character encoding setting. As the character encoding is changed, the
will automatically notify the current response object since it would have been constructed
prior to the setting change, see .

getOutputEntities

function getOutputEntities()

Called automatically by new response objects as they are constructed to obtain the
current output entities setting. As the output entities setting is changed, the
will automatically notify the current response object since it would
have been constructed prior to the setting change, see .

 



XAJAX on SourceForge.net
Support this project Valid XHTML 1.0 Transitional