kas-cor/console-progress-bar

Console progress bar

0.0.6 2021-09-30 07:33 UTC

Requires

• php: >=7.2.0
• composer-runtime-api: ^2.0

MIT

• kas-cor

• console
• progress
• bar

README

Screenshots (default config)

In process

Finish report

Install

composer require kas-cor/console-progress-bar

Usage

Default config

use KasCor\ConsoleProgressBar;

$progressBar = new ConsoleProgressBar(5);

foreach (range(1, 5) as $current_position) {
    $progressBar->output($current_position, 'message');
    sleep(1);
}

Other config

use KasCor\ConsoleProgressBar;

$progressBar = new ConsoleProgressBar(5, [
    'showFinishReport' => false,
]);

foreach (range(1, 5) as $current_position) {
    $progressBar->output($current_position, 'message');
    sleep(1);
}

Config

Property	Type	Description	Default
showTimeMessage	boolean	Show time before message	True
showBar	boolean	Show progress bar	True
showCurrentPosition	boolean	Show current position	True
showSpinner	boolean	Show spinner	True
showPercent	boolean	Show percent progress	True
showPassedTime	boolean	Show passed time	True
showEstimatedTime	boolean	Show estimated time	True
showFinishReport	boolean	Show finish report	True
timeMessageFormat	string	Format date/time before message, PHP format	d.m.Y H:i:s
progressBarSize	integer	Size progress bar	50
progressBarFullChar	string	Char full in progress bar	#
progressBarEmptyChar	string	Char empty in progress bar	.
spinnerChars	array	Chars spinner animation
separator	string	Separator elements	-
orderElements	array	Order elements	spinner, progress_bar, current_position, percent, passed_time, estimated_time