PHP Class phpbb\convert\controller\convertor

WARNING: This file did not meant to be present in a production environment, so moving this file to a location which is accessible after board installation might lead to security issues.

Show file Open project: phpbb/phpbb

Protected Properties

Property	Type	Description
$cache	phpbb\cache\driver\driver_interface
$config	phpbb\config\db
$config_php_file	phpbb\config_php_file
$config_table	string
$controller_helper	phpbb\install\controller\helper
$db	phpbb\db\driver\driver_interface
$db_helper	phpbb\install\helper\database
$install_helper	phpbb\install\helper\install_helper
$installer_cache	phpbb\cache\driver\driver_interface
$iohandler	phpbb\install\helper\iohandler\iohandler_interface
$language	phpbb\language\language
$navigation_provider	phpbb\install\helper\navigation\navigation_provider
$php_ext	string
$phpbb_root_path	string
$request	phpbb\request\request_interface
$session_keys_table	string
$session_table	string
$template	phpbb\template\template

Public Methods

Method	Description
__construct ( phpbb\cache\driver\driver_interface $cache, phpbb\install\helper\container_factory $container, phpbb\install\helper\database $db_helper, phpbb\install\controller\helper $controller_helper, phpbb\install\helper\install_helper $install_helper, phpbb\install\helper\iohandler\factory $iohandler, phpbb\language\language $language, phpbb\install\helper\navigation\navigation_provider $nav, phpbb\request\request_interface $request, phpbb\template\template $template, string $phpbb_root_path, string $php_ext )	Constructor
convert ( $converter )	Run conversion
finish ( )	Render the final page of the convertor
intro ( boolean \| integer $start_new ) : Response	Render the intro page
proccess_settings_form ( string $convertor )	Validates settings form
redirect_to_html ( string $url )	Redirects an AJAX request to a non-JS version
render_error ( string $msg, string \| boolean $desc = false )	Renders an error form
render_settings_form ( array $error = [] )	Renders settings form
settings ( string $convertor ) : Response \| Symfony\Component\HttpFoundation\StreamedResponse	Obtain convertor settings

Protected Methods

Method	Description
render_convert_list ( ) : Response	Render the list of available convertors

Private Methods

Method	Description
setup_navigation ( $stage )

Method Details

__construct() public method

Constructor

public __construct ( phpbb\cache\driver\driver_interface $cache, phpbb\install\helper\container_factory $container, phpbb\install\helper\database $db_helper, phpbb\install\controller\helper $controller_helper, phpbb\install\helper\install_helper $install_helper, phpbb\install\helper\iohandler\factory $iohandler, phpbb\language\language $language, phpbb\install\helper\navigation\navigation_provider $nav, phpbb\request\request_interface $request, phpbb\template\template $template, string $phpbb_root_path, string $php_ext )
$cache	phpbb\cache\driver\driver_interface
$container	phpbb\install\helper\container_factory
$db_helper	phpbb\install\helper\database
$controller_helper	phpbb\install\controller\helper
$install_helper	phpbb\install\helper\install_helper
$iohandler	phpbb\install\helper\iohandler\factory
$language	phpbb\language\language
$nav	phpbb\install\helper\navigation\navigation_provider
$request	phpbb\request\request_interface
$template	phpbb\template\template
$phpbb_root_path	string
$php_ext	string

convert() public method

Run conversion

public convert ( $converter )

finish() public method

Render the final page of the convertor

public finish ( )

intro() public method

Render the intro page

public intro ( boolean \| integer $start_new ) : Response
$start_new	boolean \| integer	Whether or not to force to start a new convertor
return	Symfony\Component\HttpFoundation\Response

proccess_settings_form() public method

Validates settings form

public proccess_settings_form ( string $convertor )
$convertor	string

redirect_to_html() public method

Redirects an AJAX request to a non-JS version

public redirect_to_html ( string $url )
$url	string	URL to redirect to

render_convert_list() protected method

Render the list of available convertors

protected render_convert_list ( ) : Response
return	Symfony\Component\HttpFoundation\Response

render_error() public method

Renders an error form

public render_error ( string $msg, string \| boolean $desc = false )
$msg	string
$desc	string \| boolean

render_settings_form() public method

Renders settings form

public render_settings_form ( array $error = [] )
$error	array	Array of errors

settings() public method

Obtain convertor settings

public settings ( string $convertor ) : Response \| Symfony\Component\HttpFoundation\StreamedResponse
$convertor	string	Name of the convertor
return	Symfony\Component\HttpFoundation\Response \| Symfony\Component\HttpFoundation\StreamedResponse

Property Details

$cache protected property

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

$config protected property

protected db,phpbb\config $config
return	phpbb\config\db

$config_php_file protected property

protected config_php_file,phpbb $config_php_file
return	phpbb\config_php_file

$config_table protected property

protected string $config_table
return	string

$controller_helper protected property

protected helper,phpbb\install\controller $controller_helper
return	phpbb\install\controller\helper

$db protected property

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

$db_helper protected property

protected database,phpbb\install\helper $db_helper
return	phpbb\install\helper\database

$install_helper protected property

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

$installer_cache protected property

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

$iohandler protected property

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

$language protected property

protected language,phpbb\language $language
return	phpbb\language\language

$navigation_provider protected property

protected navigation_provider,phpbb\install\helper\navigation $navigation_provider
return	phpbb\install\helper\navigation\navigation_provider

$php_ext protected property

protected string $php_ext
return	string

$phpbb_root_path protected property

protected string $phpbb_root_path
return	string

$request protected property

protected request_interface,phpbb\request $request
return	phpbb\request\request_interface

$session_keys_table protected property

protected string $session_keys_table
return	string

$session_table protected property

protected string $session_table
return	string

$template protected property

protected template,phpbb\template $template
return	phpbb\template\template