copyright. inc.php
Examples
googleMap. inc.php
tableUpdater. inc.php
Tests
Xajax_core
Xajax_js
Xajax_controls
Index

xajaxFunctionPlugin. inc.php

Contains the xajaxFunctionPlugin class

Summary
xajaxFunctionPlugin. inc.php
Contains the xajaxFunctionPlugin class
xajaxFunctionPlugin class
Please see copyright.inc.php for a detailed description, copyright and license information.
Constants
XAJAX_FUNCTION
Specifies that the item being registered via the xajax->register function is a php function available at global scope, or a specific function from an instance of an object.
xajaxFunctionPlugin
Variables
aFunctions
An array of xajaxUserFunction object that are registered and available via a xajax.request call.
sXajaxPrefix
A configuration setting that is stored locally and used during the client script generation phase.
sDefer
Configuration option that can be used to request that the javascript file is loaded after the page has been fully loaded.
sRequestedFunction
This string is used to temporarily hold the name of the function that is being requested (during the request processing phase).
Functions
xajaxFunctionPlugin
Constructs and initializes the xajaxFunctionPlugin.
configure
Sets/stores configuration options used by this plugin.
register
Provides a mechanism for functions to be registered and made available to the page via the javascript xajax.request call.
generateClientScript
Called by the xajaxPluginManager during the client script generation phase.
canProcessRequest
Determines whether or not the current request can be processed by this plugin.
processRequest
Called by the xajaxPluginManager when a request needs to be processed.

xajaxFunctionPlugin class

Please see copyright.inc.php for a detailed description, copyright and license information.

Summary
Constants
XAJAX_FUNCTION
Specifies that the item being registered via the xajax->register function is a php function available at global scope, or a specific function from an instance of an object.

Constants

XAJAX_FUNCTION

Specifies that the item being registered via the xajax->register function is a php function available at global scope, or a specific function from an instance of an object.

xajaxFunctionPlugin

Summary
Variables
aFunctions
An array of xajaxUserFunction object that are registered and available via a xajax.request call.
sXajaxPrefix
A configuration setting that is stored locally and used during the client script generation phase.
sDefer
Configuration option that can be used to request that the javascript file is loaded after the page has been fully loaded.
sRequestedFunction
This string is used to temporarily hold the name of the function that is being requested (during the request processing phase).
Functions
xajaxFunctionPlugin
Constructs and initializes the xajaxFunctionPlugin.
configure
Sets/stores configuration options used by this plugin.
register
Provides a mechanism for functions to be registered and made available to the page via the javascript xajax.request call.
generateClientScript
Called by the xajaxPluginManager during the client script generation phase.
canProcessRequest
Determines whether or not the current request can be processed by this plugin.
processRequest
Called by the xajaxPluginManager when a request needs to be processed.

Variables

aFunctions

var $aFunctions

An array of xajaxUserFunction object that are registered and available via a xajax.request call.

sXajaxPrefix

var $sXajaxPrefix

A configuration setting that is stored locally and used during the client script generation phase.

sDefer

var $sDefer

Configuration option that can be used to request that the javascript file is loaded after the page has been fully loaded.

sRequestedFunction

var $sRequestedFunction

This string is used to temporarily hold the name of the function that is being requested (during the request processing phase).

Since canProcessRequest loads this value from the get or post data, it is unnecessary to load it again.

Functions

xajaxFunctionPlugin

function xajaxFunctionPlugin()

Constructs and initializes the xajaxFunctionPlugin.  The GET and POST data is searched for xajax function call parameters.  This will later be used to determine if the request is for a registered function in xajaxFunctionPlugin->canProcessRequest

configure

function configure($sName,
$mValue)

Sets/stores configuration options used by this plugin.

register

function register($aArgs)

Provides a mechanism for functions to be registered and made available to the page via the javascript xajax.request call.

generateClientScript

function generateClientScript()

Called by the xajaxPluginManager during the client script generation phase.  This is used to generate a block of javascript code that will contain function declarations that can be used on the browser through javascript to initiate xajax requests.

canProcessRequest

function canProcessRequest()

Determines whether or not the current request can be processed by this plugin.

Returns

booleanTrue if the current request can be handled by this plugin; false otherwise.

processRequest

function processRequest()

Called by the xajaxPluginManager when a request needs to be processed.

Returns

mixedTrue when the request has been processed successfully.  An error message when an error has occurred.
Generated by Natural Docs
This file contains detailed information regarding the xajax project, current version, copyrights, licnese and documentation.
function register($sType,
$mArg)
Call this function to register request handlers, including functions, callable objects and events.
var $aFunctions
An array of xajaxUserFunction object that are registered and available via a xajax.request call.
Construct instances of this class to define functions that will be registered with the xajax request processor.
xajax.request = function()
var $sXajaxPrefix
A configuration setting that is stored locally and used during the client script generation phase.
var $sDefer
Configuration option that can be used to request that the javascript file is loaded after the page has been fully loaded.
var $sRequestedFunction
This string is used to temporarily hold the name of the function that is being requested (during the request processing phase).
function xajaxFunctionPlugin()
Constructs and initializes the xajaxFunctionPlugin.
function configure($sName,
$mValue)
Sets/stores configuration options used by this plugin.
function register($aArgs)
Provides a mechanism for functions to be registered and made available to the page via the javascript xajax.request call.
function generateClientScript()
Called by the xajaxPluginManager during the client script generation phase.
function canProcessRequest()
Determines whether or not the current request can be processed by this plugin.
function processRequest()
Called by the xajaxPluginManager when a request needs to be processed.