platform/src/Core/Framework/DataAbstractionLayer/Command/ConsoleProgressTrait.php line 35

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\DataAbstractionLayer\Command;
  5. use Shopware\Core\Framework\Event\ProgressAdvancedEvent;
  6. use Shopware\Core\Framework\Event\ProgressFinishedEvent;
  7. use Shopware\Core\Framework\Event\ProgressStartedEvent;
  8. use Symfony\Component\Console\Helper\ProgressBar;
  9. use Symfony\Component\Console\Style\SymfonyStyle;
  11. trait ConsoleProgressTrait
  12. {
  13.     /**
  14.      * @var SymfonyStyle|null
  15.      */
  16.     protected $io;
  18.     /**
  19.      * @var ProgressBar|null
  20.      */
  21.     protected $progress;
  23.     /**
  24.      * @return array<string, string>
  25.      */
  26.     public static function getSubscribedEvents(): array
  27.     {
  28.         return [
  29.             ProgressStartedEvent::NAME => 'startProgress',
  30.             ProgressAdvancedEvent::NAME => 'advanceProgress',
  31.             ProgressFinishedEvent::NAME => 'finishProgress',
  32.         ];
  33.     }
  35.     public function startProgress(ProgressStartedEvent $event): void
  36.     {
  37.         if (!$this->io) {
  38.             return;
  39.         }
  41.         $this->progress = $this->io->createProgressBar($event->getTotal());
  42.         $this->progress->setFormat("<info>[%message%]</info>\n%current%/%max% [%bar%] %percent:3s%% %elapsed:6s%/%estimated:-6s% %memory:6s%");
  43.         $this->progress->setMessage($event->getMessage());
  44.     }
  46.     public function advanceProgress(ProgressAdvancedEvent $event): void
  47.     {
  48.         if (!$this->progress) {
  49.             return;
  50.         }
  52.         $this->progress->advance($event->getStep());
  53.     }
  55.     public function finishProgress(ProgressFinishedEvent $event): void
  56.     {
  57.         if (!$this->io) {
  58.             return;
  59.         }
  61.         if (!$this->progress) {
  62.             return;
  63.         }
  65.         if (!$this->progress->getMaxSteps()) {
  66.             return;
  67.         }
  69.         $this->progress->setMessage($event->getMessage());
  70.         $this->progress->finish();
  71.         $this->io->newLine(2);
  72.     }
  73. }