ProgressBar - staffcheck/api GitHub Wiki

ProgressBar

  • Class name: ProgressBar
  • Namespace:

Properties

$obj

protected mixed $obj = NULL
  • Visibility: protected

$default_key

public mixed $default_key = NULL
  • Visibility: public

$key_prefix

private mixed $key_prefix = 'progress_bar_'
  • Visibility: private

$update_iteration

public mixed $update_iteration = 1
  • Visibility: public

$update_interval

public mixed $update_interval = 30
  • Visibility: public

$last_update_time

private mixed $last_update_time = NULL
  • Visibility: private

Methods

__construct

mixed ProgressBar::__construct()

ProgressBar constructor.

  • Visibility: public

setDefaultKey

mixed ProgressBar::setDefaultKey($key)
  • Visibility: public

Arguments

  • $key mixed

getDefaultKey

null ProgressBar::getDefaultKey()
  • Visibility: public

error

boolean ProgressBar::error($key, null $msg)
  • Visibility: public

Arguments

  • $key mixed
  • $msg null

start

boolean ProgressBar::start($key, integer $total_iterations, integer $update_iteration, null $msg)
  • Visibility: public

Arguments

  • $key mixed
  • $total_iterations integer
  • $update_iteration integer - EPOCH
  • $msg null

delete

boolean ProgressBar::delete($key)
  • Visibility: public

Arguments

  • $key mixed

stop

boolean ProgressBar::stop($key)
  • Visibility: public

Arguments

  • $key mixed

set

boolean ProgressBar::set($key, $current_iteration, null $msg)
  • Visibility: public

Arguments

  • $key mixed
  • $current_iteration mixed
  • $msg null

get

boolean ProgressBar::get($key)
  • Visibility: public

Arguments

  • $key mixed

test

boolean ProgressBar::test($key, integer $total_iterations)
  • Visibility: public

Arguments

  • $key mixed
  • $total_iterations integer
⚠️ **GitHub.com Fallback** ⚠️