PHP Class phpbb\install\installer

Show file Open project: phpbb/phpbb Class Usage Examples

Protected Properties

Property Type Description
$cache phpbb\cache\driver\driver_interface
$container_factory phpbb\install\helper\container_factory
$install_config phpbb\install\helper\config
$installer_modules phpbb\di\ordered_service_collection
$iohandler phpbb\install\helper\iohandler\iohandler_interface
$module_step_count array Stores the number of steps that a given module has
$purge_cache_before boolean
$web_root string

Public Methods

Method Description
__construct ( phpbb\cache\driver\driver_interface $cache, phpbb\install\helper\config $config, phpbb\path_helper $path_helper, phpbb\install\helper\container_factory $container ) Constructor
run ( ) Run phpBB installer
set_iohandler ( phpbb\install\helper\iohandler\iohandler_interface $iohandler ) Sets input-output handler objects
set_modules ( phpbb\di\ordered_service_collection $modules ) Sets modules to execute
set_purge_cache_before ( boolean $purge_cache_before ) Sets whether to purge cache before the installation process

Protected Methods

Method Description
recover_progress ( ) : string Recover install progress

Method Details

__construct() public method

Constructor
public __construct ( phpbb\cache\driver\driver_interface $cache, phpbb\install\helper\config $config, phpbb\path_helper $path_helper, phpbb\install\helper\container_factory $container )
$cache phpbb\cache\driver\driver_interface Cache service
$config phpbb\install\helper\config Installer config handler
$path_helper phpbb\path_helper Path helper
$container phpbb\install\helper\container_factory Container

recover_progress() protected method

Recover install progress
protected recover_progress ( ) : string
return string Index of the next installer module to execute

run() public method

Run phpBB installer
public run ( )

set_iohandler() public method

Sets input-output handler objects
public set_iohandler ( phpbb\install\helper\iohandler\iohandler_interface $iohandler )
$iohandler phpbb\install\helper\iohandler\iohandler_interface

set_modules() public method

Note: The installer will run modules in the order they are set in the array.
public set_modules ( phpbb\di\ordered_service_collection $modules )
$modules phpbb\di\ordered_service_collection Service collection of module service names

set_purge_cache_before() public method

Sets whether to purge cache before the installation process
public set_purge_cache_before ( boolean $purge_cache_before )
$purge_cache_before boolean

Property Details

$cache protected property

protected driver_interface,phpbb\cache\driver $cache
return phpbb\cache\driver\driver_interface

$container_factory protected property

protected container_factory,phpbb\install\helper $container_factory
return phpbb\install\helper\container_factory

$install_config protected property

protected config,phpbb\install\helper $install_config
return phpbb\install\helper\config

$installer_modules protected property

protected ordered_service_collection,phpbb\di $installer_modules
return phpbb\di\ordered_service_collection

$iohandler protected property

protected iohandler_interface,phpbb\install\helper\iohandler $iohandler
return phpbb\install\helper\iohandler\iohandler_interface

$module_step_count protected property

Stores the number of steps that a given module has
protected array $module_step_count
return array

$purge_cache_before protected property

protected bool $purge_cache_before
return boolean

$web_root protected property

protected string $web_root
return string