ReferenceIndexProgressListener implements ProgressListenerInterface
Shows the update for the reference index progress on the command line.
not part of TYPO3 Public API as it is an implementation of a concrete feature.
Table of Contents
Interfaces
- ProgressListenerInterface
- An interface that tracks the progress of a longer-running progress.
Properties
- $io : SymfonyStyle
- $isEnabled : bool
- $progressBar : ProgressBar|null
Methods
- advance() : void
- Move the progress one step further
- finish() : void
- Stop the progress, automatically setting it to 100%.
- initialize() : mixed
- log() : void
- Can be used to render custom messages during the progress.
- start() : void
- Start a progress by using the maximum items, and an additional header message.
- showMessageWhileInProgress() : void
Properties
$io
protected
SymfonyStyle
$io
$isEnabled
protected
bool
$isEnabled
= false
$progressBar
protected
ProgressBar|null
$progressBar
= null
Methods
advance()
Move the progress one step further
public
advance([int $step = 1 ][, string|null $additionalMessage = null ]) : void
Parameters
- $step : int = 1
-
by default, this is "1" but can be used to skip further.
- $additionalMessage : string|null = null
-
a separate text message
finish()
Stop the progress, automatically setting it to 100%.
public
finish([string|null $additionalMessage = null ]) : void
Parameters
- $additionalMessage : string|null = null
-
a separate text message
initialize()
public
initialize(SymfonyStyle $io) : mixed
Parameters
- $io : SymfonyStyle
log()
Can be used to render custom messages during the progress.
public
log(string $message[, string $logLevel = LogLevel::INFO ]) : void
Parameters
- $message : string
-
the message to render
- $logLevel : string = LogLevel::INFO
-
used as severity
start()
Start a progress by using the maximum items, and an additional header message.
public
start([int $maxSteps = 0 ][, string|null $additionalMessage = null ]) : void
Parameters
- $maxSteps : int = 0
-
set the maximum amount of items to be processed
- $additionalMessage : string|null = null
-
a separate text message
showMessageWhileInProgress()
protected
showMessageWhileInProgress(callable $messageFunction) : void
Parameters
- $messageFunction : callable