xajax.inc.php

function xajax( $sRequestURI  =  null, $sLanguage  =  null )

Constructs a xajax instance and initializes the plugin system.

function __sleep()

function __wakeup()

function &getGlobalResponse()

Returns the xajaxResponse object preconfigured with the encoding and entity settings from this instance of xajax.  This is used for singleton-pattern response development.

Returns

function getVersion()

Returns

function register( $sType, $mArg )

Call this function to register request handlers, including functions, callable objects and events.  New plugins can be added that support additional registration methods and request processors.

$sIncludeFile || $aCallOptions || $sEventHandler when registering a function, this is the (optional) include file. when registering a callable object, this is an (optional) array of call options for the functions being registered. when registering an event handler, this is the name of the function.

function configure( $sName, $mValue )

Call this function to set options that will effect the processing of xajax requests.  Configuration settings can be specific to the xajax core, request processor plugins and response plugins.

Options include

function configureMany( $aOptions )

Set an array of configuration options.

function getConfiguration( $sName )

Get the current value of a configuration setting that was previously set via xajax->configure or xajax->configureMany

Returns

function canProcessRequest()

Determines if a call is a xajax request or a page load request.

Return

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.

This is the main server side engine for xajax.  It handles all the incoming requests, including the firing of events and handling of the response.  If your RequestURI is the same as your web page, then this function should be called before ANY headers or HTML is output from your script.

This function may exit, if a request is processed.  See <xajax->bAllowExit>

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

Prints the xajax Javascript header and wrapper code into your page.  This should be used to print the javascript code between the HEAD and /HEAD tags at the top of the page.

The javascript code output by this function is dependent on the plugins that are included and the functions that are registered.

function getJavascript( $sJsURI  =  '', $aJsFiles  =  array() )

See xajax->printJavascript for more information.

function autoCompressJavascript( $sJsFullFilename  =  NULL, $bAlways  =  false )

Creates a new xajax_core, xajax_debug, etc... file out of the _uncompressed file with a similar name.  This strips out the comments and extraneous whitespace so the file is as small as possible without modifying the function of the code.

function _detectURI()

Returns the current requests URL based upon the SERVER vars.

Returns

function setCharEncoding( $sEncoding )

Sets the character encoding that will be used for the HTTP output.  Typically, you will not need to use this method since the default character encoding can be configured using the constant XAJAX_DEFAULT_CHAR_ENCODING.

• examples include (UTF-8, ISO-8859-1)

function getCharEncoding()

Returns the current character encoding.  See also xajax->setCharEncoding and XAJAX_DEFAULT_CHAR_ENCODING

Returns

function setFlags( $flags )

Sets a series of flags.  See also, xajax->setFlag.

function setFlag( $name, $value )

Sets a single flag (boolean true or false).

Available flags are as follows (flag, default value)

• debug, false
• verbose, false
• statusMessages, false
• waitCursor, true
• scriptDeferral, false
• exitAllowed, true
• errorHandler, false
• cleanBuffer, false
• decodeUTF8Input, false
• outputEntities, false
• allowBlankResponse, false
• allowAllResponseTypes, false
• generateStubs, true

function getFlag( $name )

Returns the current value of the flag.  See also xajax->setFlag.

Returns

function setRequestURI( $sRequestURI )

Sets the URI to which requests will be sent.

Note: Usage

$xajax->setRequestURI(“http://www.xajaxproject.org”);

function getRequestURI()

Returns

function setDefaultMode( $sDefaultMode )

Sets the default mode for requests from the browser.

• ’synchronous’
• ’asynchronous’

Example

$xajax->setDefaultMode(“synchronous”);

function getDefaultMode()

Get the default request mode that will be used by the browser for submitting requests to the server.  See also xajax->setDefaultMode

Returns

function setDefaultMethod( $sMethod )

Sets the default method for making xajax requests

• ’GET’
• ’POST’

function getDefaultMethod()

Gets the default method for making xajax requests.

Returns

function setWrapperPrefix( $sPrefix )

Sets the prefix that will be prepended to the javascript wrapper functions.  This allows a little flexibility in setting the naming for the wrapper functions.

• default is ‘xajax_’

function getWrapperPrefix()

Gets the current javascript wrapper prefix.  See also, xajax->setWrapperPrefix

Returns

function setLogFile( $sFilename )

Specifies a log file that will be written to by xajax during a request.  This is only used by the error handling system at this point.  If you do not invoke this method or you pass in an empty string, then no log file will be written to.

function getLogFile()

Returns the current log file path.  See also xajax->setLogFile.

Returns

function registerFunction( $mFunction,    $sIncludeFile  =  null )

Registers a PHP function or method with the xajax request processor.  This makes the function available to the browser via an asynchronous (or synchronous) javascript call.

• (string) The function name as it will be called from javascript.
• (object, by reference) A reference to an instance of a class containing the specified function.
• (string) The function as it is found in the class passed in the second parameter.

Examples

• $xajax->registerFunction(“myFunction”);
• $xajax->registerFunction(array(“myFunctionName”, &$myObject, “myMethod”));

function registerCallableObject( & $oObject )

Registers an object whose methods will be searched for a match to the incoming request.  If more than one callable object is registered, the first on that contains the requested method will be used.

Assigns a callback function with the specified xajax event.  Events are triggered during the processing of a request.