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(string $message, string $name = 'message')

Связывает текст с именованным заполнителем.

Текст отображается при отрисовке полосы прогресса, но только если соответствующий заполнитель является частью пользовательской строки формата (обернув имя в %).

Параметры

string	$message	Текст для связи с заполнителем
string	$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(), чтобы снова показать полосу прогресса.