W3cubDocs

/Symfony 4.1

ProgressIndicator

class ProgressIndicator

Methods

__construct(OutputInterface $output, string $format = null, int $indicatorChangeInterval = 100, array $indicatorValues = null)
setMessage(string|null $message)

Sets the current indicator message.

start($message)

Starts the indicator output.

advance()

Advances the indicator.

finish($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

__construct(OutputInterface $output, string $format = null, int $indicatorChangeInterval = 100, array $indicatorValues = null)

Parameters

OutputInterface $output
string $format Indicator format
int $indicatorChangeInterval Change interval in milliseconds
array $indicatorValues Animated indicator characters

setMessage(string|null $message)

Sets the current indicator message.

Parameters

string|null $message

start($message)

Starts the indicator output.

Parameters

$message

advance()

Advances the indicator.

finish($message)

Finish the indicator with message.

Parameters

$message

static string|null getFormatDefinition(string $name)

Gets the format for a given name.

Parameters

string $name The format name

Return Value

string|null A format string

static setPlaceholderFormatterDefinition(string $name, callable $callable)

Sets a placeholder formatter for a given name.

This method also allow you to override an existing placeholder.

Parameters

string $name The placeholder name (including the delimiter char like %)
callable $callable A PHP callable

static callable|null getPlaceholderFormatterDefinition(string $name)

Gets the placeholder formatter for a given name.

Parameters

string $name The placeholder name (including the delimiter char like %)

Return Value

callable|null A PHP callable

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Console/Helper/ProgressIndicator.html