phpBB API Documentation
Class

install_convert

class install_convert extends module

Convert class for conversions

Properties

$id
$type
$module_ary
$filename
$module_url
$tpl_name
$mode
$sub
$convert_options The information below will be used to build the input fields presented to the user

Methods

create($module_type, $module_url, $selected_mod = false, $selected_submod = false)

Private methods, should not be overwritten

from module
load($mode = false, $run = true)

Load and run the relevant module if applicable

from module
page_header()

Output the standard page header

from module
page_footer()

Output the standard page footer

from module
get_tpl_name()

Returns desired template name

from module
get_page_title()

Returns the desired page title

from module
redirect(string $page)

Generate an HTTP/1.1 header to redirect the user to another page This is used during the installation when we do not have a database available to call the normal redirect function

from module
generate_navigation()

Generate the navigation tabs

from module
error($error, $line, $file, $skip = false)

Output an error message If skip is true, return and continue execution, else exit

from module
db_error($error, $sql, $line, $file, $skip = false)

Output an error message for a database related problem If skip is true, return and continue execution, else exit

from module
input_field($name, $type, $value = '', $options = '')

Generate the relevant HTML for an input field and the associated label and explanatory text

from module
inst_language_select($default = '')

Generate the drop down of available language packs

from module
install_convert($p_master)

Variables used while converting, they are accessible from the global variable $convert

main($mode, $sub)

list_convertors($sub)

Generate a list of all available conversion modules

get_convert_settings($sub)

convert_data($sub)

The function which does the actual work (or dispatches it to the relevant places)

sync_forums($sync_batch)

Sync function being executed at the middle, some functions need to be executed after a successful sync.

save_convert_progress($step)

Save the convertor status

finish_conversion()

Finish conversion, the last function to be called.

final_jump($final_jump)

This function marks the steps after syncing

jump($jump, $last_statement)

This function marks the steps before syncing (jump=1)

build_insert_query($schema, $sql_data, $current_table)

process_row($schema, $sql_data, $insert_values)

Function for processing the currently handled row

meta_refresh($url)

Own meta refresh function to be able to change the global time used

Details

in module at line 232
public create($module_type, $module_url, $selected_mod = false, $selected_submod = false)

Private methods, should not be overwritten

Parameters

$module_type
$module_url
$selected_mod
$selected_submod

in module at line 306
public load($mode = false, $run = true)

Load and run the relevant module if applicable

Parameters

$mode
$run

in module at line 334
public page_header()

Output the standard page header

Output the standard page footer

in module at line 393
public get_tpl_name()

Returns desired template name

in module at line 401
public get_page_title()

Returns the desired page title

in module at line 418
public redirect(string $page)

Generate an HTTP/1.1 header to redirect the user to another page This is used during the installation when we do not have a database available to call the normal redirect function

Parameters

string $page The page to redirect to relative to the installer root path

in module at line 454
public generate_navigation()

Generate the navigation tabs

in module at line 527
public error($error, $line, $file, $skip = false)

Output an error message If skip is true, return and continue execution, else exit

Parameters

$error
$line
$file
$skip

in module at line 590
public db_error($error, $sql, $line, $file, $skip = false)

Output an error message for a database related problem If skip is true, return and continue execution, else exit

Parameters

$error
$sql
$line
$file
$skip

in module at line 632
public input_field($name, $type, $value = '', $options = '')

Generate the relevant HTML for an input field and the associated label and explanatory text

Parameters

$name
$type
$value
$options

in module at line 688
public inst_language_select($default = '')

Generate the drop down of available language packs

Parameters

$default

at line 86
public install_convert($p_master)

Variables used while converting, they are accessible from the global variable $convert

Parameters

$p_master

at line 91
public main($mode, $sub)

Parameters

$mode
$sub

at line 262
public list_convertors($sub)

Generate a list of all available conversion modules

Parameters

$sub

at line 337
public get_convert_settings($sub)

Parameters

$sub

at line 585
public convert_data($sub)

The function which does the actual work (or dispatches it to the relevant places)

Parameters

$sub

at line 1452
public sync_forums($sync_batch)

Sync function being executed at the middle, some functions need to be executed after a successful sync.

Parameters

$sync_batch

at line 1532
public save_convert_progress($step)

Save the convertor status

Parameters

$step

at line 1561
public finish_conversion()

Finish conversion, the last function to be called.

at line 1592
public final_jump($final_jump)

This function marks the steps after syncing

Parameters

$final_jump

at line 1631
public jump($jump, $last_statement)

This function marks the steps before syncing (jump=1)

Parameters

$jump
$last_statement

at line 1776
public build_insert_query($schema, $sql_data, $current_table)

Parameters

$schema
$sql_data
$current_table

at line 1931
public process_row($schema, $sql_data, $insert_values)

Function for processing the currently handled row

Parameters

$schema
$sql_data
$insert_values

at line 2081
public meta_refresh($url)

Own meta refresh function to be able to change the global time used

Parameters

$url