class ProgressBar
The ProgressBar provides helpers to display progress output.
__construct(OutputInterface $output, int $max) | ||
static | setPlaceholderFormatterDefinition(string $name, callable $callable) Sets a placeholder formatter for a given name. | |
static callable|null | getPlaceholderFormatterDefinition(string $name) Gets the placeholder formatter for a given name. | |
static | setFormatDefinition(string $name, string $format) Sets a format for a given name. | |
static string|null | getFormatDefinition(string $name) Gets the format for a given name. | |
setMessage(string $message, string $name = 'message') Associates a text with a named placeholder. | ||
getMessage($name = 'message') | ||
int | getStartTime() Gets the progress bar start time. | |
int | getMaxSteps() Gets the progress bar maximal steps. | |
int | getProgress() Gets the current step position. | |
float | getProgressPercent() Gets the current progress bar percent. | |
setBarWidth(int $size) Sets the progress bar width. | ||
int | getBarWidth() Gets the progress bar width. | |
setBarCharacter(string $char) Sets the bar character. | ||
string | getBarCharacter() Gets the bar character. | |
setEmptyBarCharacter(string $char) Sets the empty bar character. | ||
string | getEmptyBarCharacter() Gets the empty bar character. | |
setProgressCharacter(string $char) Sets the progress bar character. | ||
string | getProgressCharacter() Gets the progress bar character. | |
setFormat(string $format) Sets the progress bar format. | ||
setRedrawFrequency(int|float $freq) Sets the redraw frequency. | ||
start(int|null $max = null) Starts the progress output. | ||
advance(int $step = 1) Advances the progress output X steps. | ||
setOverwrite(bool $overwrite) Sets whether to overwrite the progressbar, false for new line. | ||
setProgress(int $step) Sets the current progress. | ||
finish() Finishes the progress output. | ||
display() Outputs the current progress string. | ||
clear() Removes the progress bar from the current line. |
Sets a placeholder formatter for a given name.
This method also allow you to override an existing placeholder.
Gets the placeholder formatter for a given name.
Sets a format for a given name.
This method also allow you to override an existing format.
Gets the format for a given name.
Associates a text with a named placeholder.
The text is displayed when the progress bar is rendered but only when the corresponding placeholder is part of the custom format line (by wrapping the name with %).
Gets the progress bar start time.
Gets the progress bar maximal steps.
Gets the current step position.
Gets the current progress bar percent.
Sets the progress bar width.
Gets the progress bar width.
Sets the bar character.
Gets the bar character.
Sets the empty bar character.
Gets the empty bar character.
Sets the progress bar character.
Gets the progress bar character.
Sets the progress bar format.
Sets the redraw frequency.
Starts the progress output.
Advances the progress output X steps.
Sets whether to overwrite the progressbar, false for new line.
Sets the current progress.
Finishes the progress output.
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.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Console/Helper/ProgressBar.html