Function Index

Functions

Function 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

H
	hasMethod, xajaxCallableObject
	helloWorld
	hook, xajax. debug. verbose
I
	includeCSS, xajaxResponse
	includeOnce, xajax.js
	includeScript xajax.js xajaxResponse
	includeScriptOnce, xajaxResponse
	initializeRequest xajax xajax. debug
	insert xajax.dom xajaxResponse
	insertAfter xajax.dom xajaxResponse
	insertInput xajax. forms xajaxResponse
	insertInputAfter xajax. forms xajaxResponse
	isClass, xajaxCallableObject
L
	loadCommands, xajaxResponse
	loadPlugins, xajaxPluginManager
M
	makeFunction, xajax. debug. verbose
	makeWrapper, xajax.js
P
	parseAttributes xajax xajax. debug
	parseChildren, xajax
	plugin, xajaxResponse
	pop, xajax. tools. queue
	prepareDebugText, xajax. debug
	prepareRequest xajax 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
	processParameters xajax xajax. debug
	processRequest xajax xajaxCallableObjectPlugin xajaxEventPlugin xajaxFunctionPlugin xajaxPluginManager xajaxRequestPlugin xajaxScriptPlugin
	push, xajax. tools. queue
	pushFront, xajax. tools. queue
R
	redirect, xajaxResponse
	register xajax xajaxCallableObjectPlugin xajaxEventPlugin xajaxFunctionPlugin xajaxLanguageManager xajaxPluginManager xajaxRequestPlugin
	registerCallableObject, xajax
	registerEvent, xajax
	registerFunction, xajax
	registerPlugin, xajaxPluginManager
	remove xajax.css xajax.dom xajaxResponse
	removeCSS, xajaxResponse
	removeHandler xajax. events xajaxResponse
	removeScript xajax.js xajaxResponse
	replace xajax.dom xajaxResponse
	request xajax xajax. debug
	responseReceived xajax xajax. debug
	retry xajax. debug. xajax. tools. queue xajax. tools. queue
	rewind, xajax. tools. queue

function hasMethod( $sMethod )

Determines if the specified method name is one of the methods of the object referenced by xajaxCallableObject->obj.

function helloWorld( $isCaps )

Modify the innerHTML of div1.

xajax.debug.verbose.hook = function( x,
base )

Generate a wrapper function around each of the functions contained within the specified object.

function includeCSS( $sFileName )

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

Add a reference to the specified script file if one does not already exist in the HEAD of the current document.

xajax.js.includeScript = function( fileName )

Adds a SCRIPT tag referencing the specified file.

function includeScript( $sFileName )

Response command used to load a javascript file on the browser.

function includeScriptOnce( $sFileName )

Response command used to include a javascript file on the browser if it has not already been loaded.

xajax.initializeRequest = function( oRequest )

Initialize a request object, populating default settings, where call specific settings are not already provided.

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

Generate a message indicating that the request object is being initialized.

xajax.dom.insert = function( objSibling,
sTag,
sId )

Insert a new element before the specified element.

function insert( $sBefore,
$sTag,
$sId )

Response command used to insert a new element just prior to the specified element.

xajax.dom.insertAfter = function( objSibling,
sTag,
sId )

Insert a new element after the specified element.

function insertAfter( $sAfter,
$sTag,
$sId )

Response command used to insert a new element after the specified one.

xajax.forms.insertInput = function( objSibling,
sType,
sName,
sId )

Insert a new input element before the specified element.

function insertInput( $sBefore,
$sType,
$sName,
$sId )

Response command used to insert a new input element preceeding the specified element.

xajax.forms.insertInputAfter = function( objSibling,
sType,
sName,
sId )

Insert a new input element after the specified element.

function insertInputAfter( $sAfter,
$sType,
$sName,
$sId )

Response command used to insert a new input element after the specified element.

function isClass( $sClass )

Determins if the specified class name matches the class name of the object referenced by xajaxCallableObject->obj.

function loadCommands( $mCommands,
$bBefore = false )

Merges the response commands from the specified xajaxResponse object with the response commands in this xajaxResponse object.

function loadPlugins( $aFolders )

Loads plugins from the folders specified.

xajax.debug.verbose.makeFunction = function( obj,
name )

Generate a wrapper function around the specified function.

xajax.js.makeWrapper = function( origFun,
args,
codeBlocks,
returnVariable,
context )

Helper function used in the wrapping of an existing javascript function.

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

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.

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.

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

Registers a plugin.

xajax.css.remove = function( filename )

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 )

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

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( fileName,
unload )

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