Difference between revisions of "OnAjaxCall"

(Created page with "===Description=== This event will be triggered before any Ajax operation is performed. The plugin can decide whether to proceed with the Ajax operation by returning true (proc...")
 
(No difference)

Latest revision as of 15:05, 18 January 2013

Description

This event will be triggered before any Ajax operation is performed. The plugin can decide whether to proceed with the Ajax operation by returning true (proceed)/false (stop).

Params

An array with three items: 'func' value passed at Ajax settings from browser in array, an array composed from data posted from browser, and the an object with a default response array.

Array
(
    [0] => Array( 0 => 'apps,ajaxBrowse'), /* just an example */
    [1] => Array( 0 => 'somevalue1',  1 => 'somevalue2'),
    [2] => $objAjax->response /* response is an Array with default Array( 0 => 'as', 1 => 'ajax_calls', 2 => 'd', 3 => '') */
)


Returns

boolean (true/false)

Example

function onAjaxCall( $arrItems ) 
{
    /* 
     * perform your required pre-requisite handler here 
     * return true if you want the to continue with the Ajax operation
     * return false to stop the Ajax operation
     */
}