PHP Class xajaxRequestPlugin

The base class for all xajax request plugins. Request plugins handle the registration, client script generation and processing of xajax enabled requests. Each plugin should have a unique signature for both the registration and processing of requests. During registration, the user will specify a type which will allow the plugin to detect and handle it. During client script generation, the plugin will generate a stub with the prescribed call options and request signature. During request processing, the plugin will detect the signature generated previously and process the request accordingly.

Inheritance: extends xajaxPlugin

Show file Open project: xajax/xajax

Public Methods

Method	Description
canProcessRequest ( )	* Function: canProcessRequest
configure ( $sName, $mValue )	* Function: configure
generateClientScript ( )	* Function: generateClientScript
generateHash ( )
processRequest ( )	* Function: processRequest
register ( $aArgs )	* Function: register

Method Details

canProcessRequest() public method

Called by the when a request has been received to determine if the request is for a xajax enabled function or for the initial page load.

public canProcessRequest ( )

configure() public method

Called by the when a configuration setting is changing. Plugins should store a local copy of the settings they wish to use during registration, client script generation or request processing.

public configure ( $sName, $mValue )

generateClientScript() public method

Called by when the page's HTML is being sent to the browser. This allows each plugin to inject some script / style or other appropriate tags into the HEAD of the document. Each block must be appropriately enclosed, meaning javascript code must be enclosed in SCRIPT and /SCRIPT tags.

public generateClientScript ( )

generateHash() public method

public generateHash ( )

processRequest() public method

Called by the when a request is being processed. This will only occur when has determined that the current request is a valid (registered) xajax enabled function via canProcessRequest>. Returns: false

public processRequest ( )

register() public method

Called by the when a user script when a function, event or callable object is to be registered. Additional plugins may support other registration types.

public register ( $aArgs )