class ProgressIndicator

Methods

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

No description

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

at line 42
__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

at line 71
setMessage(string|null $message)

Sets the current indicator message.

Parameters

string|null $message

at line 83
start($message)

Starts the indicator output.

Parameters

$message

at line 101
advance()

Advances the indicator.

at line 128
finish($message)

Finish the indicator with message.

Parameters

$message

at line 147
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

at line 164
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

at line 180
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