PHP Class phpbb\install\helper\iohandler\ajax_iohandler

Inheritance: extends iohandler_base

Protected Properties

Property	Type	Description
$cookies	array
$download	array
$file_lock_pointer	resource
$file_status	string
$form	string
$nav_data	array
$path_helper	phpbb\path_helper
$phpbb_root_path	string
$redirect_url	array
$request	phpbb\request\request_interface
$request_client_refresh	boolean
$router	phpbb\routing\router
$template	phpbb\template\template

Public Methods

Method	Description
__construct ( phpbb\path_helper $path_helper, phpbb\request\request_interface $request, phpbb\template\template $template, router $router, string $root_path )	Constructor
acquire_lock ( )	Acquires a file lock
add_download_link ( $route, $title, $msg = null )
add_user_form_group ( $title, $form )
generate_form_render_data ( $title, $form )
get_header_variable ( $name, $default = '' )
get_input ( $name, $default, $multibyte = false )
get_raw_input ( $name, $default )
get_server_variable ( $name, $default = '' )
is_secure ( )
lang_replace_callback ( array $matches ) : string	Callback function for language replacing
redirect ( $url, $use_ajax = false )
release_lock ( )	Release file lock
render_update_file_status ( $status_array )
request_refresh ( )
send_response ( $no_more_output = false )
set_active_stage_menu ( $menu_path )
set_cookie ( $cookie_name, $cookie_value )
set_finished_stage_menu ( $menu_path )
set_progress ( $task_lang_key, $task_number )

Protected Methods

Method	Description
prepare_json_array ( boolean $no_more_output = false ) : array	Prepares iohandler's data to be sent out to the client.

Method Details

__construct() public method

Constructor

public __construct ( phpbb\path_helper $path_helper, phpbb\request\request_interface $request, phpbb\template\template $template, router $router, string $root_path )
$path_helper	phpbb\path_helper
$request	phpbb\request\request_interface	HTTP request interface
$template	phpbb\template\template	Template engine
$router	phpbb\routing\router	Router
$root_path	string	Path to phpBB's root

acquire_lock() public method

Acquires a file lock

public acquire_lock ( )

add_download_link() public method

public add_download_link ( $route, $title, $msg = null )

add_user_form_group() public method

public add_user_form_group ( $title, $form )

generate_form_render_data() public method

public generate_form_render_data ( $title, $form )

get_header_variable() public method

public get_header_variable ( $name, $default = '' )

get_input() public method

public get_input ( $name, $default, $multibyte = false )

get_raw_input() public method

public get_raw_input ( $name, $default )

get_server_variable() public method

public get_server_variable ( $name, $default = '' )

is_secure() public method

public is_secure ( )

lang_replace_callback() public method

Callback function for language replacing

public lang_replace_callback ( array $matches ) : string
$matches	array
return	string

prepare_json_array() protected method

Prepares iohandler's data to be sent out to the client.

protected prepare_json_array ( boolean $no_more_output = false ) : array
$no_more_output	boolean	Whether or not there will be more output in this response
return	array

redirect() public method

public redirect ( $url, $use_ajax = false )

release_lock() public method

Release file lock

public release_lock ( )

render_update_file_status() public method

public render_update_file_status ( $status_array )

request_refresh() public method

public request_refresh ( )

send_response() public method

public send_response ( $no_more_output = false )

set_active_stage_menu() public method

public set_active_stage_menu ( $menu_path )

set_cookie() public method

public set_cookie ( $cookie_name, $cookie_value )

set_finished_stage_menu() public method

public set_finished_stage_menu ( $menu_path )

set_progress() public method

public set_progress ( $task_lang_key, $task_number )

Property Details

$cookies protected_oe property

protected array $cookies
return	array

$download protected_oe property

protected array $download
return	array

$file_lock_pointer protected_oe property

protected resource $file_lock_pointer
return	resource

$file_status protected_oe property

protected string $file_status
return	string

$form protected_oe property

protected string $form
return	string

$nav_data protected_oe property

protected array $nav_data
return	array

$path_helper protected_oe property

protected path_helper,phpbb $path_helper
return	phpbb\path_helper

$phpbb_root_path protected_oe property

protected string $phpbb_root_path
return	string

$redirect_url protected_oe property

protected array $redirect_url
return	array

$request protected_oe property

protected request_interface,phpbb\request $request
return	phpbb\request\request_interface

$request_client_refresh protected_oe property

protected bool $request_client_refresh
return	boolean

$router protected_oe property

protected router,phpbb\routing $router
return	phpbb\routing\router

$template protected_oe property

protected template,phpbb\template $template
return	phpbb\template\template