Zend_ProgressBar_Adapter_Console offers a text-based progressbar for console applications
category | Zend |
---|---|
package | Zend_ProgressBar |
uses | |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
inherited_from | \Zend_ProgressBar_Adapter |
__construct(null|array|\Zend_Config $options = null
)
$options may be either be an array or a Zend_Config object which specifies adapter related options.
inherited_from | \Zend_ProgressBar_Adapter::__construct() |
---|
null
array
\Zend_Config
__construct(null|array|\Zend_Config $options = null
)
$options may be either be an array or a Zend_Config object which specifies adapter related options.
null
array
\Zend_Config
__destruct()
finish() : void
inherited_from | \Zend_ProgressBar_Adapter::finish() |
---|
finish() : void
getOutputStream() : resource
resource
notify(float $current, float $max, float $percent, integer $timeTaken, integer $timeRemaining, string $text) : void
inherited_from | \Zend_ProgressBar_Adapter::notify() |
---|
float
Current progress value
float
Max progress value
float
Current percent value
integer
Taken time in seconds
integer
Remaining time in seconds
string
Status text
notify(float $current, float $max, float $percent, integer $timeTaken, integer $timeRemaining, string $text) : void
float
Current progress value
float
Max progress value
float
Current percent value
integer
Taken time in seconds
integer
Remaining time in seconds
string
Status text
setBarIndicatorChar(string $char) : \Zend_ProgressBar_Adapter_Console
string
\Zend_ProgressBar_Adapter_Console
setBarLeftChar(string $char) : \Zend_ProgressBar_Adapter_Console
string
\Zend_ProgressBar_Adapter_Exception |
When character is empty |
---|
\Zend_ProgressBar_Adapter_Console
setBarRightChar(string $char) : \Zend_ProgressBar_Adapter_Console
string
\Zend_ProgressBar_Adapter_Exception |
When character is empty |
---|
\Zend_ProgressBar_Adapter_Console
setCharset(string $charset)
string
setConfig(\Zend_Config $config) : \Zend_ProgressBar_Adapter
\Zend_Config
\Zend_ProgressBar_Adapter
setElements(array $elements) : \Zend_ProgressBar_Adapter_Console
array
\Zend_ProgressBar_Adapter_Exception |
When an invalid element is foudn in the array |
---|
\Zend_ProgressBar_Adapter_Console
setFinishAction(string $action) : \Zend_ProgressBar_Adapter_Console
string
\Zend_ProgressBar_Adapter_Exception |
When an invalid action is specified |
---|
\Zend_ProgressBar_Adapter_Console
setOptions(array $options) : \Zend_ProgressBar_Adapter
array
\Zend_ProgressBar_Adapter
setOutputStream(string $resource) : \Zend_ProgressBar_Adapter_Console
string
\Zend_ProgressBar_Adapter_Console
setTextWidth(integer $width) : \Zend_ProgressBar_Adapter_Console
integer
\Zend_ProgressBar_Adapter_Console
setWidth(integer $width = null
) : \Zend_ProgressBar_Adapter_Console
integer
\Zend_ProgressBar_Adapter_Console
_calculateBarWidth() : void
_outputData(string $data) : void
This split-off is required for unit-testing.
string
$_charset : string
'utf-8'
$_elements : array
array(self::ELEMENT_PERCENT, self::ELEMENT_BAR, self::ELEMENT_ETA)
$_finishAction : string
self::FINISH_ACTION_EOL
$_outputStarted : boolean
false
$_outputStream : resource
null
$_skipOptions : array
array('options', 'config')
$_textWidth : string
20
$_width : integer
null
ELEMENT_BAR = 'ELEMENT_BAR'
ELEMENT_ETA = 'ELEMENT_ETA'
ELEMENT_PERCENT = 'ELEMENT_PERCENT'
ELEMENT_TEXT = 'ELEMENT_TEXT'
FINISH_ACTION_CLEAR_LINE = 'FINISH_ACTION_CLEAR_LINE'
FINISH_ACTION_EOL = 'FINISH_ACTION_EOL'
FINISH_ACTION_NONE = 'FINISH_ACTION_NONE'