xajaxPluginManager. inc.php

function xajaxPluginManager()

Construct and initialize the one and only xajax plugin manager.

function &getInstance()

Implementation of the singleton pattern: returns the one and only instance of the xajax plugin manager.

Returns

function loadPlugins( $aFolders )

Loads plugins from the folders specified.

function _insertIntoArray( & $aPlugins, & $objPlugin, $nPriority )

Inserts an entry into an array given the specified priority number.  If a plugin already exists with the given priority, the priority is automatically incremented until a free spot is found.  The plugin is then inserted into the empty spot in the array.

function registerPlugin( & $objPlugin,    $nPriority  =  1000 )

Registers a plugin.

Below is a table for priorities and their description

0 thru 999: Plugins that are part of or extensions to the xajax core 1000 thru 8999: User created plugins, typically, these plugins don’t care about order 9000 thru 9999: Plugins that generally need to be last or near the end of the plugin list

function canProcessRequest()

Calls each of the request plugins and determines if the current request can be processed by one of them.  If no processor identifies the current request, then the request must be for the initial page load.

See xajax->canProcessRequest for more information.

function processRequest()

Calls each of the request plugins to request that they process the current request.  If the plugin processes the request, it will return true.

function configure( $sName, $mValue )

Call each of the request plugins passing along the configuration setting specified.

function register( $aArgs )

Call each of the request plugins and give them the opportunity to handle the registration of the specified function, event or callable object.

function generateClientScript()

Call each of the request and response plugins giving them the opportunity to output some javascript to the page being generated.  This is called only when the page is being loaded initially.  This is not called when processing a request.

function &getPlugin( $sName )

Locate the specified response plugin by name and return a reference to it if one exists.