Docs For Class xajax

Description

The xajax class generates the xajax javascript for your page including the javascript wrappers for the PHP functions that you want to call from your page.

It also handles processing and executing the command messages in the xml responses sent back to your page from your PHP functions.

author: XAJAX
version: $Revision: 1.0.0 $

Located in /api/class.xajax.inc.php (line 42)

Variable Summary

mixed $aFunctionIncludeFiles

mixed $aFunctionRequestTypes

mixed $aFunctions

mixed $aObjArray

mixed $aObjects

mixed $bCleanBuffer

mixed $bDebug

mixed $bDecodeUTF8Input

mixed $bErrorHandler

mixed $bExitAllowed

mixed $bStatusMessages

mixed $bWaitCursor

mixed $iPos

mixed $sCatchAllFunction

mixed $sEncoding

mixed $sLogFile

mixed $sPreFunction

mixed $sRequestURI

mixed $sWrapperPrefix

Method Summary

xajax xajax ([ $sRequestURI = ""], [ $sWrapperPrefix = "xajax_"], [ $sEncoding = XAJAX_DEFAULT_CHAR_ENCODING], [ $bDebug = false])

void autoCompressJavascript ([ $sJsFullFilename = NULL])

void canProcessRequests ()

void cleanBufferOff ()

void cleanBufferOn ()

void debugOff ()

void debugOn ()

void decodeUTF8InputOff ()

void decodeUTF8InputOn ()

void errorHandlerOff ()

void errorHandlerOn ()

void exitAllowedOff ()

void exitAllowedOn ()

void getJavascript ([ $sJsURI = ""], [ $sJsFile = NULL])

void getJavascriptConfig ()

void getJavascriptInclude ([ $sJsURI = ""], [ $sJsFile = NULL])

void getRequestMode ()

void printJavascript ([ $sJsURI = ""], [ $sJsFile = NULL])

void processRequests ()

void registerCatchAllFunction ( $mFunction)

void registerExternalFunction ( $mFunction, $sIncludeFile, [ $sRequestType = XAJAX_POST])

void registerFunction ( $mFunction, [ $sRequestType = XAJAX_POST])

void registerPreFunction ( $mFunction)

void setCharEncoding ( $sEncoding)

void setLogFile ( $sFilename)

void setRequestURI ( $sRequestURI)

void setWrapperPrefix ( $sPrefix)

void statusMessagesOff ()

void statusMessagesOn ()

void waitCursorOff ()

void waitCursorOn ()

Variables

mixed $aFunctionIncludeFiles (line 47)

mixed $aFunctionRequestTypes (line 46)

mixed $aFunctions (line 44)

mixed $aObjArray (line 60)

mixed $aObjects (line 45)

mixed $bCleanBuffer (line 58)

mixed $bDebug (line 51)

mixed $bDecodeUTF8Input (line 59)

mixed $bErrorHandler (line 53)

mixed $bExitAllowed (line 52)

mixed $bStatusMessages (line 56)

mixed $bWaitCursor (line 57)

mixed $iPos (line 61)

mixed $sCatchAllFunction (line 48)

mixed $sEncoding (line 62)

mixed $sLogFile (line 54)

mixed $sPreFunction (line 49)

mixed $sRequestURI (line 50)

mixed $sWrapperPrefix (line 55)

Methods

Constructor xajax (line 70)

xajax xajax ([ $sRequestURI = ""], [ $sWrapperPrefix = "xajax_"], [ $sEncoding = XAJAX_DEFAULT_CHAR_ENCODING], [ $bDebug = false])

$sRequestURI
$sWrapperPrefix
$sEncoding
$bDebug

autoCompressJavascript (line 527)

void autoCompressJavascript ([ $sJsFullFilename = NULL])

$sJsFullFilename

canProcessRequests (line 266)

void canProcessRequests ()

cleanBufferOff (line 175)

void cleanBufferOff ()

cleanBufferOn (line 170)

void cleanBufferOn ()

debugOff (line 103)

void debugOff ()

debugOn (line 97)

void debugOn ()

decodeUTF8InputOff (line 187)

void decodeUTF8InputOff ()

decodeUTF8InputOn (line 181)

void decodeUTF8InputOn ()

errorHandlerOff (line 154)

void errorHandlerOff ()

errorHandlerOn (line 149)

void errorHandlerOn ()

exitAllowedOff (line 141)

void exitAllowedOff ()

exitAllowedOn (line 134)

void exitAllowedOn ()

getJavascript (line 478)

void getJavascript ([ $sJsURI = ""], [ $sJsFile = NULL])

$sJsURI
$sJsFile

getJavascriptConfig (line 488)

void getJavascriptConfig ()

getJavascriptInclude (line 509)

void getJavascriptInclude ([ $sJsURI = ""], [ $sJsFile = NULL])

$sJsURI
$sJsFile

getRequestMode (line 273)

void getRequestMode ()

printJavascript (line 471)

void printJavascript ([ $sJsURI = ""], [ $sJsFile = NULL])

$sJsURI
$sJsFile

processRequests (line 290)

void processRequests ()

registerCatchAllFunction (line 240)

void registerCatchAllFunction ( $mFunction)

$mFunction

registerExternalFunction (line 226)

void registerExternalFunction ( $mFunction, $sIncludeFile, [ $sRequestType = XAJAX_POST])

$mFunction
$sIncludeFile
$sRequestType

registerFunction (line 211)

void registerFunction ( $mFunction, [ $sRequestType = XAJAX_POST])

$mFunction
$sRequestType

registerPreFunction (line 253)

void registerPreFunction ( $mFunction)

$mFunction

setCharEncoding (line 203)

void setCharEncoding ( $sEncoding)

$sEncoding

setLogFile (line 163)

void setLogFile ( $sFilename)

$sFilename

setRequestURI (line 91)

void setRequestURI ( $sRequestURI)

$sRequestURI

setWrapperPrefix (line 194)

void setWrapperPrefix ( $sPrefix)

$sPrefix

statusMessagesOff (line 115)

void statusMessagesOff ()

statusMessagesOn (line 109)

void statusMessagesOn ()

waitCursorOff (line 127)

void waitCursorOff ()

waitCursorOn (line 121)

void waitCursorOn ()