src/Core/Framework/DataAbstractionLayer/Command/ConsoleProgressTrait.php line 57

  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 Shopware\Core\Framework\Log\Package;
  9. use Symfony\Component\Console\Helper\ProgressBar;
  10. use Symfony\Component\Console\Style\SymfonyStyle;
  12. #[Package('core')]
  13. trait ConsoleProgressTrait
  14. {
  15.     /**
  16.      * @var SymfonyStyle|null
  17.      */
  18.     protected $io;
  20.     /**
  21.      * @var ProgressBar|null
  22.      */
  23.     protected $progress;
  25.     /**
  26.      * @return array<string, string>
  27.      */
  28.     public static function getSubscribedEvents(): array
  29.     {
  30.         return [
  31.             ProgressStartedEvent::NAME => 'startProgress',
  32.             ProgressAdvancedEvent::NAME => 'advanceProgress',
  33.             ProgressFinishedEvent::NAME => 'finishProgress',
  34.         ];
  35.     }
  37.     public function startProgress(ProgressStartedEvent $event): void
  38.     {
  39.         if (!$this->io) {
  40.             return;
  41.         }
  43.         $this->progress = $this->io->createProgressBar($event->getTotal());
  44.         $this->progress->setFormat("<info>[%message%]</info>\n%current%/%max% [%bar%] %percent:3s%% %elapsed:6s%/%estimated:-6s% %memory:6s%");
  45.         $this->progress->setMessage($event->getMessage());
  46.     }
  48.     public function advanceProgress(ProgressAdvancedEvent $event): void
  49.     {
  50.         if (!$this->progress) {
  51.             return;
  52.         }
  54.         $this->progress->advance($event->getStep());
  55.     }
  57.     public function finishProgress(ProgressFinishedEvent $event): void
  58.     {
  59.         if (!$this->io) {
  60.             return;
  61.         }
  63.         if (!$this->progress) {
  64.             return;
  65.         }
  67.         if (!$this->progress->getMaxSteps()) {
  68.             return;
  69.         }
  71.         $this->progress->setMessage($event->getMessage());
  72.         $this->progress->finish();
  73.         $this->io->newLine(2);
  74.     }
  75. }