class ProgressIndicator (View source)

Wrapper around \Symfony\Component\Console\Helper\ProgressBar

Traits

Properties

protected TimeKeeper|null $timer from  Timer
protected ProgressBar $progressBar
protected OutputInterface $output
protected bool $progressIndicatorRunning
protected int $autoDisplayInterval
protected int $cachedSteps
protected int $totalSteps
protected bool $progressBarDisplayed
protected TaskInterface $owner

Methods

startTimer()

No description

from  Timer
stopTimer()

No description

from  Timer
resetTimer()

No description

from  Timer
float|null
getExecutionTime()

No description

from  Timer
__construct(ProgressBar $progressBar, OutputInterface $output)

No description

setProgressBarAutoDisplayInterval(int $interval)

No description

bool
hideProgressIndicator()

No description

showProgressIndicator()

No description

restoreProgressIndicator(bool $visible)

No description

startProgressIndicator(int $totalSteps, TaskInterface $owner)

No description

autoShowProgressIndicator()

No description

bool
inProgress()

No description

stopProgressIndicator(TaskInterface $owner)

No description

cleanup()

No description

disableProgressIndicator()

Erase progress indicator and ensure it never returns. Used only during error handlers or to permanently remove the progress bar.

advanceProgressIndicator(int $steps = 1)

No description

Details

protected startTimer()

No description

protected stopTimer()

No description

protected resetTimer()

No description

protected float|null getExecutionTime()

No description

Return Value

float|null

__construct(ProgressBar $progressBar, OutputInterface $output)

No description

Parameters

ProgressBar $progressBar
OutputInterface $output

setProgressBarAutoDisplayInterval(int $interval)

No description

Parameters

int $interval

bool hideProgressIndicator()

No description

Return Value

bool

showProgressIndicator()

No description

restoreProgressIndicator(bool $visible)

No description

Parameters

bool $visible

startProgressIndicator(int $totalSteps, TaskInterface $owner)

No description

Parameters

int $totalSteps
TaskInterface $owner

autoShowProgressIndicator()

No description

bool inProgress()

No description

Return Value

bool

stopProgressIndicator(TaskInterface $owner)

No description

Parameters

TaskInterface $owner

protected cleanup()

No description

disableProgressIndicator()

Erase progress indicator and ensure it never returns. Used only during error handlers or to permanently remove the progress bar.

advanceProgressIndicator(int $steps = 1)

No description

Parameters

int $steps

protected advanceProgressIndicatorCachedSteps()

No description