install_install

class install_install extends module

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_categories_basenames
	$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.
	populate_migrations(manager $extension_manager, migrator $migrator) Populate migrations for the installation
	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 315

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

in module at line 389

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

in module at line 417

public page_header()

in module at line 456

public page_footer()

in module at line 477

public get_tpl_name()

in module at line 485

public get_page_title()

in module at line 502

public redirect(string $page)

in module at line 540

public generate_navigation()

in module at line 613

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

in module at line 677

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

in module at line 719

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

in module at line 794

public inst_language_select($default = '')

at line 46

public install_install($p_master)

at line 51

public main($mode, $sub)

at line 134

public check_server_requirements($mode, $sub)

at line 552

public obtain_database_settings($mode, $sub)

at line 691

public obtain_admin_settings($mode, $sub)

at line 854

public create_config_file($mode, $sub)

at line 983

public obtain_advanced_settings($mode, $sub)

at line 1085

public load_schema($mode, $sub)

at line 1460

public build_search_index($mode, $sub)

at line 1511

public add_modules($mode, $sub)

at line 1826

public add_language($mode, $sub)

at line 1898

public add_bots($mode, $sub)

at line 1970

public email_admin($mode, $sub)

at line 2027

public disable_avatars_if_unwritable()

at line 2048

public populate_migrations(manager $extension_manager, migrator $migrator)

at line 2061

public mail_auth_select($selected_method)

at line 2079

public get_submitted_data()