API DOCS
Classes & Functions
Files & Folders
Class: xajaxRequestPlugin
The base class for all xajax request plugins.
Request plugins handle the registration, client script generation and processing of
xajax enabled requests. Each plugin should have a unique signature for both
the registration and processing of requests. During registration, the user will
specify a type which will allow the plugin to detect and handle it. During client
script generation, the plugin will generate a <xajax.request> stub with the
prescribed call options and request signature. During request processing, the
plugin will detect the signature generated previously and process the request
accordingly.
variables
functions
configure
function configure($sName, $mValue)
Called by the
Plugins should store a local copy of the settings they wish to use during
registration, client script generation or request processing.
register
function register($aArgs)
Called by the
or callable object is to be registered. Additional plugins may support other
registration types.
generateClientScript
function generateClientScript()
Called by
This allows each plugin to inject some script / style or other appropriate tags
into the HEAD of the document. Each block must be appropriately enclosed, meaning
javascript code must be enclosed in SCRIPT and /SCRIPT tags.
canProcessRequest
function canProcessRequest()
Called by the
if the request is for a xajax enabled function or for the initial page load.
processRequest
function processRequest()
Called by the
will only occur when
(registered) xajax enabled function via
