ProgressIndicator

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

Parameters

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

setMessage(string|null $message)

Sets the current indicator message.

Parameters

string|null

$message

string|null getMessage()

Gets the current indicator message.

Return Value

string|null

int getStartTime()

Gets the progress bar start time.

Return Value

int	The progress bar start time

string getCurrentValue()

Gets the current animated indicator character.

Return Value

string

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