DataLoad User Guide

Event handlers are where the script developer inserts their PHP code
DataLoad calls the events when something significant happens, so your script can respond to those events

DataLoad Scripting Event Handlers

DataLoad provides "event handlers" where the PHP script code should be added. Each event handler is run when something happens in DataLoad, e.g. the file is opened or the load started. By adding PHP code to the appropriate event handler(s) the script writer can customise DataLoad as required. In general all PHP code should be entered in event handler functions. The only exceptions are global variables and the developer's own custom functions, both of which should be declared outside of the event handler functions.

The template PHP script DataLoad provides when you start a new script includes "stub functions" for each event handler. These are pre-created functions for each event but they do not contain any code. The developer should insert their code in these functions. The empty OnOpenFile event handler function is shown below as an example. Developers should replace the comment "//Insert code here..." with their PHP code.

//OnFileOpened - Called when the file is opened in DataLoad.
function OnOpenFile()
{

//Use error_reporting() to control how warnings and errors are handled and reported.
//0 turns off all reporting while E_ALL | E_STRICT is the most verbose. There are a range of values between - see PHP documentation.
//The DataLoad php.ini defaults reporting to E_ALL | E_STRICT.
//error_reporting(0);

//Insert code here...

}

The full list of event handlers available is shown below. Each event handler will have an equivalent function in the template PHP script.