ProgressIndicator
класс ProgressIndicator
Методы
| __construct(OutputInterface $output, string $format = null, int $indicatorChangeInterval = 100, array $indicatorValues = null) | ||
| setMessage(string|null $message) Устанавливает текущее сообщение индикатора. | ||
| start($message) Запускает вывод индикатора. | ||
| advance() Перемещает индикатор вперед. | ||
| finish($message) Завершает индикатор с сообщением. | ||
| static string|null | getFormatDefinition(string $name) Получает формат для данного имени. | |
| static | setPlaceholderFormatterDefinition(string $name, callable $callable) Устанавливает форматировщик заглушки для данного имени. | |
| static callable|null | getPlaceholderFormatterDefinition(string $name) Получает форматировщик заглушки для данного имени. |
Подробности
__construct(OutputInterface $output, string $format = null, int $indicatorChangeInterval = 100, array $indicatorValues = null)
Параметры
| OutputInterface | $output | |
| string | $format | Формат индикатора |
| int | $indicatorChangeInterval | Интервал изменения в миллисекундах |
| array | $indicatorValues | Анимированные символы индикатора |
setMessage(string|null $message)
Устанавливает текущее сообщение индикатора.
Параметры
| string|null | $message |
start($message)
Запускает вывод индикатора.
Параметры
| $message |
advance()
Перемещает индикатор вперед.
finish($message)
Завершает индикатор с сообщением.
Параметры
| $message |
static string|null getFormatDefinition(string $name)
Получает формат для данного имени.
Параметры
| string | $name | Имя формата |
Возвращаемое значение
| string|null | Строка формата |
static setPlaceholderFormatterDefinition(string $name, callable $callable)
Устанавливает форматировщик заглушки для данного имени.
Этот метод также позволяет переопределить существующую заглушку.
Параметры
| string | $name | Имя заглушки (включая символ разделителя, например %) |
| callable | $callable | PHP вызываемый объект |
static callable|null getPlaceholderFormatterDefinition(string $name)
Получает форматировщик заглушки для данного имени.
Параметры
| string | $name | Имя заглушки (включая символ разделителя, например %) |
Возвращаемое значение
| callable|null | PHP вызываемый объект |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Console/Helper/ProgressIndicator.html