API DOCS

DOCS & TUTORIALS » API DOCS » xajax_core » xajaxPlugin.inc.php » xajaxResponsePlugin

Class: xajaxResponsePlugin



Base class for all xajax response plugins.

A response plugin provides additional services not already provided by the
<xajaxResponse> class with regard to sending response commands to the
client. In addition, a response command may send javascript to the browser
at page load to aid in the processing of it's response commands.

variables

functions

setResponse

function setResponse(&$objResponse)

Called by the object that is currently being used
to build the response that will be sent to the client browser.


addCommand


Used internally to add a command to the response command list. This
will call addPluginCommand> using the reference provided
in setResponse>.

getName

function getName()

Called by the when the user script requests a plugin.
This name must match the plugin name requested in the called to
plugin>.

process

function process()

Called by when a user script requests the service of a
response plugin. The parameters provided by the user will be used to
determine which response command and parameters will be sent to the
client upon completion of the xajax request process.

 



XAJAX on SourceForge.net
Support this project Valid XHTML 1.0 Transitional