Inheritance diagram for Zend_ProgressBar_Adapter_Console:

Public Member Functions
	__construct ($options=null)

	__destruct ()

	setOutputStream ($resource)

	getOutputStream ()

	setWidth ($width=null)

	setElements (array $elements)

	setBarLeftChar ($char)

	setBarRightChar ($char)

	setBarIndicatorChar ($char)

	setTextWidth ($width)

	setCharset ($charset)

	setFinishAction ($action)

	notify ($current, $max, $percent, $timeTaken, $timeRemaining, $text)

	finish ()

Public Member Functions inherited from Zend_ProgressBar_Adapter
	__construct ($options=null)

	setConfig (Zend_Config $config)

	setOptions (array $options)

	notify ($current, $max, $percent, $timeTaken, $timeRemaining, $text)

	finish ()

Data Fields
const	ELEMENT_PERCENT = 'ELEMENT_PERCENT'

const	ELEMENT_BAR = 'ELEMENT_BAR'

const	ELEMENT_ETA = 'ELEMENT_ETA'

const	ELEMENT_TEXT = 'ELEMENT_TEXT'

const	FINISH_ACTION_EOL = 'FINISH_ACTION_EOL'

const	FINISH_ACTION_CLEAR_LINE = 'FINISH_ACTION_CLEAR_LINE'

const	FINISH_ACTION_NONE = 'FINISH_ACTION_NONE'

Protected Member Functions
	_calculateBarWidth ()

	_outputData ($data)

Protected Attributes
	$_width = null

	$_elements

	$_finishAction = self::FINISH_ACTION_EOL

	$_barWidth

	$_barLeftChar = '#'

	$_barIndicatorChar = ''

	$_barRightChar = '-'

	$_outputStream = null

	$_textWidth = 20

	$_outputStarted = false

	$_charset = 'utf-8'

Protected Attributes inherited from Zend_ProgressBar_Adapter
	$_skipOptions

Detailed Description

Definition at line 40 of file Console.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $options = null )

Defined by Zend_ProgressBar_Adapter

Parameters

null | array | Zend_Config $options

Definition at line 161 of file Console.php.

     {
         // Call parent constructor with options
         parent::__construct($options);
 
         // Check if a width was set, else use auto width
         if ($this->_width === null) {
             $this->setWidth();
         }
     }

◆ __destruct()

__destruct ( )

Close local stdout, when open

Definition at line 175 of file Console.php.

     {
         if ($this->_outputStream !== null) {
             fclose($this->_outputStream);
         }
     }

Member Function Documentation

◆ _calculateBarWidth()

_calculateBarWidth ( )

protected

Calculate the bar width when other elements changed

Returns: void

Definition at line 501 of file Console.php.

     {
         if (in_array(self::ELEMENT_BAR, $this->_elements)) {
             $barWidth = $this->_width;
 
             if (in_array(self::ELEMENT_PERCENT, $this->_elements)) {
                 $barWidth -= 4;
             }
 
             if (in_array(self::ELEMENT_ETA, $this->_elements)) {
                 $barWidth -= 12;
             }
 
             if (in_array(self::ELEMENT_TEXT, $this->_elements)) {
                 $barWidth -= $this->_textWidth;
             }
 
             $this->_barWidth = $barWidth - (count($this->_elements) - 1);
         }
     }

◆ _outputData()

_outputData ( $data )

protected

Outputs given data to STDOUT.

This split-off is required for unit-testing.

Parameters

string $data

Returns: void

Definition at line 530 of file Console.php.

     {
         fwrite($this->getOutputStream(), $data);
     }

◆ finish()

finish ( )

Defined by Zend_ProgressBar_Adapter_Interface

Returns: void

Definition at line 474 of file Console.php.

     {
         switch ($this->_finishAction) {
             case self::FINISH_ACTION_EOL:
                 $this->_outputData(PHP_EOL);
                 break;
 
             case self::FINISH_ACTION_CLEAR_LINE:
                 if ($this->_outputStarted) {
                     $data = str_repeat("\x08", $this->_width)
                           . str_repeat(' ', $this->_width)
                           . str_repeat("\x08", $this->_width);
 
                     $this->_outputData($data);
                 }
                 break;
 
             case self::FINISH_ACTION_NONE:
                 break;
         }
     }

◆ getOutputStream()

getOutputStream ( )

Get the current output stream

Returns: resource

Definition at line 209 of file Console.php.

     {
         if ($this->_outputStream === null) {
             if (!defined('STDOUT')) {
                 $this->_outputStream = fopen('php://stdout', 'w');
             } else {
                 return STDOUT;
             }
         }
 
         return $this->_outputStream;
     }

◆ notify()

notify	(	$current,
		$max,
		$percent,
		$timeTaken,
		$timeRemaining,
		$text
	)

Defined by Zend_ProgressBar_Adapter_Interface

Parameters

float	$current	Current progress value
float	$max	Max progress value
float	$percent	Current percent value
integer	$timeTaken	Taken time in seconds
integer	$timeRemaining	Remaining time in seconds
string	$text	Status text

Returns: void

Definition at line 393 of file Console.php.

     {
         // See if we must clear the line
         if ($this->_outputStarted) {
             $data = str_repeat("\x08", $this->_width);
         } else {
             $data = '';
             $this->_outputStarted = true;
         }
 
         // Build all elements
         $renderedElements = array();
 
         foreach ($this->_elements as $element) {
             switch ($element) {
                 case self::ELEMENT_BAR:
                     $visualWidth = $this->_barWidth - 2;
                     $bar         = '[';
 
                     $indicatorWidth = strlen($this->_barIndicatorChar);
 
                     $doneWidth = min($visualWidth - $indicatorWidth, round($visualWidth * $percent));
                     if ($doneWidth > 0) {
                         $bar .= substr(str_repeat($this->_barLeftChar, ceil($doneWidth / strlen($this->_barLeftChar))), 0, $doneWidth);
                     }
 
                     $bar .= $this->_barIndicatorChar;
 
                     $leftWidth = $visualWidth - $doneWidth - $indicatorWidth;
                     if ($leftWidth > 0) {
                         $bar .= substr(str_repeat($this->_barRightChar, ceil($leftWidth / strlen($this->_barRightChar))), 0, $leftWidth);
                     }
 
                     $bar .= ']';
 
                     $renderedElements[] = $bar;
                     break;
 
                 case self::ELEMENT_PERCENT:
                     $renderedElements[] = str_pad(round($percent * 100), 3, ' ', STR_PAD_LEFT) . '%';
                     break;
 
                 case self::ELEMENT_ETA:
                     // In the first 5 seconds we don't get accurate results,
                     // this skipping technique is found in many progressbar
                     // implementations.
                     if ($timeTaken < 5) {
                         $renderedElements[] = str_repeat(' ', 12);
                         break;
                     }
 
                     if ($timeRemaining === null || $timeRemaining > 86400) {
                         $etaFormatted = '??:??:??';
                     } else {
                         $hours   = floor($timeRemaining / 3600);
                         $minutes = floor(($timeRemaining % 3600) / 60);
                         $seconds = ($timeRemaining % 3600 % 60);
 
                         $etaFormatted = sprintf('%02d:%02d:%02d', $hours, $minutes, $seconds);
                     }
 
                     $renderedElements[] = 'ETA ' . $etaFormatted;
                     break;
 
                 case self::ELEMENT_TEXT:
                     $renderedElements[] = Zend_Text_MultiByte::strPad(substr($text, 0, $this->_textWidth), $this->_textWidth, ' ', STR_PAD_RIGHT, $this->_charset);
                     break;
             }
         }
 
         $data .= implode(' ', $renderedElements);
 
         // Output line data
         $this->_outputData($data);
     }

◆ setBarIndicatorChar()

setBarIndicatorChar ( $char )

Set the indicator character for the bar

Parameters

string $char

Returns: Zend_ProgressBar_Adapter_Console

Definition at line 327 of file Console.php.

     {
         $this->_barIndicatorChar = (string) $char;
 
         return $this;
     }

◆ setBarLeftChar()

setBarLeftChar ( $char )

Set the left-hand character for the bar

Parameters

string $char

Exceptions

Zend_ProgressBar_Adapter_Exception When character is empty

Returns: Zend_ProgressBar_Adapter_Console

Definition at line 290 of file Console.php.

     {
         if (empty($char)) {
             #require_once 'Zend/ProgressBar/Adapter/Exception.php';
             throw new Zend_ProgressBar_Adapter_Exception('Character may not be empty');
         }
 
         $this->_barLeftChar = (string) $char;
 
         return $this;
     }

◆ setBarRightChar()

setBarRightChar ( $char )

Set the right-hand character for the bar

Parameters

string $char

Exceptions

Zend_ProgressBar_Adapter_Exception When character is empty

Returns: Zend_ProgressBar_Adapter_Console

Definition at line 309 of file Console.php.

     {
         if (empty($char)) {
             #require_once 'Zend/ProgressBar/Adapter/Exception.php';
             throw new Zend_ProgressBar_Adapter_Exception('Character may not be empty');
         }
 
         $this->_barRightChar = (string) $char;
 
         return $this;
     }

◆ setCharset()

setCharset ( $charset )

Set the charset of the text element

Parameters

string $charset

Definition at line 354 of file Console.php.

     {
         $this->_charset = $charset;
     }

◆ setElements()

setElements ( array $elements )

Set the elements to display with the progressbar

Parameters

array $elements

Exceptions

Zend_ProgressBar_Adapter_Exception When an invalid element is foudn in the array

Returns: Zend_ProgressBar_Adapter_Console

Definition at line 264 of file Console.php.

     {
         $allowedElements = array(self::ELEMENT_PERCENT,
                                  self::ELEMENT_BAR,
                                  self::ELEMENT_ETA,
                                  self::ELEMENT_TEXT);
 
         if (count(array_diff($elements, $allowedElements)) > 0) {
             #require_once 'Zend/ProgressBar/Adapter/Exception.php';
             throw new Zend_ProgressBar_Adapter_Exception('Invalid element found in $elements array');
         }
 
         $this->_elements = $elements;
 
         $this->_calculateBarWidth();
 
         return $this;
     }

◆ setFinishAction()

setFinishAction ( $action )

Set the finish action

Parameters

string $action

Exceptions

Zend_ProgressBar_Adapter_Exception When an invalid action is specified

Returns: Zend_ProgressBar_Adapter_Console

Definition at line 366 of file Console.php.

     {
         $allowedActions = array(self::FINISH_ACTION_CLEAR_LINE,
                                 self::FINISH_ACTION_EOL,
                                 self::FINISH_ACTION_NONE);
 
         if (!in_array($action, $allowedActions)) {
             #require_once 'Zend/ProgressBar/Adapter/Exception.php';
             throw new Zend_ProgressBar_Adapter_Exception('Invalid finish action specified');
         }
 
         $this->_finishAction = $action;
 
         return $this;
     }

◆ setOutputStream()

setOutputStream ( $resource )

Set a different output-stream

Parameters

string $resource

Returns: Zend_ProgressBar_Adapter_Console

Definition at line 188 of file Console.php.

     {
        $stream = @fopen($resource, 'w');
 
        if ($stream === false) {
             #require_once 'Zend/ProgressBar/Adapter/Exception.php';
             throw new Zend_ProgressBar_Adapter_Exception('Unable to open stream');
        }
 
        if ($this->_outputStream !== null) {
            fclose($this->_outputStream);
        }
 
        $this->_outputStream = $stream;
     }

◆ setTextWidth()

setTextWidth ( $width )

Set the width of the text element

Parameters

integer $width

Returns: Zend_ProgressBar_Adapter_Console

Definition at line 340 of file Console.php.

     {
         $this->_textWidth = (int) $width;
 
         $this->_calculateBarWidth();
 
         return $this;
     }

◆ setWidth()

setWidth ( $width = null )

Set the width of the progressbar

Parameters

integer $width

Returns: Zend_ProgressBar_Adapter_Console

Definition at line 228 of file Console.php.

     {
         if ($width === null || !is_integer($width)) {
             if (substr(PHP_OS, 0, 3) === 'WIN') {
                 // We have to default to 79 on windows, because the windows
                 // terminal always has a fixed width of 80 characters and the
                 // cursor is counted to the line, else windows would line break
                 // after every update.
                 $this->_width = 79;
             } else {
                 // Set the default width of 80
                 $this->_width = 80;
 
                 // Try to determine the width through stty
                 if (preg_match('#\d+ (\d+)#', @shell_exec('stty size'), $match) === 1) {
                     $this->_width = (int) $match[1];
                 } else if (preg_match('#columns = (\d+);#', @shell_exec('stty'), $match) === 1) {
                     $this->_width = (int) $match[1];
                 }
             }
         } else {
             $this->_width = (int) $width;
         }
 
         $this->_calculateBarWidth();
 
         return $this;
     }

Field Documentation

◆ $_barIndicatorChar

$_barIndicatorChar = ''

protected

Definition at line 119 of file Console.php.

◆ $_barLeftChar

$_barLeftChar = '#'

protected

Definition at line 112 of file Console.php.

◆ $_barRightChar

$_barRightChar = '-'

protected

Definition at line 126 of file Console.php.

◆ $_barWidth

$_barWidth

protected

Definition at line 105 of file Console.php.

◆ $_charset

$_charset = 'utf-8'

protected

Definition at line 154 of file Console.php.

◆ $_elements

$_elements

protected

Initial value:

= array(self::ELEMENT_PERCENT,
                                 self::ELEMENT_BAR,
                                 self::ELEMENT_ETA)

Definition at line 89 of file Console.php.

◆ $_finishAction

$_finishAction = self::FINISH_ACTION_EOL

protected

Definition at line 98 of file Console.php.

◆ $_outputStarted

$_outputStarted = false

protected

Definition at line 147 of file Console.php.

◆ $_outputStream

$_outputStream = null

protected

Definition at line 133 of file Console.php.

◆ $_textWidth

$_textWidth = 20

protected

Definition at line 140 of file Console.php.

◆ $_width

$_width = null

protected

Definition at line 82 of file Console.php.

◆ ELEMENT_BAR

const ELEMENT_BAR = 'ELEMENT_BAR'

Visual value of the progress

Definition at line 50 of file Console.php.

◆ ELEMENT_ETA

const ELEMENT_ETA = 'ELEMENT_ETA'

ETA of the progress

Definition at line 55 of file Console.php.

◆ ELEMENT_PERCENT

const ELEMENT_PERCENT = 'ELEMENT_PERCENT'

Percentage value of the progress

Definition at line 45 of file Console.php.

◆ ELEMENT_TEXT

const ELEMENT_TEXT = 'ELEMENT_TEXT'

Text part of the progress

Definition at line 60 of file Console.php.

◆ FINISH_ACTION_CLEAR_LINE

const FINISH_ACTION_CLEAR_LINE = 'FINISH_ACTION_CLEAR_LINE'

Finish action: Clear Line

Definition at line 70 of file Console.php.

◆ FINISH_ACTION_EOL

const FINISH_ACTION_EOL = 'FINISH_ACTION_EOL'

Finish action: End of Line

Definition at line 65 of file Console.php.

◆ FINISH_ACTION_NONE

const FINISH_ACTION_NONE = 'FINISH_ACTION_NONE'

Finish action: None

Definition at line 75 of file Console.php.

The documentation for this class was generated from the following file:

vendor/magento/zendframework1/library/Zend/ProgressBar/Adapter/Console.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ _calculateBarWidth()

◆ _outputData()

◆ finish()

◆ getOutputStream()

◆ notify()

◆ setBarIndicatorChar()

◆ setBarLeftChar()

◆ setBarRightChar()

◆ setCharset()

◆ setElements()

◆ setFinishAction()

◆ setOutputStream()

◆ setTextWidth()

◆ setWidth()

Field Documentation

◆ $_barIndicatorChar

◆ $_barLeftChar

◆ $_barRightChar

◆ $_barWidth

◆ $_charset

◆ $_elements

◆ $_finishAction

◆ $_outputStarted

◆ $_outputStream

◆ $_textWidth

◆ $_width

◆ ELEMENT_BAR

◆ ELEMENT_ETA

◆ ELEMENT_PERCENT

◆ ELEMENT_TEXT

◆ FINISH_ACTION_CLEAR_LINE

◆ FINISH_ACTION_EOL

◆ FINISH_ACTION_NONE