[ Index ]

PHP Cross Reference of phpBB-3.3.7-deutsch

title

Body

[close]

/phpbb/install/helper/iohandler/ -> iohandler_interface.php (summary)

This file is part of the phpBB Forum Software package.

Copyright: (c) phpBB Limited
License: GNU General Public License, version 2 (GPL-2.0)
File Size: 222 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

iohandler_interface:: (22 methods):
  send_response()
  get_input()
  get_raw_input()
  get_server_variable()
  get_header_variable()
  is_secure()
  add_error_message()
  add_warning_message()
  add_log_message()
  add_success_message()
  add_user_form_group()
  generate_form_render_data()
  set_task_count()
  set_progress()
  request_refresh()
  set_active_stage_menu()
  set_finished_stage_menu()
  finish_progress()
  add_download_link()
  redirect()
  render_update_file_status()
  set_cookie()


Interface: iohandler_interface  - X-Ref

Input-Output handler interface for the installer

send_response($no_more_output = false)   X-Ref
Renders or returns response message

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

get_input($name, $default, $multibyte = false)   X-Ref
Returns input variable

param: string    $name        Name of the input variable to obtain
param: mixed        $default    A default value that is returned if the variable was not set.
param: bool        $multibyte    If $default is a string this parameter has to be true if the variable may contain any UTF-8 characters
return: mixed    Value of the input variable

get_raw_input($name, $default)   X-Ref
Returns raw input variable

param: string    $name        Name of the input variable to obtain
param: mixed        $default    A default value that is returned if the variable was not set.
return: mixed    Value of the raw input variable

get_server_variable($name, $default = '')   X-Ref
Returns server variable

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

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

get_header_variable($name, $default = '')   X-Ref
Wrapper function for request_interface::header()

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

is_secure()   X-Ref
Returns true if the connection is encrypted

return: bool

add_error_message($error_title, $error_description = false)   X-Ref
Adds an error message to the rendering queue

Note: When an array is passed into the parameters below, it will be
resolved as printf($param[0], $param[1], ...).

param: string|array        $error_title        Title of the error message.
param: string|bool|array    $error_description    Description of the error (and possibly guidelines to resolve it),

add_warning_message($warning_title, $warning_description = false)   X-Ref
Adds a warning message to the rendering queue

Note: When an array is passed into the parameters below, it will be
resolved as printf($param[0], $param[1], ...).

param: string|array        $warning_title            Title of the warning message
param: string|bool|array    $warning_description    Description of the warning (and possibly guidelines to resolve it),

add_log_message($log_title, $log_description = false)   X-Ref
Adds a log message to the rendering queue

Note: When an array is passed into the parameters below, it will be
resolved as printf($param[0], $param[1], ...).

param: string|array        $log_title            Title of the log message
param: string|bool|array    $log_description    Description of the log,

add_success_message($success_title, $success_description = false)   X-Ref
Adds a success message to the rendering queue

Note: When an array is passed into the parameters below, it will be
resolved as printf($param[0], $param[1], ...).

param: string|array        $success_title            Title of the success message
param: string|bool|array    $success_description    Description of the success,
return: null

add_user_form_group($title, $form)   X-Ref
Adds a requested data group to the rendering queue

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

generate_form_render_data($title, $form)   X-Ref
Returns the rendering information for the form

param: string    $title    Language variable with the title of the form
param: array        $form    An array describing the required data (options etc)
return: string    Information to render the form

set_task_count($task_count, $restart = false)   X-Ref
Sets the number of tasks belonging to the installer in the current mode.

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

set_progress($task_lang_key, $task_number)   X-Ref
Sets the progress information

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

request_refresh()   X-Ref
Sends refresh request to the client


set_active_stage_menu($menu_path)   X-Ref
Marks stage as active in the navigation bar

param: array    $menu_path    Array to the navigation elem

set_finished_stage_menu($menu_path)   X-Ref
Marks stage as completed in the navigation bar

param: array    $menu_path    Array to the navigation elem

finish_progress($message_lang_key)   X-Ref
Finish the progress bar

param: string    $message_lang_key    Language key for the message

add_download_link($route, $title, $msg = null)   X-Ref
Adds a download link

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

redirect($url, $use_ajax = false)   X-Ref
Redirects the user to a new page

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

render_update_file_status($status_array)   X-Ref
Renders the status of update files

param: array    $status_array    Array containing files in groups to render

set_cookie($cookie_name, $cookie_value)   X-Ref
Sends and sets cookies

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



Generated: Thu Mar 24 21:31:15 2022 Cross-referenced by PHPXref 0.7.1