phpBB API Documentation
Class

phpbb\install\helper\iohandler\cli_iohandler

class cli_iohandler extends iohandler_base

Input-Output handler for the CLI frontend

Methods

__construct()

Constructor

from iohandler_base
set_language(language $language)

Set language service

from iohandler_base
add_error_message(string|array $error_title, string|bool|array $error_description = false)

{@inheritdoc

add_warning_message(string|array $warning_title, string|bool|array $warning_description = false)

{@inheritdoc

add_log_message(string|array $log_title, string|bool|array $log_description = false)

{@inheritdoc

null add_success_message($error_title, $error_description = false)

{@inheritdoc

set_task_count(int $task_count, bool $restart = false)

Sets the number of tasks belonging to the installer in the current mode.

set_progress(string $task_lang_key, int $task_number)

Sets the progress information

finish_progress(string $message_lang_key)

Finish the progress bar

string generate_form_render_data(string $title, array $form)

Returns the rendering information for the form

from iohandler_base
set_style(OutputStyle $style, OutputInterface $output)

Set the style and output used to display feedback;

mixed get_input(string $name, mixed $default, bool $multibyte = false)

Returns input variable

mixed get_raw_input(string $name, mixed $default)

Returns raw input variable

set_input(string $name, mixed $value)

Set input variable

mixed get_server_variable(string $name, mixed $default = '')

Returns server variable

mixed get_header_variable(string $name, mixed $default = '')

Wrapper function for request_interface::header()

bool is_secure()

Returns true if the connection is encrypted

add_user_form_group(string $title, array $form)

Adds a requested data group to the rendering queue

send_response(bool $no_more_output = false)

Renders or returns response message

request_refresh()

Sends refresh request to the client

set_active_stage_menu(array $menu_path)

Marks stage as active in the navigation bar

set_finished_stage_menu(array $menu_path)

Marks stage as completed in the navigation bar

set_cookie(string $cookie_name, string $cookie_value)

Sends and sets cookies

add_download_link(string $route, string $title, string|null|array $msg = null)

Adds a download link

render_update_file_status(array $status_array)

Renders the status of update files

redirect(string $url, bool $use_ajax = false)

Redirects the user to a new page

Details

in iohandler_base at line 76
public __construct()

Constructor

in iohandler_base at line 94
public set_language(language $language)

Set language service

Parameters

language $language

at line 138
public add_error_message(string|array $error_title, string|bool|array $error_description = false)

{@inheritdoc

Parameters

string|array $error_title Title of the error message.
string|bool|array $error_description Description of the error (and possibly guidelines to resolve it), or false if the error description is not available.

at line 161
public add_warning_message(string|array $warning_title, string|bool|array $warning_description = false)

{@inheritdoc

Parameters

string|array $warning_title Title of the warning message
string|bool|array $warning_description Description of the warning (and possibly guidelines to resolve it), or false if the warning description is not available

at line 179
public add_log_message(string|array $log_title, string|bool|array $log_description = false)

{@inheritdoc

Parameters

string|array $log_title Title of the log message
string|bool|array $log_description Description of the log, or false if the log description is not available

at line 191
public null add_success_message($error_title, $error_description = false)

{@inheritdoc

Parameters

$error_title
$error_description

Return Value

null

at line 209
public set_task_count(int $task_count, bool $restart = false)

Sets the number of tasks belonging to the installer in the current mode.

Parameters

int $task_count Number of tasks
bool $restart Whether or not to restart the progress bar, false by default

at line 246
public set_progress(string $task_lang_key, int $task_number)

Sets the progress information

Parameters

string $task_lang_key Language key for the name of the task
int $task_number Position of the current task in the task queue

at line 264
public finish_progress(string $message_lang_key)

Finish the progress bar

Parameters

string $message_lang_key Language key for the message

in iohandler_base at line 175
public string generate_form_render_data(string $title, array $form)

Returns the rendering information for the form

Parameters

string $title Language variable with the title of the form
array $form An array describing the required data (options etc)

Return Value

string Information to render the form

at line 51
public set_style(OutputStyle $style, OutputInterface $output)

Set the style and output used to display feedback;

Parameters

OutputStyle $style
OutputInterface $output

at line 60
public mixed get_input(string $name, mixed $default, bool $multibyte = false)

Returns input variable

Parameters

string $name Name of the input variable to obtain
mixed $default A default value that is returned if the variable was not set. This function will always return a value of the same type as the default.
bool $multibyte If $default is a string this paramater has to be true if the variable may contain any UTF-8 characters Default is false, causing all bytes outside the ASCII range (0-127) to be replaced with question marks

Return Value

mixed Value of the input variable

at line 80
public mixed get_raw_input(string $name, mixed $default)

Returns raw input variable

Parameters

string $name Name of the input variable to obtain
mixed $default A default value that is returned if the variable was not set. This function will always return a value of the same type as the default.

Return Value

mixed Value of the raw input variable

at line 91
public set_input(string $name, mixed $value)

Set input variable

Parameters

string $name Name of input variable
mixed $value Value of input variable

at line 99
public mixed get_server_variable(string $name, mixed $default = '')

Returns server variable

This function should work the same as request_interface::server().

Parameters

string $name Name of the server variable
mixed $default Default value to return when the requested variable does not exist

Return Value

mixed Value of the server variable

at line 107
public mixed get_header_variable(string $name, mixed $default = '')

Wrapper function for request_interface::header()

Parameters

string $name Name of the request header variable
mixed $default Default value to return when the requested variable does not exist

Return Value

mixed

at line 115
public bool is_secure()

Returns true if the connection is encrypted

Return Value

bool

at line 123
public add_user_form_group(string $title, array $form)

Adds a requested data group to the rendering queue

Parameters

string $title Language variable with the title of the form
array $form An array describing the required data (options etc)

at line 131
public send_response(bool $no_more_output = false)

Renders or returns response message

Parameters

bool $no_more_output Whether or not there will be more output in this output unit

at line 278
public request_refresh()

Sends refresh request to the client

at line 285
public set_active_stage_menu(array $menu_path)

Marks stage as active in the navigation bar

Parameters

array $menu_path Array to the navigation elem

at line 292
public set_finished_stage_menu(array $menu_path)

Marks stage as completed in the navigation bar

Parameters

array $menu_path Array to the navigation elem

Sends and sets cookies

Parameters

string $cookie_name Name of the cookie to set
string $cookie_value Value of the cookie to set

Adds a download link

Parameters

string $route Route for the link
string $title Language key for the title
string|null|array $msg Language key for the message

at line 313
public render_update_file_status(array $status_array)

Renders the status of update files

Parameters

array $status_array Array containing files in groups to render

at line 320
public redirect(string $url, bool $use_ajax = false)

Redirects the user to a new page

Parameters

string $url URL to redirect to
bool $use_ajax Whether or not to use AJAX redirect