[ Index ]

PHP Cross Reference of phpBB-3.3.7-deutsch

title

Body

[close]

/phpbb/install/helper/ -> config.php (summary)

This file is part of the phpBB Forum Software package.

Copyright: (c) phpBB Limited
License: GNU General Public License, version 2 (GPL-2.0)
File Size: 452 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

config:: (24 methods):
  __construct()
  get()
  set()
  system_get()
  get_time_remaining()
  get_memory_remaining()
  set_finished_task()
  set_active_module()
  get_progress_data()
  load_config()
  create_progress_restart_point()
  jump_to_restart_point()
  has_restart_point()
  save_config()
  increment_current_task_progress()
  set_current_task_progress()
  set_task_progress_count()
  get_current_task_progress()
  get_task_progress_count()
  set_finished_navigation_stage()
  set_active_navigation_stage()
  get_navigation_data()
  clean_up_config_file()
  setup_system_data()


Class: config  - X-Ref

Stores common settings and installation status

__construct(\phpbb\filesystem\filesystem_interface $filesystem, \bantu\IniGetWrapper\IniGetWrapper $php_ini, $phpbb_root_path)   X-Ref
Constructor


get($param_name, $default = false)   X-Ref
Returns data for a specified parameter

param: string    $param_name    Name of the parameter to return
param: mixed    $default    Default value to return when the specified data
return: mixed    value of the specified parameter or the default value if the data

set($param_name, $value)   X-Ref
Sets a parameter in installer_config

param: string    $param_name    Name of the parameter
param: mixed    $value        Values to set the parameter

system_get($param_name)   X-Ref
Returns system parameter

param: string    $param_name    Name of the parameter
return: mixed    Returns system parameter if it is defined, false otherwise

get_time_remaining()   X-Ref
Returns remaining time until the run time limit

return: int    Remaining time until the run time limit in seconds

get_memory_remaining()   X-Ref
Returns remaining memory available for PHP

return: int    Remaining memory until reaching the limit

set_finished_task($task_service_index)   X-Ref
Saves the latest executed task

param: int    $task_service_index    Index of the installer task service in the module

set_active_module($module_service_name, $module_service_index)   X-Ref
Set active module

param: string    $module_service_name    Name of the installer module service
param: int        $module_service_index    Index of the installer module service

get_progress_data()   X-Ref
Getter for progress data

return: array

load_config()   X-Ref
Recovers install configuration from file


create_progress_restart_point($name)   X-Ref
Creates a progress restart point

Restart points can be used to repeat certain tasks periodically.
You need to call this method from the first task you want to repeat.

param: string    $name    Name of the restart point

jump_to_restart_point($name)   X-Ref
Set restart point to continue from

param: string    $name    Name of the restart point
return: bool    Returns false if the restart point name does not exist, otherwise true

has_restart_point($name)   X-Ref
Returns whether a restart point with a given name exists or not

param: string    $name Name of the restart point
return: bool

save_config()   X-Ref
Dumps install configuration to disk


increment_current_task_progress($increment_by = 1)   X-Ref
Increments the task progress

param: int    $increment_by    The amount to increment by

set_current_task_progress($task_progress)   X-Ref
Sets the task progress to a specific number

param: int    $task_progress    The task progress number to be set

set_task_progress_count($task_progress_count)   X-Ref
Sets the number of tasks belonging to the installer in the current mode.

param: int    $task_progress_count    Number of tasks

get_current_task_progress()   X-Ref
Returns the number of the current task being executed

return: int

get_task_progress_count()   X-Ref
Returns the number of tasks belonging to the installer in the current mode.

return: int

set_finished_navigation_stage($nav_path)   X-Ref
Marks stage as completed in the navigation bar

param: array    $nav_path    Array to the navigation elem

set_active_navigation_stage($nav_path)   X-Ref
Marks stage as active in the navigation bar

param: array    $nav_path    Array to the navigation elem

get_navigation_data()   X-Ref
Returns navigation data

return: array

clean_up_config_file()   X-Ref
Removes install config file


setup_system_data()   X-Ref
Filling up system_data array




Generated: Thu Mar 24 21:31:15 2022 Cross-referenced by PHPXref 0.7.1