|
|
File: /home/jerry/www/vb3/impex/ImpExData.php
vB3 ImpEx Import system - ImpEx
ImpExData
ImpExFunction | +-- ImpExDatabase | +-- ImpExData
Is the abstract factory that handels data object instantiation.
|
private class ImpExData extends ImpExDatabase
Is the abstract factory that handels data object instantiation.
The obect will create itself depending on the type that is passes tothe constructor. The object will consist of a number of elementssome being vbmandatory and the other nonvbmandatory.A valid object is one that has values for all the vbmandatroy elements.
|
|
|
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 |
|
|
|
|
Fields inherited from ImpExFunction |
$_smilies |
|
|
Public Method Details |
ImpExData |
public void ImpExData( object databaseobject &$Db_object, object sessionobject &$sessionobject, string $type )
|
|
Instantiates a class of the child module being called by index.php
|
Parameter |
|
object databaseobject |
&$Db_object |
|
|
The database that has the vbfiled definitions |
|
|
object sessionobject |
&$sessionobject |
|
|
The current sessionobject. |
|
|
string |
$type |
|
|
The name of the object to create user,post,thread,etc |
|
Returns |
void |
|
|
Private Method Details |
is_valid |
private void is_valid( )
|
|
Returns the valid state of the data object
Searches the mandatory elements for a NULL value, if it finds one it stores it in _failed on andreturns FALSE, other wise returns TRUE
|
Returns |
void |
|
how_complete |
private double how_complete( )
|
|
Returns the percentage completness of the object
Calculated the NULL's from the total amount of elements to discover the percentagecomplete that the object is
|
Returns |
double |
|
return_xml |
private string return_xml( )
|
|
Returns a XML representation of the object
Returns the elements as a formed XML document
|
Returns |
string |
|
return_string |
private string return_string( )
|
|
Returns a string representation of the object
Returns the elements as a string
|
Returns |
string |
|
get_value |
private mixed get_value( string $section, string $name )
|
|
Accessor
|
Parameter |
|
string |
$section |
|
|
The type of value being retrived |
|
|
string |
$name |
|
|
The name of value being retrived |
|
Returns |
mixed string|NULL |
|
set_value |
private boolean set_value( string $section, string $name, string $value )
|
|
Accessor
|
Parameter |
|
string |
$section |
|
|
The type of value being set |
|
|
string |
$name |
|
|
The name of value being set |
|
|
string |
$value |
|
|
The passes value |
|
Returns |
boolean |
|
add_default_value |
private boolean add_default_value( string $key, string $value )
|
|
Accessor
|
Parameter |
|
string |
$key |
|
|
The name of value being set |
|
|
string |
$value |
|
|
The passes value |
|
Returns |
boolean |
|
get_default_values |
private boolean get_default_values( )
|
|
Accessor : Returns the array of default value
|
Returns |
boolean |array |
|
add_custom_value |
private boolean add_custom_value( string $key, string $value )
|
|
Accessor
|
Parameter |
|
string |
$key |
|
|
The name of value being set |
|
|
string |
$value |
|
|
The passes value |
|
Returns |
boolean |
|
get_custom_values |
private boolean get_custom_values( )
|
|
Accessor : Returns the array of custom values
|
Returns |
boolean |array |
|
|
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
|
|
$_values |
private array $_values
>>array() <<
Data elements store
3D array to contain 'mandatory', 'nonmandatory', 'dictionary'
|
|
$_elementtypes |
private array $_elementtypes
>>array ('mandatory' , 'nonmandatory') <<
Element types
Element types in the _values array
|
|
$_datatype |
private string $_datatype
>>'' <<
Object data type
Stores the type of data object, i.e. user, post, thread.
|
|
$_failedon |
private string $_failedon
>>'' <<
is_valid error store
Stores the type elements that is_valid failed on
|
|
$_has_default_values |
private boolean $_has_default_values
>>false <<
flag for default values
Stores if the object has any default fields, i.e. Location, Occupation
|
|
$_default_values |
private array $_default_values
>>array() <<
store for default values
Stores data for default values
|
|
$_has_custom_types |
private string $_has_custom_types
>>FALSE <<
flag for customFields
Stores if the object has any custom fields, i.e. new profilefiled entries
|
|
$_custom_types |
private array $_custom_types
>>array() <<
store for custom fields
Stores data for custom fields
|
|
$_password_md5_already |
private boolean $_password_md5_already
>>false <<
Password flag
Definies where the password needs to be md5() before md5($password . $salt) or not.
|
|
$_setforgottenpassword |
private boolean $_setforgottenpassword
>>false <<
Password flag
Here in case the imported password can't be retrived, i.e. it in crypt so itforces the board to assign a new one.
|
|
|
|
|
PHPDoc 1.0beta |