phpBB API Documentation
Class

phpbb\convert\controller\convertor

class convertor

Controller for forum convertors

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.

Methods

__construct(driver_interface $cache, container_factory $container, database $db_helper, helper $controller_helper, install_helper $install_helper, factory $iohandler, language $language, navigation_provider $nav, request_interface $request, template $template, string $phpbb_root_path, string $php_ext)

Constructor
Response intro(bool|int $start_new)

Render the intro page
Response|StreamedResponse settings(string $converter)

Obtain convertor settings
convert($converter)

Run conversion
finish()

Render the final page of the convertor
proccess_settings_form(string $convertor)

Validates settings form
render_settings_form(array $error = array())

Renders settings form
render_error(string $msg, string|bool $desc = false)

Renders an error form
redirect_to_html(string $url)

Redirects an AJAX request to a non-JS version

Details

at line 145
public __construct(driver_interface $cache, container_factory $container, database $db_helper, helper $controller_helper, install_helper $install_helper, factory $iohandler, language $language, navigation_provider $nav, request_interface $request, template $template, string $phpbb_root_path, string $php_ext)

Constructor

Parameters

driver_interface $cache
container_factory $container
database $db_helper
helper $controller_helper
install_helper $install_helper
factory $iohandler
language $language
navigation_provider $nav
request_interface $request
template $template
string $phpbb_root_path
string $php_ext

at line 185
public Response intro(bool|int $start_new)

Render the intro page

Parameters

bool|int $start_new Whether or not to force to start a new convertor

Return Value

Response

at line 260
public Response|StreamedResponse settings(string $converter)

Obtain convertor settings

Parameters

string $converter Name of the convertor

Return Value

Response|StreamedResponse

at line 352
public convert($converter)

Run conversion

Parameters

$converter

at line 378
public finish()

Render the final page of the convertor

at line 432
public proccess_settings_form(string $convertor)

Validates settings form

Parameters

string $convertor

at line 607
public render_settings_form(array $error = array())

Renders settings form

Parameters

array $error Array of errors

at line 776
public render_error(string $msg, string|bool $desc = false)

Renders an error form

Parameters

string $msg
string|bool $desc

at line 802
public redirect_to_html(string $url)

Redirects an AJAX request to a non-JS version

Parameters

string $url URL to redirect to