xajax
[ class tree: xajax ] [ index: xajax ] [ all elements ]

Class: legacyXajax

Source Location: /pem-includes/xajax/xajax_core/legacy.inc.php

Class Overview

xajax
   |
   --legacyXajax

The xajax class uses a modular plug-in system to facilitate the processing


Methods


Inherited Variables

Inherited Methods

Class: xajax

xajax::xajax()
Sets up the xajax object and the plugin system
xajax::autoCompressJavascript()
This method can be used to create a new xajax.js file out of the xajax_uncompressed.js file (which will only happen if xajax.js doesn't already exist on the filesystem).
xajax::canProcessRequest()
Returns true if xajax can process the request, false if otherwise.
xajax::getCharEncoding()
Returns the character encoding for the HTTP output
xajax::getFlag()
Returns the value of the flag
xajax::getGlobalResponse()
Returns an xajaxResponse object set up with this xajax object's encoding and entity settings. Use this for singleton-pattern response development.
xajax::getJavascript()
Returns the xajax Javascript code that should be added to your HTML page between the <head> </head> tags. (executes Javascript include plugin)
xajax::getJavascriptConfig()
Returns a string containing inline Javascript that sets up the xajax runtime (typically called internally by xajax from get/printJavascript).
xajax::getJavascriptInclude()
Returns a string containing a Javascript include of the xajax.js file along with a check to see if the file loaded after six seconds (typically called internally by xajax from get/printJavascript).
xajax::getLogFile()
Returns the log file to use for error output (or "" if no log file is to be used)
xajax::getRegisteredCallableObjects()
Returns an associative array of callable objects
xajax::getRegisteredEvents()
Returns an associative array of event definitions
xajax::getRegisteredFunctions()
Returns an associative array of registered function definitions
xajax::getRequestMode()
Returns the current request mode (XAJAX_GET or XAJAX_POST), or -1 if there is none. (executes request processor plugin)
xajax::getRequestURI()
Returns the current request URI
xajax::getTimeout()
Returns the xajax Javascript timeout
xajax::getVersion()
Returns the current xajax version.
xajax::getWrapperPrefix()
Returns the Javascript wrapper prefix
xajax::printJavascript()
Prints the xajax Javascript header and wrapper code into your page by printing the output of the getJavascript() method. It should only be called between the
 
tags in your HTML page.
xajax::processRequest()
This is the main communications engine of xajax. The engine handles all
xajax::registerCallableObject()
Registers an object whose methods will be searched for a match to the incoming request function name. If more than one callable object is registered, the first object that contains a method having the same name as the incoming function will be called.
xajax::registerEvent()
Registers a callback with an xajax event. Available events are:
xajax::registerFunction()
Registers a PHP function or method to be callable through xajax in your
xajax::setCharEncoding()
Sets the character encoding for the HTTP output based on
xajax::setFlag()
Sets a flag (boolean true or false). Available flags with their defaults are as follows:
xajax::setFlags()
Sets multiple flags based on the supplied associative array (see xajax::setFlag() for flag names)
xajax::setLogFile()
Specifies a log file that will be written to by xajax during a request (used only by the error handling system at present). If you don't invoke this method, or you pass in "", then no log file will be written to.
xajax::setRequestURI()
Sets the URI to which requests will be made.
xajax::setTimeout()
Sets the timeout before xajax notifies the client that xajax has not been loaded Usage: $xajax->setTimeout(6000);
xajax::setWrapperPrefix()
Sets the prefix that will be appended to the Javascript wrapper functions (default is "xajax_").

Class Details

[line 29]
The xajax class uses a modular plug-in system to facilitate the processing

of special Ajax requests made by a PHP page. It generates Javascript that the page must include in order to make requests, and it handles the output of response objects (see xajaxResponse). Many different flags and settings can be adjusted to alter the behavior of the xajax class as well as the client-side Javascript.




[ Top ]


Class Methods


constructor legacyXajax [line 30]

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



Parameters:

   $sRequestURI  
   $sWrapperPrefix  
   $sEncoding  
   $bDebug  

[ Top ]

method allowBlankResponseOff [line 71]

void allowBlankResponseOff( )



[ Top ]

method allowBlankResponseOn [line 70]

void allowBlankResponseOn( )



[ Top ]

method canProcessRequests [line 51]

void canProcessRequests( )



[ Top ]

method cleanBufferOff [line 65]

void cleanBufferOff( )



[ Top ]

method cleanBufferOn [line 64]

void cleanBufferOn( )



[ Top ]

method debugOff [line 55]

void debugOff( )



[ Top ]

method debugOn [line 54]

void debugOn( )



[ Top ]

method decodeUTF8InputOff [line 67]

void decodeUTF8InputOff( )



[ Top ]

method decodeUTF8InputOn [line 66]

void decodeUTF8InputOn( )



[ Top ]

method errorHandlerOff [line 63]

void errorHandlerOff( )



[ Top ]

method errorHandlerOn [line 62]

void errorHandlerOn( )



[ Top ]

method exitAllowedOff [line 61]

void exitAllowedOff( )



[ Top ]

method exitAllowedOn [line 60]

void exitAllowedOn( )



[ Top ]

method outputEntitiesOff [line 69]

void outputEntitiesOff( )



[ Top ]

method outputEntitiesOn [line 68]

void outputEntitiesOn( )



[ Top ]

method processRequests [line 52]

void processRequests( )



[ Top ]

method registerCatchAllFunction [line 41]

void registerCatchAllFunction( $mFunction)



Parameters:

   $mFunction  

[ Top ]

method registerExternalFunction [line 37]

void registerExternalFunction( $mFunction, $sFunctionName)



Parameters:

   $mFunction  
   $sFunctionName  

[ Top ]

method registerPreFunction [line 46]

void registerPreFunction( $mFunction)



Parameters:

   $mFunction  

[ Top ]

method setCallableObject [line 53]

void setCallableObject( &$oObject)



Parameters:

   &$oObject  

[ Top ]

method statusMessagesOff [line 57]

void statusMessagesOff( )



[ Top ]

method statusMessagesOn [line 56]

void statusMessagesOn( )



[ Top ]

method waitCursorOff [line 59]

void waitCursorOff( )



[ Top ]

method waitCursorOn [line 58]

void waitCursorOn( )



[ Top ]


Documentation generated on Tue, 21 Aug 2007 14:49:44 -0500 by phpDocumentor 1.4.0a2