Overview

Namespaces

  • Net
    • Bazzline
      • Component
        • Cli
          • ProgressBar

Classes

  • Net\Bazzline\Component\Cli\ProgressBar\ProgressBar
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 
<?php
/**
 * @author stev leibelt <artodeto@bazzline.net>
 * @since 2015-05-24 
 */

namespace Net\Bazzline\Component\Cli\ProgressBar;

class ProgressBar
{
    /** @var int */
    private $currentStep = 0;

    /** @var bool */
    private $initialStepWasZero = false;

    /** @var bool */
    private $isFinished = true;

    /** @var int */
    private $totalStepSize;

    /** @var int */
    private $totalSteps;

    /**
     * @param int $total
     */
    public function setTotalSteps($total)
    {
        $this->totalSteps   = (int) $total;
        $this->calculateNumberOfSteps();
        $this->currentStep  = 0;
        $this->isFinished   = false;
        $this->storeCursorPosition();
    }

    public function isFinished()
    {
        $this->update($this->totalSteps);
    }

    /**
     * @param int $current
     */
    public function update($current)
    {
        if (!$this->isFinished) {
            $this->currentStep = (int) $current;

            if ($this->currentStep === 0) {
                $this->initialStepWasZero = true;
            }
            if ($this->initialStepWasZero) {
                ++$this->currentStep;
            }

            $this->resetCursor();
            $this->draw();
        }
    }

    public function forward()
    {
        $next = ($this->initialStepWasZero) ? $this->currentStep : ++$this->currentStep;

        $this->update($next);
    }

    private function draw()
    {
        $numberOfStepDraws                  = (($this->currentStep * $this->totalStepSize) / $this->totalSteps);
        $numberOfMissingStepDraws           = ($this->totalStepSize - $numberOfStepDraws);
        $numberOfWhiteSpacesForCurrentStep  = (strlen($this->totalSteps) - strlen($this->currentStep));

        $output = '[';
        $output .= str_repeat('=', floor($numberOfStepDraws));
        $output .= '>';
        $output .= str_repeat(' ', ceil($numberOfMissingStepDraws));
        $output .= '] (';

        if ($numberOfWhiteSpacesForCurrentStep > 0) {
            $output .= str_repeat(' ', $numberOfWhiteSpacesForCurrentStep);
        }
        $output .= $this->currentStep . '/' . $this->totalSteps . ')';

        if ($this->currentStep >= $this->totalSteps) {
            $this->isFinished   = true;
            $output            .= PHP_EOL;
        }

        echo $output;
    }

    private function resetCursor()
    {
        echo "\0338";
    }

    private function storeCursorPosition()
    {
        echo "\0337";
    }

    private function calculateNumberOfSteps()
    {
        $lengthOfTotal = strlen($this->totalSteps);
        $lengthOfAdditionalCharacters = 6; //[] (/)

        $this->totalStepSize = 80 - (2 * $lengthOfTotal) - $lengthOfAdditionalCharacters;
    }
}
PHP Cli Progress Bar Component by bazzline.net API documentation generated by ApiGen