phpBB API Documentation
Class

phpbb\install\controller\helper

class helper

A duplicate of \phpbb\controller\helper

This class is necessary because of controller\helper's legacy function calls to pageheader() pagefooter() functions which has unavailable dependencies.

Methods

__construct(config $config, language $language, language_file_helper $lang_helper, navigation_provider $nav, template $template, path_helper $path_helper, request $phpbb_request, symfony_request $request, router $router, string $phpbb_root_path)

Constructor

Response render(string $template_file, string $page_title = '', bool $selected_language = false, int $status_code = 200)

Automate setting up the page and creating the response object.

string route(string $route_name, array $parameters = array())

Returns path from route name

handle_language_select()

Handles language selector form

handle_navigation(iohandler_interface|null $iohandler = null)

Process navigation data to reflect active/completed stages

Details

at line 111
public __construct(config $config, language $language, language_file_helper $lang_helper, navigation_provider $nav, template $template, path_helper $path_helper, request $phpbb_request, symfony_request $request, router $router, string $phpbb_root_path)

Constructor

Parameters

config $config
language $language
language_file_helper $lang_helper
navigation_provider $nav
template $template
path_helper $path_helper
request $phpbb_request
symfony_request $request
router $router
string $phpbb_root_path

at line 137
public Response render(string $template_file, string $page_title = '', bool $selected_language = false, int $status_code = 200)

Automate setting up the page and creating the response object.

Parameters

string $template_file The template handle to render
string $page_title The title of the page to output
bool $selected_language True to enable language selector it, false otherwise
int $status_code The status code to be sent to the page header

Return Value

Response object containing rendered page

at line 167
public string route(string $route_name, array $parameters = array())

Returns path from route name

Parameters

string $route_name
array $parameters

Return Value

string

at line 177
public handle_language_select()

Handles language selector form

at line 212
public handle_navigation(iohandler_interface|null $iohandler = null)

Process navigation data to reflect active/completed stages

Parameters

iohandler_interface|null $iohandler