PHP Class xajaxEventPlugin

Plugin that adds server side event handling capabilities to xajax. Events can be registered, then event handlers attached.

Inheritance: extends xajaxRequestPlugin

Show file Open project: xajax/xajax

Public Properties

Property	Type	Description
$aEvents		* Array: aEvents
$bDeferScriptGeneration
$sDefer		* String: sDefer
$sEventPrefix		* String: sEventPrefix
$sRequestedEvent		* String: sRequestedEvent
$sXajaxPrefix		* String: sXajaxPrefix

Public Methods

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

Method Details

canProcessRequest() public method

* Function: canProcessRequest

public canProcessRequest ( )

configure() public method

* Function: configure

public configure ( $sName, $mValue )

generateClientScript() public method

* Function: generateClientScript

public generateClientScript ( )

generateHash() public method

public generateHash ( )

processRequest() public method

* Function: processRequest

public processRequest ( )

register() public method

$sType - (string): type of item being registered $sEvent - (string): the name of the event $ufHandler - (function name or reference): a reference to the user function to call $aConfiguration - (array): an array containing configuration options

public register ( $aArgs )

xajaxEventPlugin() public method

* Function: xajaxEventPlugin

public xajaxEventPlugin ( )

Property Details

$aEvents public property

* Array: aEvents

public $aEvents

$bDeferScriptGeneration public property

public $bDeferScriptGeneration

$sDefer public property

* String: sDefer

public $sDefer

$sEventPrefix public property

* String: sEventPrefix

public $sEventPrefix

$sRequestedEvent public property

* String: sRequestedEvent

public $sRequestedEvent

$sXajaxPrefix public property

* String: sXajaxPrefix

public $sXajaxPrefix