Xajax_core xajaxRequest. inc.php |
xajaxRequest. inc.phpContains the xajaxRequest class Summary
xajaxRequest classPlease see copyright.inc.php for a detailed description, copyright and license information. Summary
xajaxRequestUsed to store and generate the client script necessary to invoke a xajax request from the browser to the server script. This object is typically generated by the xajax->register method and can be used to quickly generate the javascript that is used to initiate a xajax request to the registered function, object, event or other xajax call. Summary
sQuoteCharacter
A string containing either a single or a double quote character that will be used during the generation of the javascript for this function. This can be set prior to calling xajaxRequest->printScript aParameters
An array of parameters that will be used to populate the argument list for this function when the javascript is output in xajaxRequest->printScript addParameter
Adds a parameter value to the parameter list for this request.
See xajaxRequest->setParameter for details. setParameter
Sets a specific parameter value.
Types should be one of the following XAJAX_FORM_VALUES, XAJAX_QUOTED_VALUE, XAJAX_JS_VALUE, XAJAX_INPUT_VALUE, XAJAX_CHECKED_VALUE. The value should be as follows: XAJAX_FORM_VALUES - Use the ID of the form you want to process. XAJAX_QUOTED_VALUE - The string data to be passed. XAJAX_JS_VALUE - A string containing valid javascript (either a javascript variable name that will be in scope at the time of the call or a javascript function call whose return value will become the parameter. TODO: finish documenting the options. getScript
Returns a string representation of the script output (javascript) from this request object. See also: xajaxRequest::printScript xajaxCustomRequestThis class extends the xajaxRequest class such that simple javascript can be put in place of a xajax request to the server. The primary purpose of this class is to provide simple scripting services to the xajaxControl based objects, like <clsInput>, clsTable and <clsButton>. Summary
xajaxCustomRequest
Constructs and initializes an instance of the object.
setVariable
Sets a value that will be used to modify the script before it is sent to the browser. The xajaxCustomRequest object will perform a string replace operation on each of the values set with this function. |
The name of the function.
var $sName
A string containing either a single or a double quote character that will be used during the generation of the javascript for this function.
var $sQuoteCharacter
An array of parameters that will be used to populate the argument list for this function when the javascript is output in xajaxRequest->printScript
var $aParameters
Generates a block of javascript code that can be used to invoke the specified xajax request.
function printScript()
Construct and initialize this request.
function xajaxRequest( $sName )
Call this to instruct the request to use single quotes when generating the javascript.
function useSingleQuote()
Call this to instruct the request to use double quotes while generating the javascript.
function useDoubleQuote()
Clears the parameter list associated with this request.
function clearParameters()
Adds a parameter value to the parameter list for this request.
function addParameter()
Sets a specific parameter value.
function setParameter()
Returns a string representation of the script output (javascript) from this request object.
function getScript()
Constructs and initializes an instance of the object.
function xajaxCustomRequest( $sScript )
Clears the array of variables that will be used to modify the script before it is printed and sent to the client.
function clearVariables()
Sets a value that will be used to modify the script before it is sent to the browser.
function setVariable( $sName, $sValue )
function printScript()
Call this function to register request handlers, including functions, callable objects and events.
function register( $sType, $mArg )