PHP Class xajax

__construct() public method

Constructs a xajax instance and initializes the plugin system. Parameters: sRequestURI - (optional): The sRequestURI> to be used for calls back to the server. If empty, xajax fills in the current URI that initiated this request.

public __construct ( $sRequestURI = null, $sLanguage = null )

__sleep() public method

* Function: __sleep

public __sleep ( )

__wakeup() public method

* Function: __wakeup

public __wakeup ( )

_compile() public method

public _compile ( $sFolder = null, $bWriteFile = true )

autoCompressJavascript() public method

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. Parameters: sJsFullFilename - (string): The relative path and name of the file to be compressed. bAlways - (boolean): Compress the file, even if it already exists.

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

canProcessRequest() public method

Determines if a call is a xajax request or a page load request. Return: boolean - True if this is a xajax request, false otherwise.

public canProcessRequest ( )

challenge() public method

Call this from the top of a xajax enabled request handler to introduce a challenge and response cycle into the request response process. NOTE: Sessions must be enabled to use this feature.

public challenge ( $algo = null, $value = null )

configure() public method

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. Parameters: Options include: javascript URI - (string): The path to the folder that contains the xajax javascript files. errorHandler - (boolean): true to enable the xajax error handler, see bErrorHandler> exitAllowed - (boolean): true to allow xajax to exit after processing a request. See bExitAllowed> for more information.

public configure ( $sName, $mValue )

configureMany() public method

Set an array of configuration options. Parameters: $aOptions - (array): Associative array of configuration settings

public configureMany ( $aOptions )

getConfiguration() public method

Get the current value of a configuration setting that was previously set via configure> or configureMany> Parameters: $sName - (string): The name of the configuration setting Returns: $mValue : (mixed): The value of the setting if set, null otherwise.

public getConfiguration ( $sName )

getGlobalResponse() public static method

Returns the object preconfigured with the encoding and entity settings from this instance of . This is used for singleton-pattern response development. Returns: : A object which can be used to return response commands. See also the class.

public static getGlobalResponse ( )

getJavascript() public method

See printJavascript> for more information.

public getJavascript ( )

getVersion() public static method

Returns: string : The current xajax version.

public static getVersion ( )

printJavascript() public method

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.

public printJavascript ( )

processRequest() public method

If this is a xajax request (see 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 bAllowExit>

public processRequest ( )

register() public method

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. Parameters: $sType - (string): Type of request handler being registered; standard options include: XAJAX_FUNCTION: a function declared at global scope. XAJAX_CALLABLE_OBJECT: an object who's methods are to be registered. XAJAX_EVENT: an event which will cause zero or more event handlers to be called. XAJAX_EVENT_HANDLER: register an event handler function. $sFunction || $objObject || $sEvent - (mixed): when registering a function, this is the name of the function when registering a callable object, this is the object being registered when registering an event or event handler, this is the name of the event $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.

public register ( $sType, $mArg )