class install_install extends module
Installation
Properties
| $id | ||
| $type | ||
| $module_ary | ||
| $filename | ||
| $module_url | ||
| $tpl_name | ||
| $mode | ||
| $sub | ||
| $db_config_options | The information below will be used to build the input fields presented to the user | |
| $admin_config_options | ||
| $advanced_config_options | ||
| $php_dlls_other | Specific PHP modules we may require for certain optional or extended features | |
| $bot_list | A list of the web-crawlers/bots we recognise by default | |
| $module_categories | Define the module structure so that we can populate the database without needing to hard-code module_id values | |
| $module_extras |
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_install($p_master)
|
||
|
main($mode, $sub)
|
||
|
check_server_requirements($mode, $sub)
Checks that the server we are installing on meets the requirements for running phpBB |
||
|
obtain_database_settings($mode, $sub)
Obtain the information required to connect to the database |
||
|
obtain_admin_settings($mode, $sub)
Obtain the administrator's name, password and email address |
||
|
create_config_file($mode, $sub)
Writes the config file to disk, or if unable to do so offers alternative methods |
||
|
obtain_advanced_settings($mode, $sub)
Provide an opportunity to customise some advanced settings during the install in case it is necessary for them to be set to access later |
||
|
load_schema($mode, $sub)
Load the contents of the schema into the database and then alter it based on what has been input during the installation |
||
|
build_search_index($mode, $sub)
Build the search index... |
||
|
add_modules($mode, $sub)
Populate the module tables |
||
|
add_language($mode, $sub)
Populate the language tables |
||
|
add_bots($mode, $sub)
Add search robots to the database |
||
|
email_admin($mode, $sub)
Sends an email to the board administrator with their password and some useful links |
||
|
disable_avatars_if_unwritable()
Check if the avatar directory is writable and disable avatars if it isn't writable. |
||
|
mail_auth_select($selected_method)
Generate a list of available mail server authentication methods |
||
|
get_submitted_data()
Get submitted data |
Details
in module at line 232
public
create($module_type, $module_url, $selected_mod = false, $selected_submod = false)
Private methods, should not be overwritten
in module at line 306
public
load($mode = false, $run = true)
Load and run the relevant module if applicable
in module at line 334
public
page_header()
Output the standard page header
in module at line 372
public
page_footer()
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
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
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
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
in module at line 688
public
inst_language_select($default = '')
Generate the drop down of available language packs
at line 49
public
install_install($p_master)
at line 54
public
main($mode, $sub)
at line 124
public
check_server_requirements($mode, $sub)
Checks that the server we are installing on meets the requirements for running phpBB
at line 535
public
obtain_database_settings($mode, $sub)
Obtain the information required to connect to the database
at line 674
public
obtain_admin_settings($mode, $sub)
Obtain the administrator's name, password and email address
at line 842
public
create_config_file($mode, $sub)
Writes the config file to disk, or if unable to do so offers alternative methods
at line 986
public
obtain_advanced_settings($mode, $sub)
Provide an opportunity to customise some advanced settings during the install in case it is necessary for them to be set to access later
at line 1088
public
load_schema($mode, $sub)
Load the contents of the schema into the database and then alter it based on what has been input during the installation
at line 1416
public
build_search_index($mode, $sub)
Build the search index...
at line 1477
public
add_modules($mode, $sub)
Populate the module tables
at line 1737
public
add_language($mode, $sub)
Populate the language tables
at line 1850
public
add_bots($mode, $sub)
Add search robots to the database
at line 1929
public
email_admin($mode, $sub)
Sends an email to the board administrator with their password and some useful links
at line 1992
public
disable_avatars_if_unwritable()
Check if the avatar directory is writable and disable avatars if it isn't writable.
at line 2006
public
mail_auth_select($selected_method)
Generate a list of available mail server authentication methods
at line 2024
public
get_submitted_data()
Get submitted data