Documentation

progress
in package

Cli progress bar object

Tags
author

Stefan Seehafer sea75300@yahoo.de

author

mayconbordin, https://gist.github.com/mayconbordin

copyright

(c) 2011-2020, Stefan Seehafer

license

http://www.gnu.org/licenses/gpl.txt GPLv3

since
4.4-b5

Table of Contents

PROGRESS_CHAR  = '#'
$currentValue  : int
Current value used to calculate char output
$isCli  : bool
Cli flag
$maxLineChars  : int
Maximum chars for one cli line
$maxValue  : int
Maxmimum progress value
$outputText  : string
Output text
__construct()  : mixed
Constructor
output()  : bool
Show progress output
setCurrentValue()  : $this
Update current value for calculation
setOutputText()  : $this
Set output text for cli

Constants

PROGRESS_CHAR

public mixed PROGRESS_CHAR = '#'

Properties

$currentValue

Current value used to calculate char output

private int $currentValue = 0

$isCli

Cli flag

private bool $isCli = true

$maxLineChars

Maximum chars for one cli line

private int $maxLineChars = 70

$maxValue

Maxmimum progress value

private int $maxValue = 0

$outputText

Output text

private string $outputText = ''

Methods

__construct()

Constructor

public __construct(int $maxValue, int $currentValue) : mixed
Parameters
$maxValue : int
$currentValue : int
Return values
mixed

output()

Show progress output

public output() : bool
Return values
bool

setCurrentValue()

Update current value for calculation

public setCurrentValue(int $currentValue) : $this
Parameters
$currentValue : int
Return values
$this

setOutputText()

Set output text for cli

public setOutputText(string $outputText) : $this
Parameters
$outputText : string
Return values
$this

Search results