Class Symfony\Component\Console\Helper\ProgressIndicator

InheritanceSymfony\Component\Console\Helper\ProgressIndicator

Method Details

__construct() public method

public void __construct ( Symfony\Component\Console\Output\OutputInterface $output, $format null, $indicatorChangeInterval 100, $indicatorValues null )
$output Symfony\Component\Console\Output\OutputInterface
$format string|null

Indicator format

$indicatorChangeInterval int

Change interval in milliseconds

$indicatorValues array|null

Animated indicator characters

advance() public method

Advances the indicator.

public void advance ( )
finish() public method

Finish the indicator with message.

public void finish ( $message )
$message
getFormatDefinition() public static method

Gets the format for a given name.

public static string|null getFormatDefinition ( $name )
$name string

The format name

return string|null

A format string

getPlaceholderFormatterDefinition() public static method

Gets the placeholder formatter for a given name.

public static callable|null getPlaceholderFormatterDefinition ( $name )
$name string

The placeholder name (including the delimiter char like %)

return callable|null

A PHP callable

setMessage() public method

Sets the current indicator message.

public void setMessage ( $message )
$message string|null
setPlaceholderFormatterDefinition() public static method

Sets a placeholder formatter for a given name.

This method also allow you to override an existing placeholder.

public static void setPlaceholderFormatterDefinition ( $name, $callable )
$name string

The placeholder name (including the delimiter char like %)

$callable callable

A PHP callable

start() public method

Starts the indicator output.

public void start ( $message )
$message