‪TYPO3CMS  ‪main
TYPO3\CMS\Backend\Command\ProgressListener\ReferenceIndexProgressListener Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Command\ProgressListener\ReferenceIndexProgressListener:
TYPO3\CMS\Backend\View\ProgressListenerInterface

Public Member Functions

 initialize (SymfonyStyle $io)
 
 start (int $maxSteps=0, string $additionalMessage=null)
 
 advance (int $step=1, string $additionalMessage=null)
 
 finish (string $additionalMessage=null)
 
 log (string $message, string $logLevel=LogLevel::INFO)
 

Protected Member Functions

 showMessageWhileInProgress (callable $messageFunction)
 

Protected Attributes

SymfonyStyle $io
 
ProgressBar $progressBar = null
 
bool $isEnabled = false
 

Detailed Description

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.

Definition at line 29 of file ReferenceIndexProgressListener.php.

Member Function Documentation

◆ advance()

TYPO3\CMS\Backend\Command\ProgressListener\ReferenceIndexProgressListener::advance ( int  $step = 1,
string  $additionalMessage = null 
)

Move the progress one step further

Parameters
int$step‪by default, this is "1" but can be used to skip further.
string | null$additionalMessage‪a separate text message

Implements TYPO3\CMS\Backend\View\ProgressListenerInterface.

Definition at line 57 of file ReferenceIndexProgressListener.php.

References TYPO3\CMS\Backend\Command\ProgressListener\ReferenceIndexProgressListener\showMessageWhileInProgress().

◆ finish()

TYPO3\CMS\Backend\Command\ProgressListener\ReferenceIndexProgressListener::finish ( string  $additionalMessage = null)

Stop the progress, automatically setting it to 100%.

Parameters
string | null$additionalMessage‪a separate text message

Implements TYPO3\CMS\Backend\View\ProgressListenerInterface.

Definition at line 72 of file ReferenceIndexProgressListener.php.

◆ initialize()

TYPO3\CMS\Backend\Command\ProgressListener\ReferenceIndexProgressListener::initialize ( SymfonyStyle  $io)

◆ log()

TYPO3\CMS\Backend\Command\ProgressListener\ReferenceIndexProgressListener::log ( string  $message,
string  $logLevel = LogLevel::INFO 
)

Can be used to render custom messages during the progress.

Parameters
string$message‪the message to render
string$logLevel‪used as severity

Implements TYPO3\CMS\Backend\View\ProgressListenerInterface.

Definition at line 87 of file ReferenceIndexProgressListener.php.

References TYPO3\CMS\Backend\Command\ProgressListener\ReferenceIndexProgressListener\showMessageWhileInProgress().

◆ showMessageWhileInProgress()

TYPO3\CMS\Backend\Command\ProgressListener\ReferenceIndexProgressListener::showMessageWhileInProgress ( callable  $messageFunction)
protected

◆ start()

TYPO3\CMS\Backend\Command\ProgressListener\ReferenceIndexProgressListener::start ( int  $maxSteps = 0,
string  $additionalMessage = null 
)

Start a progress by using the maximum items, and an additional header message.

Parameters
int$maxSteps‪set the maximum amount of items to be processed
string | null$additionalMessage‪a separate text message

Implements TYPO3\CMS\Backend\View\ProgressListenerInterface.

Definition at line 41 of file ReferenceIndexProgressListener.php.

Member Data Documentation

◆ $io

SymfonyStyle TYPO3\CMS\Backend\Command\ProgressListener\ReferenceIndexProgressListener::$io
protected

◆ $isEnabled

bool TYPO3\CMS\Backend\Command\ProgressListener\ReferenceIndexProgressListener::$isEnabled = false
protected

Definition at line 33 of file ReferenceIndexProgressListener.php.

◆ $progressBar

ProgressBar TYPO3\CMS\Backend\Command\ProgressListener\ReferenceIndexProgressListener::$progressBar = null
protected

Definition at line 32 of file ReferenceIndexProgressListener.php.