class ProgressHelper extends Helper
deprecated
since version 2.5, to be removed in 3.0 Use {@link ProgressBar} instead.
The Progress class provides helpers to display progress output.
Constants
| FORMAT_QUIET | |
| FORMAT_NORMAL | |
| FORMAT_VERBOSE | |
| FORMAT_QUIET_NOMAX | |
| FORMAT_NORMAL_NOMAX | |
| FORMAT_VERBOSE_NOMAX |
Methods
| setHelperSet(HelperSet $helperSet = null) Sets the helper set associated with this helper. | from Helper | |
| HelperSet | getHelperSet() Gets the helper set associated with this helper. | from Helper |
| static int | strlen(string $string) Returns the length of a string, using mb_strwidth if it is available. | 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) Sets the progress bar width. | ||
| setBarCharacter(string $char) Sets the bar character. | ||
| setEmptyBarCharacter(string $char) Sets the empty bar character. | ||
| setProgressCharacter(string $char) Sets the progress bar character. | ||
| setFormat(string $format) Sets the progress bar format. | ||
| setRedrawFrequency(int $freq) Sets the redraw frequency. | ||
| start(OutputInterface $output, int|null $max = null) Starts the progress output. | ||
| advance(int $step = 1, bool $redraw = false) Advances the progress output X steps. | ||
| setCurrent(int $current, bool $redraw = false) Sets the current progress. | ||
| display(bool $finish = false) Outputs the current progress string. | ||
| clear() Removes the progress bar from the current line. | ||
| finish() Finishes the progress output. | ||
| string | getName() Returns the canonical name of this helper. |
Details
setHelperSet(HelperSet $helperSet = null)
Sets the helper set associated with this helper.
HelperSet getHelperSet()
Gets the helper set associated with this helper.
static int strlen(string $string)
Returns the length of a string, using mb_strwidth if it is available.
static formatTime($secs)
static formatMemory($memory)
static strlenWithoutDecoration(OutputFormatterInterface $formatter, $string)
__construct($triggerDeprecationError = true)
setBarWidth(int $size)
Sets the progress bar width.
setBarCharacter(string $char)
Sets the bar character.
setEmptyBarCharacter(string $char)
Sets the empty bar character.
setProgressCharacter(string $char)
Sets the progress bar character.
setFormat(string $format)
Sets the progress bar format.
setRedrawFrequency(int $freq)
Sets the redraw frequency.
start(OutputInterface $output, int|null $max = null)
Starts the progress output.
advance(int $step = 1, bool $redraw = false)
Advances the progress output X steps.
setCurrent(int $current, bool $redraw = false)
Sets the current progress.
display(bool $finish = false)
Outputs the current progress string.
clear()
Removes the progress bar from the current line.
This is useful if you wish to write some output while a progress bar is running. Call display() to show the progress bar again.
finish()
Finishes the progress output.
string getName()
Returns the canonical name of this helper.
Please login to continue.