ProgressBar

__construct(OutputInterface $output, int $max = 0)

Параметры

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

static void setPlaceholderFormatterDefinition(string $name, callable $callable)

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

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

Параметры

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

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

void

static callable|null getPlaceholderFormatterDefinition(string $name)

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

Параметры

string

$name

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

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

callable|null

Вызываемый фрагмент PHP

static void setFormatDefinition(string $name, string $format)

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

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

Параметры

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

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

void

static string|null getFormatDefinition(string $name)

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

Параметры

string

$name

Имя формата

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

string|null

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

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

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

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

Параметры

string	$message	Текст для связи с заполнителем
string	$name	Имя заполнителя

getMessage(string $name = 'message')

Параметры

string

$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 $freq)

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

Параметры

int

$freq

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

start(int $max = null)

Запускает вывод прогресса.

Параметры

int

$max

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

advance(int $step = 1)

Увеличивает вывод прогресса на X шагов.

Параметры

int

$step

Количество шагов для увеличения

setOverwrite(bool $overwrite)

Устанавливает, нужно ли перезаписывать полосу прогресса, false — новая строка.

Параметры

bool

$overwrite

setProgress(int $step)

Параметры

int

$step

setMaxSteps(int $max)

Параметры

int

$max

void finish()

Завершает вывод прогресса.

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

void

void display()

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

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

void

void clear()

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

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

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

void