ProgressBar
in package
FinalYes
Индикатор выполнения (прогресс-бар) для длительных операций.
Перерисовывается на месте (возврат каретки \r): показывает заполненную
долю, проценты и счётчик текущее/всего. По завершении переводит строку.
Table of Contents
Methods
- __construct() : mixed
- advance() : void
- Продвинуть индикатор на несколько шагов и перерисовать.
- finish() : void
- Завершить индикатор (заполнить до конца) и перевести строку.
- isFinished() : bool
- Завершён ли индикатор.
Methods
__construct()
public
__construct(Writer $output, int $total[, int $width = 30 ]) : mixed
Parameters
- $output : Writer
-
приёмник вывода
- $total : int
-
общее число шагов (> 0)
- $width : int = 30
-
ширина полосы в символах (> 0)
Tags
advance()
Продвинуть индикатор на несколько шагов и перерисовать.
public
advance([int $step = 1 ]) : void
Parameters
- $step : int = 1
-
число шагов (> 0)
Tags
finish()
Завершить индикатор (заполнить до конца) и перевести строку.
public
finish() : void
isFinished()
Завершён ли индикатор.
public
isFinished() : bool
Return values
bool —true, если вызван finish()