Properties

$output

$output : 

Type

$startTime

$startTime : 

Type

$format

$format : 

Type

$message

$message : 

Type

$indicatorValues

$indicatorValues : 

Type

$indicatorCurrent

$indicatorCurrent : 

Type

$indicatorChangeInterval

$indicatorChangeInterval : 

Type

$indicatorUpdateTime

$indicatorUpdateTime : 

Type

$started

$started : 

Type

$formatters

$formatters : 

Type

$formats

$formats : 

Type

Methods

__construct()

__construct(\Symfony\Component\Console\Output\OutputInterface  $output, string|null  $format = null, integer  $indicatorChangeInterval = 100, array|null  $indicatorValues = null) 

Parameters

\Symfony\Component\Console\Output\OutputInterface $output
string|null $format

Indicator format

integer $indicatorChangeInterval

Change interval in milliseconds

array|null $indicatorValues

Animated indicator characters

setMessage()

setMessage(string|null  $message) 

Sets the current indicator message.

Parameters

string|null $message

start()

start(  $message) 

Starts the indicator output.

Parameters

$message

advance()

advance() 

Advances the indicator.

finish()

finish(  $message) 

Finish the indicator with message.

Parameters

$message

getFormatDefinition()

getFormatDefinition(string  $name) : string|null

Gets the format for a given name.

Parameters

string $name

The format name

Returns

string|null —

A format string

setPlaceholderFormatterDefinition()

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

getPlaceholderFormatterDefinition()

getPlaceholderFormatterDefinition(string  $name) : callable|null

Gets the placeholder formatter for a given name.

Parameters

string $name

The placeholder name (including the delimiter char like %)

Returns

callable|null —

A PHP callable

display()

display() 

determineBestFormat()

determineBestFormat() 

overwrite()

overwrite(\Symfony\Component\Console\Helper\string  $message) 

Overwrites a previous message to the output.

Parameters

\Symfony\Component\Console\Helper\string $message

getCurrentTimeInMilliseconds()

getCurrentTimeInMilliseconds() 

initPlaceholderFormatters()

initPlaceholderFormatters() 

initFormats()

initFormats()