Private Method Details |
init |
private void init( object sessionobject &$sessionobject, object displayobject &$displayobject, object databaseobject &$Db_target, object databaseobject &$Db_source, [ string $resume ] )
|
|
Instantiates a class of the child module being called by index.php
|
Parameter |
|
object sessionobject |
&$sessionobject |
|
|
The current sessionobject. |
|
|
object displayobject |
&$displayobject |
|
|
The display object that needs updating for the output. |
|
|
object databaseobject |
&$Db_target |
|
|
The target database (the one that the imported data is going to be put into). |
|
|
object databaseobject |
&$Db_source |
|
|
The source database (the one that the origional data has come from, i.e. the old board) |
|
|
string |
$resume |
= >>FALSE<< |
|
Indicating whether the object has already been started and is being resumed. |
|
Returns |
void |
|
restart |
private void restart( object sessionobject &$sessionobject, object displayobject &$displayobject, object databaseobject &$Db_target, object databaseobject &$Db_source, string $function )
|
|
Calls the various restart functions for the modules to be able to clean up and start again
|
Parameter |
|
object sessionobject |
&$sessionobject |
|
|
The current sessionobject. |
|
|
object displayobject |
&$displayobject |
|
|
The display object that needs updating for the output. |
|
|
object databaseobject |
&$Db_target |
|
|
The target database (the one that the imported data is going to be put into). |
|
|
object databaseobject |
&$Db_source |
|
|
The source database (the one that the origional data has come from, i.e. the old board) |
|
|
string |
$function |
|
|
The functions name of the clean up function to call |
|
Returns |
void |
|
check_order |
private boolean check_order( object sessionobject &$sessionobject, string $dependent )
|
|
Checks if a module can run, by checking the state of its dependent
|
Parameter |
|
object sessionobject |
&$sessionobject |
|
|
The current sessionobject. |
|
|
string |
$dependent |
|
|
the three digit module number i.e. '004' |
|
Returns |
boolean |
|
using |
private void using( object sessionobject &$sessionobject )
|
|
Sets the module number of the instantiated class to working in the sessionobject
|
Parameter |
|
object sessionobject |
&$sessionobject |
|
|
The current sessionobject. |
|
Returns |
void |
|
resume |
private void resume( object sessionobject &$sessionobject, object displayobject &$displayobject, object databaseobject &$Db_target, object databaseobject &$Db_source )
|
|
Calls the init of the current class and passes TRUE init boolean call
|
Parameter |
|
object sessionobject |
&$sessionobject |
|
|
The current sessionobject. |
|
|
object displayobject |
&$displayobject |
|
|
The display object that needs updating for the output. |
|
|
object databaseobject |
&$Db_target |
|
|
The target database (the one that the imported data is going to be put into). |
|
|
object databaseobject |
&$Db_source |
|
|
The source database (the one that the origional data has come from, i.e. the old board) |
|
Returns |
void |
|
restarted |
private void restarted( )
|
|
Accessor: Sets the private memeber variable _restart to true
|
Returns |
void |
|
add_module_error |
private void add_module_error( string $text )
|
|
Accessor: adds an error string to the error array
|
Parameter |
|
string |
$text |
|
|
An error string for the internal error stack |
|
Returns |
void |
|
get_class_list |
private array get_class_list( string $dir )
|
|
Accessor: adds an error string to the error array
|
Parameter |
|
string |
$dir |
|
|
The directory to find all the modules of a system in. |
|
Returns |
array string An array of all the modules names of a system |
|