class ProgressHelper extends Helper
deprecated
The Progress class provides helpers to display progress output.
FORMAT_QUIET | |
FORMAT_NORMAL | |
FORMAT_VERBOSE | |
FORMAT_QUIET_NOMAX | |
FORMAT_NORMAL_NOMAX | |
FORMAT_VERBOSE_NOMAX |
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. |
Sets the helper set associated with this helper.
Gets the helper set associated with this helper.
Returns the length of a string, using mb_strwidth if it is available.
Sets the progress bar width.
Sets the bar character.
Sets the empty bar character.
Sets the progress bar character.
Sets the progress bar format.
Sets the redraw frequency.
Starts the progress output.
Advances the progress output X steps.
Sets the current progress.
Outputs the current progress string.
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.
Finishes the progress output.
Returns the canonical name of this helper.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Component/Console/Helper/ProgressHelper.html