Helper\ProgressIndicator (Component\Console)
Symfony\Component\Console\Helper\ProgressIndicator
class ProgressIndicator
Methods
__construct(OutputInterface $output, string|null $format = null, int $indicatorChangeInterval = 100, array|null $indicatorValues = null) | ||
setMessage(string|null $message) Sets the current indicator message. | ||
string|null | getMessage() Gets the current indicator message. | |
int | getStartTime() Gets the progress bar start time. | |
string | getCurrentValue() Gets the current animated indicator character. | |
start($message $message) Starts the indicator output. | ||
advance() Advances the indicator. | ||
finish($message $message) Finish the indicator with message. | ||
static string|null | getFormatDefinition(string $name) Gets the format for a given name. | |
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. |
Details
public __construct(OutputInterface $output, string|null $format = null, int $indicatorChangeInterval = 100, array|null $indicatorValues = null)
public setMessage(string|null $message)
Sets the current indicator message.
public string|null getMessage()
Gets the current indicator message.
public int getStartTime()
Gets the progress bar start time.
public string getCurrentValue()
Gets the current animated indicator character.
public start($message $message)
Starts the indicator output.
public advance()
Advances the indicator.
public finish($message $message)
Finish the indicator with message.
static public string|null getFormatDefinition(string $name)
Gets the format for a given name.
static public setPlaceholderFormatterDefinition(string $name, callable $callable)
Sets a placeholder formatter for a given name.
This method also allow you to override an existing placeholder.
static public callable|null getPlaceholderFormatterDefinition(string $name)
Gets the placeholder formatter for a given name.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Console/Helper/ProgressIndicator.html