Xajax_core xajaxCall. inc.php |
xajaxCall. inc.phpContains the xajaxCall class Summary
xajaxCall classPlease see copyright.inc.php for a detailed description, copyright and license information. xajaxCallCreate a piece of javascript code that will invoke the xajax.call function. This class is deprecated and will be removed in future versions; please use xajaxRequest instead. Summary
sReturnValue
Required: The value to return once the xajax.call has returned. (for asynchronous calls, this is immediate) setFunction
Override the function name set in the constructor. Returns
clearParameters
Clear the list of parameters being accumulated for this call. Returns
addParameter
Adds a parameter to the list that will be specified for the request generated by this xajaxCall object.
If you specify the name of a javascript variable, or provide a javascript function call as a parameter, do not use quotes around the value. Returns
addFormValuesParameter
Add a parameter value that is the result of calling xajax.getFormValues for the specified form.
Returns
setMode
Sets the mode that will be specified for this xajax.call
Returns
setRequestType
Sets the request type which will be specified for the generated xajax.call.
Returns
setResponseProcessor
Sets the name of the javascript function that will be used to process this response. This is an advanced function, use with caution. Returns
setRequestURI
Override the default URI with the specified one.
Returns
setContentType
Sets the content type that will be used by the generated request. Returns
setReturnValue
Sets the value that will be returned after the generated call. Set to an empty string if no return value is desired. Returns
generate
Construct a xajax.call statement in javascript that can be used to make a xajax request with the parameters and settings previously configured for this xajaxCall object. The output from this function can be used as an event handler in your javascript code. Returns
|
Initiates a call to the server.
xajax.call = function()
Required: The name of the xajax enabled function to call
var $sFunction
Required: The value to return once the xajax.call has returned.
var $sReturnValue
The associative array that will be used to store the parameters for this call.
var $aParameters
The mode to use for the call
var $sMode
The request type that will be used for the call
var $sRequestType
The name of the javascript function that will be invoked to handle the response.
var $sResponseProcessor
The URI for where this request will be sent.
var $sRequestURI
The content type to use for the request.
var $sContentType
Initializes the xajaxCall object.
function xajaxCall( $sFunction = '' )
Override the function name set in the constructor.
function setFunction( $sFunction )
Clear the list of parameters being accumulated for this call.
function clearParameters()
Adds a parameter to the list that will be specified for the request generated by this xajaxCall object.
function addParameter( $sParameter, $bUseQuotes = true )
Add a parameter value that is the result of calling xajax.getFormValues for the specified form.
function addFormValuesParameter( $sFormID )
Sets the mode that will be specified for this xajax.call
function setMode( $sMode )
Sets the request type which will be specified for the generated xajax.call.
function setRequestType( $sRequestType )
Sets the name of the javascript function that will be used to process this response.
function setResponseProcessor( $sResponseProcessor )
Override the default URI with the specified one.
function setRequestURI( $sRequestURI )
Sets the content type that will be used by the generated request.
function setContentType( $sContentType )
Sets the value that will be returned after the generated call.
function setReturnValue( $sReturnValue )
Construct a xajax.call statement in javascript that can be used to make a xajax request with the parameters and settings previously configured for this xajaxCall object.
function generate()