xajaxDefaultIncludePlugin. inc.php

Contains the default script include plugin class.

Summary

xajaxDefaultIncludePlugin. inc.php	Contains the default script include plugin class.
xajax default script include plugin class	Please see copyright.inc.php for a detailed description, copyright and license information.
xajaxIncludeClientScript	Generates the SCRIPT tags necessary to ‘include’ the xajax javascript library on the browser.
Functions
configure
generateClientScript
getJavascriptConfig	Generates the xajax settings that will be used by the xajax javascript library when making requests back to the server.
printJavascriptConfig	See <xajaxIncludeClientScriptPlugin::getJavascriptConfig>
getJavascriptInclude	Generates SCRIPT tags necessary to load the javascript libraries on the browser.
printJavascriptInclude	See <xajaxIncludeClientScriptPlugin::getJavascriptInclude>
_getScriptFilename	Returns the name of the script file, based on the current settings.

xajax default script include plugin class

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

xajaxIncludeClientScript

Generates the SCRIPT tags necessary to ‘include’ the xajax javascript library on the browser.

This is called when the page is first loaded.

Summary

Functions
configure
generateClientScript
getJavascriptConfig	Generates the xajax settings that will be used by the xajax javascript library when making requests back to the server.
printJavascriptConfig	See <xajaxIncludeClientScriptPlugin::getJavascriptConfig>
getJavascriptInclude	Generates SCRIPT tags necessary to load the javascript libraries on the browser.
printJavascriptInclude	See <xajaxIncludeClientScriptPlugin::getJavascriptInclude>
_getScriptFilename	Returns the name of the script file, based on the current settings.

Functions

configure

function configure( $sName,
$mValue )

generateClientScript

function generateClientScript()

getJavascriptConfig

function getJavascriptConfig()

Generates the xajax settings that will be used by the xajax javascript library when making requests back to the server.

Returns

string

The javascript code necessary to configure the settings on the browser.

printJavascriptConfig

function printJavascriptConfig()

See <xajaxIncludeClientScriptPlugin::getJavascriptConfig>

getJavascriptInclude

function getJavascriptInclude()

Generates SCRIPT tags necessary to load the javascript libraries on the browser.

sJsURI	(string): The relative or fully qualified PATH that will be used to compose the URI to the specified javascript files.
aJsFiles	(array): List of javascript files to include.

Returns

string

The SCRIPT tags that will cause the browser to load the specified files.

printJavascriptInclude

function printJavascriptInclude()

See <xajaxIncludeClientScriptPlugin::getJavascriptInclude>

_getScriptFilename

function _getScriptFilename( $sFilename )

Returns the name of the script file, based on the current settings.

sFilename

(string): The base filename.

Returns

string

The filename as it should be specified in the script tags on the browser.

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

function configure( $sName,
$mValue )

function generateClientScript()

function getJavascriptConfig()

Generates the xajax settings that will be used by the xajax javascript library when making requests back to the server.

function printJavascriptConfig()

See xajaxIncludeClientScriptPlugin::getJavascriptConfig

function getJavascriptInclude()

Generates SCRIPT tags necessary to load the javascript libraries on the browser.

function printJavascriptInclude()

See xajaxIncludeClientScriptPlugin::getJavascriptInclude

function _getScriptFilename( $sFilename )

Returns the name of the script file, based on the current settings.