Index

$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z

P
	parseAttributes xajax.debug xajax.tools.xml
	parseChildren, xajax.tools.xml
	plugin, xajaxResponse
	pop, xajax.tools.queue
	postHeaders, xajax.config
	preFunction test
	preFunctionTest.php
	prepareDebugText, xajax.debug
	prepareRequest xajax.command.handler xajax.debug
	prepend xajax.dom xajaxResponse
	printHTML, xajaxControl
	printJavascript, xajax
	printJavascriptConfig, xajaxIncludeClientScript
	printJavascriptInclude, xajaxIncludeClientScript
	printOutput, xajaxResponse
	printScript xajaxCustomRequest xajaxRequest
	process xajax.tools.queue xajaxArgumentManager xajaxResponsePlugin
	Process the request or generate the initial page
	processFragment, xajax.tools.xml
	processParameters xajax.command.handler xajax.debug
	processRequest Global examples/helloworld.php examples/xul/xulServer.php xajax xajaxCallableObjectPlugin xajaxEventPlugin xajaxFunctionPlugin xajaxPluginManager xajaxRequestPlugin xajaxScriptPlugin
	push, xajax.tools.queue
	pushFront, xajax.tools.queue
R
	Redefine shortcuts
	redirect, xajaxResponse
	register xajax xajax.command.handler xajaxCallableObjectPlugin xajaxEventPlugin xajaxFunctionPlugin xajaxLanguageManager xajaxPluginManager xajaxRequestPlugin
	Register functions
	registerCallableObject, xajax
	registerEvent, xajax
	registerFunction, xajax
	registerObjectTest.php
	registerPlugin, xajaxPluginManager
	remove xajax.css xajax.dom xajaxResponse
	removeCSS, xajaxResponse
	removeHandler xajax.events xajaxResponse
	removeScript xajax.js xajaxResponse
	replace xajax.dom xajaxResponse
	request xajax.command.handler xajax.debug
	requestURI, xajax.config
	response, xajax
	responseErrorsForAlert, xajax
	responseReceived xajax.command.handler xajax.debug
	responseRedirectCodes, xajax
	responseSuccessCodes, xajax
	retry xajax.debug.xajax.tools.queue xajax.tools.queue
	rewind, xajax.tools.queue

xajax.debug.parseAttributes = xajax.parseAttributes; xajax.parseAttributes = function(
child,
obj
)

Catch any exception thrown during the parsing of response command attributes and display an appropriate debug message.

xajax.tools.xml.parseAttributes = function( child,
obj )

Take the parameters passed in the command of the XML response and convert them to parameters of the args object.

xajax.tools.xml.parseChildren = function( child,
obj )

Parses the child nodes of the command of the response XML.

function &plugin()

Provides access to registered response plugins.

xajax.tools.queue.pop = function( theQ )

Attempt to pop an object off the head of the queue.

xajax.config.setDefault( 'postHeaders',
{} )

An array of header entries where the array key is the header option name and the associated value is the value that will set when the request object is initialized.

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

Example which demonstrates the use of a preFunction.

xajax.debug.prepareDebugText = function( text )

Convert special characters to their HTML equivellents so they will show up in the xajax.debug.window.

xajax.prepareRequest = function( oRequest )

Prepares the XMLHttpRequest object for this xajax request.

xajax.debug.prepareRequest = xajax.prepareRequest; xajax.prepareRequest = function(
oRequest
)

Generate a message indicating that the request is being prepared.

xajax.dom.prepend = function( element,
property,
data )

Prepend the specified value to an element’s attribute.

function prepend( $sTarget,
$sAttribute,
$sData )

Response command to prepend the specified value onto the given element’s property.

function printHTML( $sIndent = '' )

Generates and prints the HTML representation of this control and it’s children.

function printJavascript( $sJsURI = "",
$aJsFiles = array() )

Prints the xajax Javascript header and wrapper code into your page.

function printJavascriptConfig()

See xajaxIncludeClientScriptPlugin::getJavascriptConfig

function printJavascriptInclude()

See xajaxIncludeClientScriptPlugin::getJavascriptInclude

function printOutput()

Prints the output, generated from the commands added to the response, that will be sent to the browser.

function printScript()

Generates a block of javascript code that can be used to invoke the specified xajax request.

xajax.tools.queue.process = function( theQ )

While entries exist in the queue, pull and entry out and process it’s command.

function process()

Returns the array of arguments that were extracted and parsed from the GET or POST data.

function process()

Called by xajaxResponse when a user script requests the service of a response plugin.

xajax.tools.xml.processFragment = function( xmlNode,
seq,
oRet,
oRequest )

xajax.processParameters = function( oRequest )

Processes request specific parameters and generates the temporary variables needed by xajax to initiate and process the request.

xajax.debug.processParameters = xajax.processParameters; xajax.processParameters = function(
oRequest
)

Generate a message indicating that the request object is being populated with the parameters provided.

This will detect an incoming xajax request, process it and exit.

function processRequest()

If this is a xajax request (see <xajax->canProcessRequest>), call the requested PHP function, build the response and send it back to the browser.

function processRequest()

Called by the xajaxPluginManager when a request needs to be processed.

function processRequest()

Calls each of the request plugins to request that they process the current request.

function processRequest()

Called by the xajaxPluginManager when a request is being processed.

function processRequest()

Called by the xajaxPluginManager when the current request should be processed.

xajax.tools.queue.push = function( theQ,
obj )

Push a new object into the tail of the buffer maintained by the specified queue object.

xajax.tools.queue.pushFront = function( theQ,
obj )

Push a new object into the head of the buffer maintained by the specified queue object.

function redirect( $sURL,
$iDelay = )

Response command that causes the browser to navigate to the specified URL.

function register( $sType,
$mArg )

Call this function to register request handlers, including functions, callable objects and events.

xajax.command.handler.register = function( shortName,
func )

Registers a new command handler.

function register( $aArgs )

Provides a mechanism for functions to be registered and made available to the page via the javascript xajax.request call.

function register( $sLanguage,
$aMessages )

Called to register an array of alternate language messages.

function register( $aArgs )

Call each of the request plugins and give them the opportunity to handle the registration of the specified function, event or callable object.

function register( $aArgs )

Called by the xajaxPluginManager when a user script when a function, event or callable object is to be registered.

function registerCallableObject( & $oObject )

Registers an object whose methods will be searched for a match to the incoming request.

Assigns a callback function with the specified xajax event.

function registerFunction( $mFunction,
$sIncludeFile = null )

Registers a PHP function or method with the xajax request processor.

Script to test callable objects.

function registerPlugin( & $objPlugin,
$nPriority = 1000 )

Registers a plugin.

xajax.css.remove = function( fileName,
media )

Locate and remove a LINK reference from the current document’s HEAD.

xajax.dom.remove = function( element )

Delete an element.

function remove( $sTarget )

Response command used to remove an element from the document.

function removeCSS( $sFileName,
$sMedia = null )

Response command used to remove a LINK reference to a CSS file on the browser.

xajax.events.removeHandler = function( element,
sEvent,
fun )

Remove an event handler from an element.

function removeHandler( $sTarget,
$sEvent,
$sHandler )

Response command used to remove an event handler from an element.

xajax.js.removeScript = function( command )

Locates a SCRIPT tag in the HEAD of the document which references the specified file and removes it.

function removeScript( $sFileName,
$sUnload = '' )

Response command used to remove a SCRIPT reference to a javascript file on the browser.

xajax.dom.replace = function( element,
sAttribute,
aData )

Search and replace the specified text.

function replace( $sTarget,
$sAttribute,
$sSearch,
$sData )

Replace a specified value with another value within the given element’s property.

xajax.request = function()

xajax.debug.request = xajax.request; xajax.request = function()

Validates that a function name was provided, generates a message indicating that a xajax request is starting and sets a flag in the request object indicating that debugging is enabled for this request.

xajax.config.setDefault( 'requestURI',
xajax.config.baseDocument.URL )

The URI that requests will be sent to.

xajax.response

The response queue that holds response commands, once received from the server, until they are processed.

xajax.responseErrorsForAlert

This array contains a list of status codes returned by the server to indicate that the request failed for some reason.

xajax.responseReceived = function( oRequest )

Process the response.

xajax.debug.responseReceived = xajax.responseReceived; xajax.responseReceived = function(
oRequest
)

Generate a message indicating that a response has been received from the server; provide some statistical data regarding the response and the response time.

xajax.responseRedirectCodes

An array of status codes returned from the server to indicate a request for redirect to another URL.

xajax.responseSuccessCodes

This array contains a list of codes which will be returned from the server upon successful completion of the server portion of the request.

xajax.tools.queue.retry = function( obj,
count )

Maintains a retry counter for the given object.

xajax.tools.queue.rewind = function( theQ )

Rewind the buffer head pointer, effectively reinserting the last retrieved object into the buffer.