siteworxpro/cli-progress-bar

Cli progress bar

cli-progress-bar

Progress bar for cli apps, _(*1)

Forked From dariuszp/cli-progress-bar, _(*2)

, _(*3)

Installation

composer require siteworx/cli-progress-bar

Usage

use Siteworx\ProgressBar\CliProgressBar;
$bar = new CliProgressBar(10, 5);
$bar->display();
$bar->end();

Code above will show half full progress bar:, _(*4)

▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░░░░░░░░░░░░░ 50.0% (5/10)

Windows can't handle some UTF characters so there is an alternate method to display progress bar:, _(*5)

use  Siteworx\ProgressBar\CliProgressBar;
$bar = new CliProgressBar();
$bar->displayAlternateProgressBar(); // this only switch style

$bar->display();
$bar->end();

Output will be:, _(*6)

XXXX____________________________________ 10.0% (10/100)

Add text to the progress bar using the following methods, _(*7)

use Siteworx\ProgressBar\CliProgressBar;
$bar = new CliProgressBar(50, 0, "My Custom Text");
$bar->display();
$bar->end();

or, _(*8)

use Siteworx\ProgressBar\CliProgressBar;
$bar = new CliProgressBar();
$bar->setDetails("My Custom Text");
$bar->display();
$bar->end();

Estimated time to completion is available. At least 2 iterations are required to calculate an ET.
The more iterations the better the estimate calculation will be., _(*9)

use Siteworx\ProgressBar\CliProgressBar;
$bar = new CliProgressBar();
$bar->displayTimeRemaining()->display();
$bar->end();

will output, _(*10)

▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░░░░░░░░░░░░░ 50.0% (5/10) 02:14

Also update asynchronously with setDetails(), _(*11)

More features like: - changing progress bar length (basicWithShortBar.php) - changing bar color (colors.php) - animation example (basic.php) - etc..., _(*12)

in example directory., _(*13)

Author: Półtorak Dariusz Contributors: @mathmatrix828 - Mason Phillips, _(*14)

License: MIT, _(*15)