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.
HelperSet | $helperSet | A HelperSet instance |
Gets the helper set associated with this helper.
HelperSet | A HelperSet instance |
Returns the length of a string, using mb_strwidth if it is available.
string | $string | The string to check its length |
int | The length of the string |
$secs |
$memory |
OutputFormatterInterface | $formatter | |
$string |
$triggerDeprecationError |
Sets the progress bar width.
int | $size | The progress bar size |
Sets the bar character.
string | $char | A character |
Sets the empty bar character.
string | $char | A character |
Sets the progress bar character.
string | $char | A character |
Sets the progress bar format.
string | $format | The format |
Sets the redraw frequency.
int | $freq | The frequency in steps |
Starts the progress output.
OutputInterface | $output | An Output instance |
int|null | $max | Maximum steps |
Advances the progress output X steps.
int | $step | Number of steps to advance |
bool | $redraw | Whether to redraw or not |
LogicException |
Sets the current progress.
int | $current | The current progress |
bool | $redraw | Whether to redraw or not |
LogicException |
Outputs the current progress string.
bool | $finish | Forces the end result |
LogicException |
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.
string | The canonical name |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Console/Helper/ProgressHelper.html