How to create a maintenance module
***********************************
1. License
  In earlier Versions, there was an exception for licensing the module under GPLv3, if you just use the predifined Objects in chapter 2.
  For ADbNewsSender versions starting at 2.2 this exception is NOT valid!
  If you use ADBNS2 APIS and/or code, you have to license the whole script under the GPLv3 license.  

2. Best practices:

Use functions!
This avoids problems with other maintenance modules.
Use the ADBNS2 APIs. All skeleton files are included in maintenance.php.


2. Objects which are provided by maintenance.php:

$MyDB: an ADBNS_DB Object.
$MyCFGro: a global_config_ro object 
$MyCFGrw: a global_config_rw object

If you need objects of other classes you can create them by your self.
(Read the docs at http://adbnewssender.sourceforge.net/docs/ )

An example of a maintenance module:

//Place here a short description of what your modul does.

function my_module($MyDB, $MyCFGro) 
{
	
	//for example:
	
	//this makes sure that your modul only works with 2.0.x versions
	if($MyCFGro->main_version_is_equal("2.0.0"))
	{

		//place your code here. 
		

	}
} 

//function call:

my_module($MyDB, $MyCFGro);

//Don't forget to register your module in /protected/maintenance/modules_reg.php.inc!