ProgressIndicator
in package
Tags
Table of Contents
Methods
- __construct() : mixed
- advance() : void
- Advances the indicator.
- finish() : void
- Finish the indicator with message.
- getFormatDefinition() : string|null
- Gets the format for a given name.
- getPlaceholderFormatterDefinition() : callable|null
- Gets the placeholder formatter for a given name (including the delimiter char like %).
- setMessage() : void
- Sets the current indicator message.
- setPlaceholderFormatterDefinition() : void
- Sets a placeholder formatter for a given name.
- start() : void
- Starts the indicator output.
Methods
__construct()
public
__construct(OutputInterface $output[, string|null $format = null ][, int $indicatorChangeInterval = 100 ][, array<string|int, mixed>|null $indicatorValues = null ][, string|null $finishedIndicatorValue = null ]) : mixed
Parameters
- $output : OutputInterface
- $format : string|null = null
- $indicatorChangeInterval : int = 100
-
Change interval in milliseconds
- $indicatorValues : array<string|int, mixed>|null = null
-
Animated indicator characters
- $finishedIndicatorValue : string|null = null
advance()
Advances the indicator.
public
advance() : void
finish()
Finish the indicator with message.
public
finish(string $message) : void
Parameters
- $message : string
getFormatDefinition()
Gets the format for a given name.
public
static getFormatDefinition(string $name) : string|null
Parameters
- $name : string
Return values
string|nullgetPlaceholderFormatterDefinition()
Gets the placeholder formatter for a given name (including the delimiter char like %).
public
static getPlaceholderFormatterDefinition(string $name) : callable|null
Parameters
- $name : string
Return values
callable|nullsetMessage()
Sets the current indicator message.
public
setMessage(string|null $message) : void
Parameters
- $message : string|null
setPlaceholderFormatterDefinition()
Sets a placeholder formatter for a given name.
public
static setPlaceholderFormatterDefinition(string $name, callable $callable) : void
This method also allow you to override an existing placeholder.
Parameters
- $name : string
- $callable : callable
start()
Starts the indicator output.
public
start(string $message) : void
Parameters
- $message : string