xajaxResponseManager. inc.php

Contains the xajaxResponseManager class

Summary
Contains the xajaxResponseManager class
Please see copyright.inc.php for a detailed description, copyright and license information.
This class stores and tracks the response that will be returned after processing a request.
The current response object that will be sent back to the browser once the request processing phase is complete.
Construct and initialize the one and only xajaxResponseManager object.
Implementation of the singleton pattern: provide a single instance of the xajaxResponseManager to all who request it.
Called by the xajax object when configuration options are set in the main script.
Clear the current response.
Used, primarily internally, to append one response object onto the end of another.
Appends a debug message on the end of the debug message queue.
Prints the response object to the output stream, thus sending the response to the client.
Called automatically by new response objects as they are constructed to obtain the current character encoding setting.
Called automatically by new response objects as they are constructed to obtain the current output entities setting.

xajaxResponseManager class

Please see copyright.inc.php for a detailed description, copyright and license information.

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.

Summary
The current response object that will be sent back to the browser once the request processing phase is complete.
Construct and initialize the one and only xajaxResponseManager object.
Implementation of the singleton pattern: provide a single instance of the xajaxResponseManager to all who request it.
Called by the xajax object when configuration options are set in the main script.
Clear the current response.
Used, primarily internally, to append one response object onto the end of another.
Appends a debug message on the end of the debug message queue.
Prints the response object to the output stream, thus sending the response to the client.
Called automatically by new response objects as they are constructed to obtain the current character encoding setting.
Called automatically by new response objects as they are constructed to obtain the current output entities setting.

Variables

objResponse

var $objResponse

The current response object that will be sent back to the browser once the request processing phase is complete.

sCharacterEncoding

var $sCharacterEncoding

bOutputEntities

var $bOutputEntities

aDebugMessages

var $aDebugMessages

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 xajaxResponseManager 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 xajaxResponseManager 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.

$mResponse(object): The new response object to be added to the current response object.

If no prior response has been appended, this response becomes the main response object to which other response objects will be appended.

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: xajaxResponse)

$sMessage(string): The text of the debug message to be sent.

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 xajaxResponseManager will automatically notify the current response object since it would have been constructed prior to the setting change, see xajaxResponseManager::configure.

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 xajaxResponseManager will automatically notify the current response object since it would have been constructed prior to the setting change, see xajaxResponseManager::configure.

This file contains detailed information regarding the xajax project, current version, copyrights, licnese and documentation.
var $objResponse
The current response object that will be sent back to the browser once the request processing phase is complete.
var $sCharacterEncoding
var $bOutputEntities
var $aDebugMessages
function xajaxResponseManager()
Construct and initialize the one and only xajaxResponseManager object.
function &getInstance()
Implementation of the singleton pattern: provide a single instance of the xajaxResponseManager to all who request it.
function configure($sName,
$mValue)
Called by the xajax object when configuration options are set in the main script.
function clear()
Clear the current response.
function append($mResponse)
Used, primarily internally, to append one response object onto the end of another.
function debug($sMessage)
Appends a debug message on the end of the debug message queue.
function send()
Prints the response object to the output stream, thus sending the response to the client.
function getCharacterEncoding()
Called automatically by new response objects as they are constructed to obtain the current character encoding setting.
function getOutputEntities()
Called automatically by new response objects as they are constructed to obtain the current output entities setting.
Collect commands to be sent back to the browser in response to a xajax request.