| Метод | Описание | |
|---|---|---|
| add_download_link ( string $route, string $title, string | null | array $msg = null ) | Adds a download link | |
| add_error_message ( string | array $error_title, string | boolean | array $error_description = false ) | Adds an error message to the rendering queue | |
| add_log_message ( string | array $log_title, string | boolean | array $log_description = false ) | Adds a log message to the rendering queue | |
| add_success_message ( string | array $success_title, string | boolean | array $success_description = false ) : null | Adds a success message to the rendering queue | |
| add_user_form_group ( string $title, array $form ) | Adds a requested data group to the rendering queue | |
| add_warning_message ( string | array $warning_title, string | boolean | array $warning_description = false ) | Adds a warning message to the rendering queue | |
| finish_progress ( string $message_lang_key ) | Finish the progress bar | |
| generate_form_render_data ( string $title, array $form ) : string | Returns the rendering information for the form | |
| get_header_variable ( string $name, mixed $default = '' ) : mixed | Wrapper function for request_interface::header() | |
| get_input ( string $name, mixed $default, boolean $multibyte = false ) : mixed | Returns input variable | |
| get_raw_input ( string $name, mixed $default ) : mixed | Returns raw input variable | |
| get_server_variable ( string $name, mixed $default = '' ) : mixed | Returns server variable | |
| is_secure ( ) : boolean | Returns true if the connection is encrypted | |
| redirect ( string $url, boolean $use_ajax = false ) | Redirects the user to a new page | |
| render_update_file_status ( array $status_array ) | Renders the status of update files | |
| request_refresh ( ) | Sends refresh request to the client | |
| send_response ( boolean $no_more_output = false ) | Renders or returns response message | |
| set_active_stage_menu ( array $menu_path ) | Marks stage as active in the navigation bar | |
| set_cookie ( string $cookie_name, string $cookie_value ) | Sends and sets cookies | |
| set_finished_stage_menu ( array $menu_path ) | Marks stage as completed in the navigation bar | |
| set_progress ( string $task_lang_key, integer $task_number ) | Sets the progress information | |
| set_task_count ( integer $task_count, boolean $restart = false ) | Sets the number of tasks belonging to the installer in the current mode. |
| public add_error_message ( string | array $error_title, string | boolean | array $error_description = false ) | ||
| $error_title | string | array | Title of the error message. |
| $error_description | string | boolean | array | Description of the error (and possibly guidelines to resolve it), or false if the error description is not available. |
| public add_success_message ( string | array $success_title, string | boolean | array $success_description = false ) : null | ||
| $success_title | string | array | Title of the success message |
| $success_description | string | boolean | array | Description of the success, or false if the success description is not available |
| Результат | null | |
| public add_user_form_group ( string $title, array $form ) | ||
| $title | string | Language variable with the title of the form |
| $form | array | An array describing the required data (options etc) |
| public add_warning_message ( string | array $warning_title, string | boolean | array $warning_description = false ) | ||
| $warning_title | string | array | Title of the warning message |
| $warning_description | string | boolean | array | Description of the warning (and possibly guidelines to resolve it), or false if the warning description is not available |
| public finish_progress ( string $message_lang_key ) | ||
| $message_lang_key | string | Language key for the message |
| public get_input ( string $name, mixed $default, boolean $multibyte = false ) : mixed | ||
| $name | string | Name of the input variable to obtain |
| $default | mixed | 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. |
| $multibyte | boolean | 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 |
| Результат | mixed | Value of the input variable |
| public get_raw_input ( string $name, mixed $default ) : mixed | ||
| $name | string | Name of the input variable to obtain |
| $default | mixed | 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. |
| Результат | mixed | Value of the raw input variable |
| public render_update_file_status ( array $status_array ) | ||
| $status_array | array | Array containing files in groups to render |
| public send_response ( boolean $no_more_output = false ) | ||
| $no_more_output | boolean | Whether or not there will be more output in this output unit |
| public set_cookie ( string $cookie_name, string $cookie_value ) | ||
| $cookie_name | string | Name of the cookie to set |
| $cookie_value | string | Value of the cookie to set |
| public set_progress ( string $task_lang_key, integer $task_number ) | ||
| $task_lang_key | string | Language key for the name of the task |
| $task_number | integer | Position of the current task in the task queue |
| public set_task_count ( integer $task_count, boolean $restart = false ) | ||
| $task_count | integer | Number of tasks |
| $restart | boolean | Whether or not to restart the progress bar, false by default |
