phpBB API Documentation
Class

module

class module

Properties

$id
$type
$module_ary
$filename
$module_url
$tpl_name
$mode
$sub

Methods

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

Private methods, should not be overwritten

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

Load and run the relevant module if applicable

page_header()

Output the standard page header

page_footer()

Output the standard page footer

get_tpl_name()

Returns desired template name

get_page_title()

Returns the desired page title

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

generate_navigation()

Generate the navigation tabs

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

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

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

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

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

inst_language_select($default = '')

Generate the drop down of available language packs

Details

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

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

Load and run the relevant module if applicable

Parameters

$mode
$run

at line 334
public page_header()

Output the standard page header

Output the standard page footer

at line 393
public get_tpl_name()

Returns desired template name

at line 401
public get_page_title()

Returns the desired page title

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

at line 454
public generate_navigation()

Generate the navigation tabs

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

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

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

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

Generate the drop down of available language packs

Parameters

$default