xajaxScriptPlugin. inc.php

Contains the xajaxScriptPlugin class declaration.

Summary

xajaxScriptPlugin. inc.php	Contains the xajaxScriptPlugin class declaration.
xajaxScriptPlugin class	Please see copyright.inc.php for a detailed description, copyright and license information.
xajaxScriptPlugin	Contains the code that can produce script and style data during deferred script generation.
Variables
sRequest
sHash
sRequestURI
bDeferScriptGeneration
bValidateHash
bWorking
Functions
xajaxScriptPlugin	Construct and initialize the xajax script plugin object.
configure	xajax::configure.
generateClientScript	Called by the xajaxPluginManager when the text of the client script (or style) declarations are needed.
canProcessRequest	Called by the xajaxPluginManager to determine if this plugin can process the current request.
processRequest	Called by the xajaxPluginManager when the current request should be processed.

xajaxScriptPlugin class

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

xajaxScriptPlugin

Contains the code that can produce script and style data during deferred script generation. This allows the xajax generated javascript and style sheet information to be loaded via an external file reference instead of inlined into the page source.

Summary

Variables
sRequest
sHash
sRequestURI
bDeferScriptGeneration
bValidateHash
bWorking
Functions
xajaxScriptPlugin	Construct and initialize the xajax script plugin object.
configure	xajax::configure.
generateClientScript	Called by the xajaxPluginManager when the text of the client script (or style) declarations are needed.
canProcessRequest	Called by the xajaxPluginManager to determine if this plugin can process the current request.
processRequest	Called by the xajaxPluginManager when the current request should be processed.

Variables

sRequest

var $sRequest

sHash

var $sHash

sRequestURI

var $sRequestURI

bDeferScriptGeneration

var $bDeferScriptGeneration

bValidateHash

var $bValidateHash

bWorking

var $bWorking

Functions

xajaxScriptPlugin

function xajaxScriptPlugin()

Construct and initialize the xajax script plugin object. During initialization, this plugin will look for hash codes in the GET data (parameters passed on the request URI) and store them for later use.

configure

function configure( $sName,
$mValue )

Sets/stores configuration options used by this plugin. See also

xajax::configure. This plugin will watch for and store the current setting for the following configuration options:

<requestURI> (string): The requestURI of the current script file.
<deferScriptGeneration> (boolean): A flag that indicates whether script deferral is in effect or not.
<deferScriptValidateHash> (boolean): A flag that indicates whether or not the script hash should be validated.

generateClientScript

function generateClientScript()

Called by the xajaxPluginManager when the text of the client script (or style) declarations are needed.

This function will only output script or style information if the request URI contained an appropriate hash code and script deferral is in effect.

canProcessRequest

function canProcessRequest()

Called by the xajaxPluginManager to determine if this plugin can process the current request. This will return true when the requestURI contains an appropriate hash code.

processRequest

function processRequest()

Called by the xajaxPluginManager when the current request should be processed. This plugin will generate the javascript or style sheet information that would normally be output by the other xajax plugin objects, when script deferral is in effect. If script deferral is disabled, this function returns without performing any functions.

This file contains detailed information regarding the xajax project, current version, copyrights, licnese and documentation.

var $sRequest

var $sHash

var $sRequestURI

var $bDeferScriptGeneration

var $bValidateHash

var $bWorking

function xajaxScriptPlugin()

Construct and initialize the xajax script plugin object.

function configure( $sName,
$mValue )

xajax::configure.

function configure( $sName,
$mValue )

Call this function to set options that will effect the processing of xajax requests.

function generateClientScript()

Called by the xajaxPluginManager when the text of the client script (or style) declarations are needed.

function canProcessRequest()

Called by the xajaxPluginManager to determine if this plugin can process the current request.

function processRequest()

Called by the xajaxPluginManager when the current request should be processed.