ProgressBar

__construct(OutputInterface $output, int $max)

Конструктор.

Параметры

OutputInterface	$output	Экземпляр OutputInterface
int	$max	Максимальное количество шагов (0, если неизвестно)

static setPlaceholderFormatterDefinition(string $name, callable $callable)

Устанавливает обработчик подстановочных значений для данного имени.

Этот метод также позволяет переопределить существующий обработчик.

Параметры

string	$name	Имя подстановочного значения (включая разделитель, например, %)
callable	$callable	PHP-вызов

static callable|null getPlaceholderFormatterDefinition(string $name)

Получает обработчик подстановочных значений для данного имени.

Параметры

string

$name

Имя подстановочного значения (включая разделитель, например, %)

Возвращаемое значение

callable|null

PHP-вызов

static setFormatDefinition(string $name, string $format)

Устанавливает формат для данного имени.

Этот метод также позволяет переопределить существующий формат.

Параметры

string	$name	Имя формата
string	$format	Строка формата

static string|null getFormatDefinition(string $name)

Получает формат для данного имени.

Параметры

string

$name

Имя формата

Возвращаемое значение

string|null

Строка формата

setMessage($message, $name = 'message')

Параметры

	$message
	$name

getMessage($name = 'message')

Параметры

$name

int getStartTime()

Получает время начала индикатора выполнения.

Возвращаемое значение

int	Время начала индикатора выполнения

int getMaxSteps()

Получает максимальное количество шагов индикатора выполнения.

Возвращаемое значение

int	Максимальное количество шагов индикатора выполнения

int getProgress()

Получает текущую позицию шага.

Возвращаемое значение

int	Текущий шаг индикатора выполнения

float getProgressPercent()

Получает текущий процент выполнения.

Возвращаемое значение

float

Текущий процент выполнения

setBarWidth(int $size)

Устанавливает ширину полосы индикатора выполнения.

Параметры

int

$size

Ширина полосы индикатора выполнения

int getBarWidth()

Получает ширину полосы индикатора выполнения.

Возвращаемое значение

int	Ширина полосы индикатора выполнения

setBarCharacter(string $char)

Устанавливает символ полосы индикатора выполнения.

Параметры

string

$char

Символ

string getBarCharacter()

Получает символ полосы индикатора выполнения.

Возвращаемое значение

string

Символ

setEmptyBarCharacter(string $char)

Устанавливает символ пустой части полосы индикатора выполнения.

Параметры

string

$char

Символ

string getEmptyBarCharacter()

Получает символ пустой части полосы индикатора выполнения.

Возвращаемое значение

string

Символ

setProgressCharacter(string $char)

Устанавливает символ текущей позиции полосы индикатора выполнения.

Параметры

string

$char

Символ

string getProgressCharacter()

Получает символ текущей позиции полосы индикатора выполнения.

Возвращаемое значение

string

Символ

setFormat(string $format)

Устанавливает формат полосы индикатора выполнения.

Параметры

string

$format

Формат

setRedrawFrequency(int|float $freq)

Устанавливает частоту перерисовки.

Параметры

int|float

$freq

Частота в шагах

start(int|null $max = null)

Запускает вывод индикатора выполнения.

Параметры

int|null

$max

Количество шагов для завершения полосы (0 — неопределенно), null — оставить без изменений

advance(int $step = 1)

Перемещает индикатор выполнения на X шагов.

Параметры

int

$step

Количество шагов для перемещения

Исключения

LogicException

setOverwrite(bool $overwrite)

Устанавливает, перезаписывать ли индикатор выполнения, false для новой строки.

Параметры

bool

$overwrite

setProgress(int $step)

Устанавливает текущее значение прогресса.

Параметры

int

$step

Текущее значение прогресса

Исключения

LogicException

finish()

Завершает вывод индикатора выполнения.

display()

Выводит текущую строку прогресса.

clear()

Удаляет индикатор выполнения из текущей строки.

Это полезно, если вы хотите вывести некоторые данные, пока индикатор выполнения работает. Вызовите display(), чтобы снова отобразить индикатор выполнения.