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(), чтобы снова показать полосу прогресса.