ProgressHelper устаревший
class ProgressHelper extends Helper
устаревший
Класс Progress предоставляет помощники для отображения выходных данных прогресса.
Постоянные значения
| FORMAT_QUIET | |
| FORMAT_NORMAL | |
| FORMAT_VERBOSE | |
| FORMAT_QUIET_NOMAX | |
| FORMAT_NORMAL_NOMAX | |
| FORMAT_VERBOSE_NOMAX |
Методы
| setHelperSet(HelperSet $helperSet = null) Устанавливает набор помощников, связанных с этим помощником. | from Helper | |
| HelperSet | getHelperSet() Возвращает набор помощников, связанных с этим помощником. | from Helper |
| static int | strlen(string $string) Возвращает длину строки, используя mb_strwidth, если он доступен. | from Helper |
| static | formatTime($secs) | from Helper |
| static | formatMemory($memory) | from Helper |
| static | strlenWithoutDecoration(OutputFormatterInterface $formatter, $string) | from Helper |
| __construct($triggerDeprecationError = true) | ||
| setBarWidth(int $size) Устанавливает ширину полосы прогресса. | ||
| setBarCharacter(string $char) Устанавливает символ полосы прогресса. | ||
| setEmptyBarCharacter(string $char) Устанавливает символ пустой полосы прогресса. | ||
| setProgressCharacter(string $char) Устанавливает символ заполненной полосы прогресса. | ||
| setFormat(string $format) Устанавливает формат полосы прогресса. | ||
| setRedrawFrequency(int $freq) Устанавливает частоту перерисовки. | ||
| start(OutputInterface $output, int|null $max = null) Запускает вывод прогресса. | ||
| advance(int $step = 1, bool $redraw = false) Увеличивает прогресс на X шагов. | ||
| setCurrent(int $current, bool $redraw = false) Устанавливает текущий прогресс. | ||
| display(bool $finish = false) Выводит текущую строку прогресса. | ||
| clear() Удаляет полосу прогресса из текущей строки. | ||
| finish() Завершает вывод прогресса. | ||
| string | getName() Возвращает каноническое имя этого помощника. |
Подробности
setHelperSet(HelperSet $helperSet = null)
Устанавливает набор помощников, связанных с этим помощником.
Параметры
| HelperSet | $helperSet | Экземпляр HelperSet |
HelperSet getHelperSet()
Получает набор помощников, связанных с этим помощником.
Возвращаемое значение
| HelperSet | Экземпляр HelperSet |
static int strlen(string $string)
Возвращает длину строки, используя mb_strwidth, если он доступен.
Параметры
| string | $string | Строка, для которой необходимо проверить длину |
Возвращаемое значение
| int | Длина строки |
static formatTime($secs)
Параметры
| $secs |
static formatMemory($memory)
Параметры
| $memory |
static strlenWithoutDecoration(OutputFormatterInterface $formatter, $string)
Параметры
| OutputFormatterInterface | $formatter | |
| $string |
__construct($triggerDeprecationError = true)
Параметры
| $triggerDeprecationError |
setBarWidth(int $size)
Устанавливает ширину полосы прогресса.
Параметры
| int | $size | Размер полосы прогресса |
setBarCharacter(string $char)
Устанавливает символ полосы прогресса.
Параметры
| string | $char | Символ |
setEmptyBarCharacter(string $char)
Устанавливает символ пустой части полосы прогресса.
Параметры
| string | $char | Символ |
setProgressCharacter(string $char)
Устанавливает символ полосы прогресса.
Параметры
| string | $char | Символ |
setFormat(string $format)
Устанавливает формат полосы прогресса.
Параметры
| string | $format | Формат |
setRedrawFrequency(int $freq)
Устанавливает частоту перерисовки.
Параметры
| int | $freq | Частота в шагах |
start(OutputInterface $output, int|null $max = null)
Запускает вывод прогресса.
Параметры
| OutputInterface | $output | Экземпляр Output |
| int|null | $max | Максимальное количество шагов |
advance(int $step = 1, bool $redraw = false)
Перемещает вывод прогресса на X шагов.
Параметры
| int | $step | Количество шагов для перемещения |
| bool | $redraw | Перерисовать или нет |
Исключения
| LogicException |
setCurrent(int $current, bool $redraw = false)
Устанавливает текущий прогресс.
Параметры
| int | $current | Текущий прогресс |
| bool | $redraw | Перерисовать или нет |
Исключения
| LogicException |
display(bool $finish = false)
Выводит текущую строку прогресса.
Параметры
| bool | $finish | Принудительно заканчивает результат |
Исключения
| LogicException |
clear()
Удаляет полосу прогресса с текущей строки.
Это полезно, если вы хотите вывести некоторый вывод, пока работает полоса прогресса. Вызовите display(), чтобы снова показать полосу прогресса.
finish()
Завершает вывод прогресса.
string getName()
Возвращает каноническое имя этого помощника.
Возвращаемое значение
| string | Каноническое имя |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Component/Console/Helper/ProgressHelper.html
