progress
in
Cli progress bar object
Table of Contents
LINE_MAX_CHARS | 80 | |
---|---|---|
PROGRESS_CHAR | '#' | |
$maxValue | Maxmimum progress value | int |
$currentValue | Current value used to calculate char output | int |
$isCli | Cli flag | bool |
__construct() | Constructor | mixed |
setCurrentValue() | Update current value for calculation | $this |
output() | Show progress output | bool |
Constants
LINE_MAX_CHARS
mixed
$LINE_MAX_CHARS
= 80
PROGRESS_CHAR
mixed
$PROGRESS_CHAR
= '#'
Properties
$maxValue
Maxmimum progress value
private
int
$maxValue
= ""
$currentValue
Current value used to calculate char output
private
int
$currentValue
= ""
$isCli
Cli flag
private
bool
$isCli
= true
Methods
__construct()
Constructor
public
__construct(
$maxValue :
int
, $currentValue :
int
)
: mixed
Parameters
- $maxValue : int
- $currentValue : int
Return values
mixedsetCurrentValue()
Update current value for calculation
public
setCurrentValue(
$currentValue :
int
)
: $this
Parameters
- $currentValue : int
Return values
$thisoutput()
Show progress output
public
output(
)
: bool