Symfony\Component\Console\Helper\ProgressHelper
The Progress class provides helpers to display progress output.
- Author: Chris Jones <leeked@gmail.com>
Synopsis
class ProgressHelper
extends Helper
{
- // constants
- const FORMAT_QUIET = ' %percent%%';
- const FORMAT_NORMAL = ' %current%/%max% [%bar%] %percent%%';
- const FORMAT_VERBOSE = ' %current%/%max% [%bar%] %percent%% Elapsed: %elapsed%';
- const FORMAT_QUIET_NOMAX = ' %current%';
- const FORMAT_NORMAL_NOMAX = ' %current% [%bar%]';
- const FORMAT_VERBOSE_NOMAX = ' %current% [%bar%] Elapsed: %elapsed%';
- // members
- private integer $barWidth;
- private string $barChar;
- private string $emptyBarChar;
- private string $progressChar;
- private $format;
- private integer $redrawFreq;
- private $lastMessagesLength;
- private $barCharOriginal;
- private OutputInterface $output;
- private integer $current;
- private integer $max;
- private integer $startTime;
- private array $defaultFormatVars;
- private array $formatVars;
- private array $widths;
- private array $timeFormats;
- // Inherited members from Helper
- protected $helperSet;
- // methods
- public void setBarWidth()
- public void setBarCharacter()
- public void setEmptyBarCharacter()
- public void setProgressCharacter()
- public void setFormat()
- public void setRedrawFrequency()
- public void start()
- public void advance()
- public void setCurrent()
- public void display()
- public void finish()
- private void initialize()
- private array generate()
- private string humaneTime()
- private void overwrite()
- public void getName()
- // Inherited methods from Helper
- public void setHelperSet()
- public HelperSet getHelperSet()
- protected integer strlen()
Hierarchy
Constants
Name | Value |
---|---|
FORMAT_QUIET | ' %percent%%' |
FORMAT_NORMAL | ' %current%/%max% [%bar%] %percent%%' |
FORMAT_VERBOSE | ' %current%/%max% [%bar%] %percent%% Elapsed: %elapsed%' |
FORMAT_QUIET_NOMAX | ' %current%' |
FORMAT_NORMAL_NOMAX | ' %current% [%bar%]' |
FORMAT_VERBOSE_NOMAX | ' %current% [%bar%] Elapsed: %elapsed%' |
Members
private
- $barChar
- $barCharOriginal
- $barWidth
- $current
—
integer
Current step - $defaultFormatVars
—
array
List of formatting variables - $emptyBarChar
- $format
- $formatVars
—
array
Available formatting variables - $lastMessagesLength
- $max
—
integer
Maximum number of steps - $output — Symfony\Component\Console\Output\OutputInterface
- $progressChar
- $redrawFreq
- $startTime
—
integer
Start time of the progress bar - $timeFormats
—
array
Various time formats - $widths
—
array
Stored format part widths (used for padding)
protected
- $helperSet
Methods
private
- generate() — Generates the array map of format variables to values.
- humaneTime() — Converts seconds into human-readable format.
- initialize() — Initializes the progress helper.
- overwrite() — Overwrites a previous message to the output.
public
- advance() — Advances the progress output X steps.
- display() — Outputs the current progress string.
- finish() — Finishes the progress output.
- getName() — {@inheritDoc}
- setBarCharacter() — Sets the bar character.
- setBarWidth() — Sets the progress bar width.
- setCurrent() — Sets the current progress.
- setEmptyBarCharacter() — Sets the empty bar character.
- setFormat() — Sets the progress bar format.
- setProgressCharacter() — Sets the progress bar character.
- setRedrawFrequency() — Sets the redraw frequency.
- start() — Starts the progress output.
Inherited from Symfony\Component\Console\Helper\Helper
protected
- strlen() — Returns the length of a string, using mb_strlen if it is available.
public
- getHelperSet() — Gets the helper set associated with this helper.
- setHelperSet() — Sets the helper set associated with this helper.