This commit is contained in:
1 parent
f7c532a648
commit
640bd67556
5801 files changed
+484532
-55857
No files matched your search
+31
-9
@@ -13,6 +13,7 @@ namespace Symfony\Component\Console\Helper;
|
||||
|
||||
use Symfony\Component\Console\Exception\InvalidArgumentException;
|
||||
use Symfony\Component\Console\Exception\LogicException;
|
||||
use Symfony\Component\Console\Output\ConsoleSectionOutput;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
/**
|
||||
@@ -36,8 +37,10 @@ class ProgressIndicator
|
||||
private ?string $message = null;
|
||||
private array $indicatorValues;
|
||||
private int $indicatorCurrent;
|
||||
private string $finishedIndicatorValue;
|
||||
private float $indicatorUpdateTime;
|
||||
private bool $started = false;
|
||||
private bool $finished = false;
|
||||
|
||||
/**
|
||||
* @var array<string, callable>
|
||||
@@ -53,11 +56,12 @@ class ProgressIndicator
|
||||
?string $format = null,
|
||||
private int $indicatorChangeInterval = 100,
|
||||
?array $indicatorValues = null,
|
||||
?string $finishedIndicatorValue = null,
|
||||
) {
|
||||
|
||||
$format ??= $this->determineBestFormat();
|
||||
$indicatorValues ??= ['-', '\\', '|', '/'];
|
||||
$indicatorValues = array_values($indicatorValues);
|
||||
$finishedIndicatorValue ??= '✔';
|
||||
|
||||
if (2 > \count($indicatorValues)) {
|
||||
throw new InvalidArgumentException('Must have at least 2 indicator value characters.');
|
||||
@@ -65,6 +69,7 @@ class ProgressIndicator
|
||||
|
||||
$this->format = self::getFormatDefinition($format);
|
||||
$this->indicatorValues = $indicatorValues;
|
||||
$this->finishedIndicatorValue = $finishedIndicatorValue;
|
||||
$this->startTime = time();
|
||||
}
|
||||
|
||||
@@ -89,6 +94,7 @@ class ProgressIndicator
|
||||
|
||||
$this->message = $message;
|
||||
$this->started = true;
|
||||
$this->finished = false;
|
||||
$this->startTime = time();
|
||||
$this->indicatorUpdateTime = $this->getCurrentTimeInMilliseconds() + $this->indicatorChangeInterval;
|
||||
$this->indicatorCurrent = 0;
|
||||
@@ -123,16 +129,30 @@ class ProgressIndicator
|
||||
|
||||
/**
|
||||
* Finish the indicator with message.
|
||||
*
|
||||
* @param ?string $finishedIndicator
|
||||
*/
|
||||
public function finish(string $message): void
|
||||
public function finish(string $message/* , ?string $finishedIndicator = null */): void
|
||||
{
|
||||
$finishedIndicator = 1 < \func_num_args() ? func_get_arg(1) : null;
|
||||
if (null !== $finishedIndicator && !\is_string($finishedIndicator)) {
|
||||
throw new \TypeError(\sprintf('Argument 2 passed to "%s()" must be of the type string or null, "%s" given.', __METHOD__, get_debug_type($finishedIndicator)));
|
||||
}
|
||||
|
||||
if (!$this->started) {
|
||||
throw new LogicException('Progress indicator has not yet been started.');
|
||||
}
|
||||
|
||||
if (null !== $finishedIndicator) {
|
||||
$this->finishedIndicatorValue = $finishedIndicator;
|
||||
}
|
||||
|
||||
$this->finished = true;
|
||||
$this->message = $message;
|
||||
$this->display();
|
||||
$this->output->writeln('');
|
||||
if (!$this->output instanceof ConsoleSectionOutput) {
|
||||
$this->output->writeln('');
|
||||
}
|
||||
$this->started = false;
|
||||
}
|
||||
|
||||
@@ -172,7 +192,7 @@ class ProgressIndicator
|
||||
return;
|
||||
}
|
||||
|
||||
$this->overwrite(preg_replace_callback("{%([a-z\-_]+)(?:\:([^%]+))?%}i", function ($matches) {
|
||||
$this->overwrite(preg_replace_callback('{%([a-z\-_]+)(?:\:([^%]+))?%}i', function ($matches) {
|
||||
if ($formatter = self::getPlaceholderFormatterDefinition($matches[1])) {
|
||||
return $formatter($this);
|
||||
}
|
||||
@@ -197,7 +217,9 @@ class ProgressIndicator
|
||||
*/
|
||||
private function overwrite(string $message): void
|
||||
{
|
||||
if ($this->output->isDecorated()) {
|
||||
if ($this->output instanceof ConsoleSectionOutput) {
|
||||
$this->output->overwrite($message);
|
||||
} elseif ($this->output->isDecorated()) {
|
||||
$this->output->write("\x0D\x1B[2K");
|
||||
$this->output->write($message);
|
||||
} else {
|
||||
@@ -216,10 +238,10 @@ class ProgressIndicator
|
||||
private static function initPlaceholderFormatters(): array
|
||||
{
|
||||
return [
|
||||
'indicator' => fn (self $indicator) => $indicator->indicatorValues[$indicator->indicatorCurrent % \count($indicator->indicatorValues)],
|
||||
'message' => fn (self $indicator) => $indicator->message,
|
||||
'elapsed' => fn (self $indicator) => Helper::formatTime(time() - $indicator->startTime, 2),
|
||||
'memory' => fn () => Helper::formatMemory(memory_get_usage(true)),
|
||||
'indicator' => static fn (self $indicator) => $indicator->finished ? $indicator->finishedIndicatorValue : $indicator->indicatorValues[$indicator->indicatorCurrent % \count($indicator->indicatorValues)],
|
||||
'message' => static fn (self $indicator) => $indicator->message,
|
||||
'elapsed' => static fn (self $indicator) => Helper::formatTime(time() - $indicator->startTime, 2),
|
||||
'memory' => static fn () => Helper::formatMemory(memory_get_usage(true)),
|
||||
];
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user