Packageindex Classtrees Elementlist

File: /home/jerry/www/vb3/impex/ImpExModule.php
vB3 ImpEx Import system - ImpEx

ImpExModule

ImpExFunction
   |
  +-- ImpExDatabase
     |
    +-- ImpExModule

Core module that needs to be exeteded by the diffrent import systems.

 

private class ImpExModule extends ImpExDatabase

Core module that needs to be exeteded by the diffrent import systems.
Is the base module class that all the import systems must extend to becontrolled by ImpEx core, it maintains the dependacy controll amongst themodules and defines the functions that the core will call and that whichbe overridden.

AuthorsJerry Hutchings <jerry.hutchings@vbulletin.com>
Version$Revision: 1.10 $
Copyrighthttp://www.vbulletin.com/license.html

 
Direct known subclasses: eve_000, ipb_000, phpBB2_000, ubb_classic_000

Methods inherited from ImpExDatabase

impexdatabase, create_data_type, add_import_id, add_custom_field, import_pm_text, import_pm, import_buddy_ignore, import_ban_list, import_post, import_user, fetch_user_salt, import_avatar, import_user_group, import_category, import_forum, import_thread, import_moderator, import_style_array, import_user_field_value, add_admin_user, import_rank, import_usergroup, get_vb_userid, get_one_username, get_user_array, get_banned_group, get_imported_group_ids, get_thread_id, get_threads_ids, get_category_ids, get_style_ids, get_done_user_ids, get_user_ids, get_username, get_forum_ids, clear_ban_list, clear_imported_styles, clear_imported_forums, clear_imported_threads, clear_banned_users, clear_imported_users, clear_imported_posts, clear_imported_polls, clear_imported_buddy_list, clear_imported_ignore_list, clear_imported_private_messages, clear_imported_moderators, clear_imported_smilies, clear_imported_user_groups, clear_imported_ranks, clear_imported_usergroups, update_post_parent_ids, associate_user, check_database, import_poll, import_poll_to_thread, import_poll_voters, does_smilie_exists, import_smilie, set_forum_private, import_smilie_image_group, clear_non_admin_users

Methods inherited from ImpExFunction

impexfunction, option2bin, over_ride_test, iif, unhtmlspecialchars, vb_parse_url, vb_file_get_contents, return_style_array, html_2_bb, parse_smilie_callback, all_your_posts_are_belong_to_us

Public Method Summary

void

ImpExModule()

Constructor

Private Method Summary

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
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
boolean

check_order(object sessionobject &$sessionobject, string $dependent)

Checks if a module can run, by checking the state of its dependent
void

using(object sessionobject &$sessionobject)

Sets the module number of the instantiated class to working in the sessionobject
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
void

restarted()

Accessor: Sets the private memeber variable _restart to true
void

add_module_error(string $text)

Accessor: adds an error string to the error array
array

get_class_list(string $dir)

Accessor: adds an error string to the error array

Fields inherited from ImpExDatabase

$_customernumber

Fields inherited from ImpExFunction

$_smilies

Private Field Summary

string

$_version

Class version
string

$_restart

State variable
array

$_error

Error stack

Public Method Details

ImpExModule

public void ImpExModule( )

  Constructor
Empty

Returns void


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


Private Field Details

$_version

private string $_version

>>'0.0.1'<<

Class version
This will allow the checking for interoprability of class version in diffrentversions of ImpEx


$_restart

private string $_restart

>>FALSE<<

State variable
Allows the object to know if it has been restarted or not.versions of ImpEx


$_error

private array $_error

>>array()<<

Error stack
Array used by add_error to hold error information internal to the objectto be delt with , this is for internal usage where as the error in ImpExSessionis for display.



Packageindex Classtrees Elementlist
PHPDoc 1.0beta