PHP Class phpbb\install\helper\iohandler\cli_iohandler

Inheritance: extends iohandler_base
Mostra file Open project: phpbb/phpbb Class Usage Examples

Protected Properties

Property Type Description
$input_values array
$io Symfony\Component\Console\Style\OutputStyle
$output Symfony\Component\Console\Output\OutputInterface
$progress_bar Symfony\Component\Console\Helper\ProgressBar

Public Methods

Method Description
add_download_link ( $route, $title, $msg = null )
add_error_message ( $error_title, $error_description = false ) {@inheritdoc
add_log_message ( $log_title, $log_description = false ) {@inheritdoc
add_success_message ( $error_title, $error_description = false ) {@inheritdoc
add_user_form_group ( $title, $form )
add_warning_message ( $warning_title, $warning_description = false ) {@inheritdoc
finish_progress ( $message_lang_key )
get_header_variable ( $name, $default = '' )
get_input ( $name, $default, $multibyte = false )
get_raw_input ( $name, $default )
get_server_variable ( $name, $default = '' )
is_secure ( )
redirect ( $url, $use_ajax = false )
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_input ( string $name, mixed $value ) Set input variable
set_progress ( $task_lang_key, $task_number )
set_style ( Symfony\Component\Console\Style\OutputStyle $style, Symfony\Component\Console\Output\OutputInterface $output ) Set the style and output used to display feedback;
set_task_count ( $task_count, $restart = false )

Method Details

add_error_message() public method

{@inheritdoc
public add_error_message ( $error_title, $error_description = false )

add_log_message() public method

{@inheritdoc
public add_log_message ( $log_title, $log_description = false )

add_success_message() public method

{@inheritdoc
public add_success_message ( $error_title, $error_description = false )

add_user_form_group() public method

public add_user_form_group ( $title, $form )

add_warning_message() public method

{@inheritdoc
public add_warning_message ( $warning_title, $warning_description = false )

finish_progress() public method

public finish_progress ( $message_lang_key )

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 ( )

redirect() public method

public redirect ( $url, $use_ajax = false )

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_finished_stage_menu() public method

public set_finished_stage_menu ( $menu_path )

set_input() public method

Set input variable
public set_input ( string $name, mixed $value )
$name string Name of input variable
$value mixed Value of input variable

set_progress() public method

public set_progress ( $task_lang_key, $task_number )

set_style() public method

Set the style and output used to display feedback;
public set_style ( Symfony\Component\Console\Style\OutputStyle $style, Symfony\Component\Console\Output\OutputInterface $output )
$style Symfony\Component\Console\Style\OutputStyle
$output Symfony\Component\Console\Output\OutputInterface

set_task_count() public method

public set_task_count ( $task_count, $restart = false )

Property Details

$input_values protected_oe property

protected array $input_values
return array

$io protected_oe property

protected OutputStyle,Symfony\Component\Console\Style $io
return Symfony\Component\Console\Style\OutputStyle

$output protected_oe property

protected OutputInterface,Symfony\Component\Console\Output $output
return Symfony\Component\Console\Output\OutputInterface

$progress_bar protected_oe property

protected ProgressBar,Symfony\Component\Console\Helper $progress_bar
return Symfony\Component\Console\Helper\ProgressBar