LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Zend_ProgressBar_Adapter_Console offers a text-based progressbar for console applications

string
$_barIndicatorChar= ''''
Indicator character(s) within the bar
''
Details
array
$_elements= 'array(self::ELEMENT_PERCENT'
Elements to display
array(self::ELEMENT_PERCENT
Details
string
$_finishAction= 'self::FINISH_ACTION_EOL'
Which action to do at finish call
self::FINISH_ACTION_EOL
Details
boolean
$_outputStarted= 'false'
Wether the output started yet or not
false
Details
resource
$_outputStream= 'null'
Output-stream, when STDOUT is not defined (e.g. in CGI) or set manually
null
Details
__construct(
null|array|\Zend_Config $options
=
null
)
:
void
Defined by Zend_ProgressBar_Adapter
Name | Type | Description |
---|---|---|
$options | null|array|\Zend_Config |

_outputData(
string $data
)
:
void
Outputs given data to STDOUT.
This split-off is required for unit-testing.
Name | Type | Description |
---|---|---|
$data | string |

notify(
float $current, float $max, float $percent, integer $timeTaken, integer $timeRemaining, string $text
)
:
void
Defined by Zend_ProgressBar_Adapter_Interface
Name | Type | Description |
---|---|---|
$current | float | Current progress value |
$max | float | Max progress value |
$percent | float | Current percent value |
$timeTaken | integer | Taken time in seconds |
$timeRemaining | integer | Remaining time in seconds |
$text | string | Status text |

setBarIndicatorChar(
string $char
)
:
\Zend_ProgressBar_Adapter_Console
Set the indicator character for the bar
Name | Type | Description |
---|---|---|
$char | string |
Type | Description |
---|---|
\Zend_ProgressBar_Adapter_Console |

setBarLeftChar(
string $char
)
:
\Zend_ProgressBar_Adapter_Console
Set the left-hand character for the bar
Name | Type | Description |
---|---|---|
$char | string |
Type | Description |
---|---|
\Zend_ProgressBar_Adapter_Console |
Exception | Description |
---|---|
\Zend_ProgressBar_Adapter_Exception | When character is empty |

setBarRightChar(
string $char
)
:
\Zend_ProgressBar_Adapter_Console
Set the right-hand character for the bar
Name | Type | Description |
---|---|---|
$char | string |
Type | Description |
---|---|
\Zend_ProgressBar_Adapter_Console |
Exception | Description |
---|---|
\Zend_ProgressBar_Adapter_Exception | When character is empty |

setCharset(
string $charset
)
:
void
Set the charset of the text element
Name | Type | Description |
---|---|---|
$charset | string |

setElements(
array $elements
)
:
\Zend_ProgressBar_Adapter_Console
Set the elements to display with the progressbar
Name | Type | Description |
---|---|---|
$elements | array |
Type | Description |
---|---|
\Zend_ProgressBar_Adapter_Console |
Exception | Description |
---|---|
\Zend_ProgressBar_Adapter_Exception | When an invalid element is foudn in the array |

setFinishAction(
string $action
)
:
\Zend_ProgressBar_Adapter_Console
Set the finish action
Name | Type | Description |
---|---|---|
$action | string |
Type | Description |
---|---|
\Zend_ProgressBar_Adapter_Console |
Exception | Description |
---|---|
\Zend_ProgressBar_Adapter_Exception | When an invalid action is specified |

setOutputStream(
string $resource
)
:
\Zend_ProgressBar_Adapter_Console
Set a different output-stream
Name | Type | Description |
---|---|---|
$resource | string |
Type | Description |
---|---|
\Zend_ProgressBar_Adapter_Console |

setTextWidth(
integer $width
)
:
\Zend_ProgressBar_Adapter_Console
Set the width of the text element
Name | Type | Description |
---|---|---|
$width | integer |
Type | Description |
---|---|
\Zend_ProgressBar_Adapter_Console |

setWidth(
integer $width
=
null
)
:
\Zend_ProgressBar_Adapter_Console
Set the width of the progressbar
Name | Type | Description |
---|---|---|
$width | integer |
Type | Description |
---|---|
\Zend_ProgressBar_Adapter_Console |