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 getStep() ^{устаревший}

^{устаревший}

с версия 2.6, будет удален в 3.0. Используйте {@link getProgress()} вместо этого.

Получает шаг полосы прогресса.

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

int	Шаг полосы прогресса

int getProgress()

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

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

int	Шаг полосы прогресса

int getStepWidth()

Получает ширину шага полосы прогресса.

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

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

setCurrent(int $step) ^{устаревший}

^{устаревший}

с версия 2.6, будет удален в 3.0. Используйте {@link setProgress()} вместо этого.

Устанавливает текущую позицию.

Параметры

int

$step

Текущая позиция

Исключения

LogicException

setOverwrite(bool $overwrite)

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

Параметры

bool

$overwrite

setProgress(int $step)

Устанавливает текущую позицию.

Параметры

int

$step

Текущая позиция

Исключения

LogicException

finish()

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

display()

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

clear()

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

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