PHP Class phpbb\install\helper\iohandler\iohandler_base

Inheritance: implements phpbb\install\helper\iohandler\iohandler_interface
Datei anzeigen Open project: phpbb/phpbb Class Usage Examples

Protected Properties

Property Type Description
$current_task_name string
$current_task_progress integer
$errors array Errors should be added, when the installation cannot continue without user interaction. If the aim is to notify the user about something, please use a warning instead.
$language phpbb\language\language
$logs array Array of logs
$restart_progress_bar boolean
$success array Array of success messages
$task_progress_count integer
$warnings array Array of warnings

Public Methods

Method Description
__construct ( ) Constructor
add_error_message ( $error_title, $error_description = false )
add_log_message ( $log_title, $log_description = false )
add_success_message ( $success_title, $success_description = false )
add_warning_message ( $warning_title, $warning_description = false )
finish_progress ( $message_lang_key )
generate_form_render_data ( $title, $form )
set_language ( phpbb\language\language $language ) Set language service
set_progress ( $task_lang_key, $task_number )
set_task_count ( $task_count, $restart = false )

Protected Methods

Method Description
translate_message ( array | string $title, array | string | boolean $description ) : array Localize message.

Method Details

__construct() public method

Constructor
public __construct ( )

add_error_message() public method

public add_error_message ( $error_title, $error_description = false )

add_log_message() public method

public add_log_message ( $log_title, $log_description = false )

add_success_message() public method

public add_success_message ( $success_title, $success_description = false )

add_warning_message() public method

public add_warning_message ( $warning_title, $warning_description = false )

finish_progress() public method

public finish_progress ( $message_lang_key )

generate_form_render_data() public method

public generate_form_render_data ( $title, $form )

set_language() public method

Set language service
public set_language ( phpbb\language\language $language )
$language phpbb\language\language

set_progress() public method

public set_progress ( $task_lang_key, $task_number )

set_task_count() public method

public set_task_count ( $task_count, $restart = false )

translate_message() protected method

Note: When an array is passed into the parameters below, it will be resolved as printf($param[0], $param[1], ...).
protected translate_message ( array | string $title, array | string | boolean $description ) : array
$title array | string Title of the message
$description array | string | boolean Description of the message
return array Localized message in an array

Property Details

$current_task_name protected_oe property

protected string $current_task_name
return string

$current_task_progress protected_oe property

protected int $current_task_progress
return integer

$errors protected_oe property

Errors should be added, when the installation cannot continue without user interaction. If the aim is to notify the user about something, please use a warning instead.
protected array $errors
return array

$language protected_oe property

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

$logs protected_oe property

Array of logs
protected array $logs
return array

$restart_progress_bar protected_oe property

protected bool $restart_progress_bar
return boolean

$success protected_oe property

Array of success messages
protected array $success
return array

$task_progress_count protected_oe property

protected int $task_progress_count
return integer

$warnings protected_oe property

Array of warnings
protected array $warnings
return array