API DOCS

Construct instances of this class to define functions that will be registered
with the <xajax> request processor. This class defines the parameters that
are needed for the definition of a xajax enabled function. While you can
still specify functions by name during registration, it is advised that you
convert to using this class when you wish to register external functions or
to specify call options as well.

variables

functions

xajaxUserFunction

function xajaxUserFunction($uf, $sInclude=NULL, $aConfiguration=array()

Constructs and initializes the object.

getName

function getName()

Get the name of the function being referenced.

configure

function configure($sName, $sValue)

Call this to set call options for this instance.

generateRequest

function generateRequest($sXajaxPrefix)

Constructs and returns a object which is capable
of generating the javascript call to invoke this xajax enabled
function.

generateClientScript

function generateClientScript($sXajaxPrefix)

Called by the that is referencing this function
reference during the client script generation phase. This function
will generate the javascript function stub that is sent to the
browser on initial page load.

call

function call($aArgs=array()

Called by the that references this function during the
request processing phase. This function will call the specified
function, including an external file if needed and passing along
the specified arguments.

Comments ( Add a comment )