phpBB API Documentation
Class

install_update

class install_update extends module

Update Installation

Properties

$id
$type
$module_ary
$filename
$module_url
$tpl_name
$mode
$sub
$p_master
$update_info
$old_location
$new_location
$latest_version
$current_version
$update_to_version
$test_update

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_update($p_master)

main($mode, $sub)

show_diff($update_list)

Show file diff

get_update_structure($update_list, $expected_files)

Collect all file status infos we need for the update by diffing all files

make_update_diff($update_list, $original_file, $file, $expected_files, $custom = false)

Compare files for storage in update_list

get_custom_info($update_list, $file)

Update update_list with custom new files

get_file($mode)

Get remote file

include_file($filename)

Function for including files...

return_diff()

Wrapper for returning a diff object

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 67
public install_update($p_master)

Parameters

$p_master

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

Parameters

$mode
$sub

at line 1125
public show_diff($update_list)

Show file diff

Parameters

$update_list

at line 1288
public get_update_structure($update_list, $expected_files)

Collect all file status infos we need for the update by diffing all files

Parameters

$update_list
$expected_files

at line 1415
public make_update_diff($update_list, $original_file, $file, $expected_files, $custom = false)

Compare files for storage in update_list

Parameters

$update_list
$original_file
$file
$expected_files
$custom

at line 1630
public get_custom_info($update_list, $file)

Update update_list with custom new files

Parameters

$update_list
$file

at line 1649
public get_file($mode)

Get remote file

Parameters

$mode

at line 1756
public include_file($filename)

Function for including files...

Parameters

$filename

at line 1773
public return_diff()

Wrapper for returning a diff object