ProgressBar/Adapter/Console.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_ProgressBar
version: $Id: Console.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_ProgressBar_Adapter_Console

Description

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
jump to top

Extends from: Zend_ProgressBar_Adapter
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_ProgressBar
uses: Zend_ProgressBar_Adapter_Interface
Constants: ELEMENT_PERCENT; ELEMENT_BAR; ELEMENT_ETA; ELEMENT_TEXT; FINISH_ACTION_EOL; FINISH_ACTION_CLEAR_LINE; FINISH_ACTION_NONE
Properties: $_width; $_elements; $_finishAction; $_barWidth; $_barLeftChar; $_barIndicatorChar; $_barRightChar; $_outputStream; $_textWidth; $_outputStarted; $_charset
Methods: __construct; __destruct; setOutputStream; getOutputStream; setWidth; setElements; setBarLeftChar; setBarRightChar; setBarIndicatorChar; setTextWidth; setCharset; setFinishAction; notify; finish; _calculateBarWidth; _outputData

Description

Zend_ProgressBar_Adapter_Console offers a text-based progressbar for console applications

Constants

ELEMENT_PERCENT
jump to class

 ELEMENT_PERCENT = 'ELEMENT_PERCENT'

Percentage value of the progress

Details

value: ELEMENT_PERCENT

ELEMENT_BAR
jump to class

 ELEMENT_BAR = 'ELEMENT_BAR'

Visual value of the progress

Details

value: ELEMENT_BAR

ELEMENT_ETA
jump to class

 ELEMENT_ETA = 'ELEMENT_ETA'

ETA of the progress

Details

value: ELEMENT_ETA

ELEMENT_TEXT
jump to class

 ELEMENT_TEXT = 'ELEMENT_TEXT'

Text part of the progress

Details

value: ELEMENT_TEXT

FINISH_ACTION_EOL
jump to class

 FINISH_ACTION_EOL = 'FINISH_ACTION_EOL'

Finish action: End of Line

Details

value: FINISH_ACTION_EOL

FINISH_ACTION_CLEAR_LINE
jump to class

 FINISH_ACTION_CLEAR_LINE = 'FINISH_ACTION_CLEAR_LINE'

Finish action: Clear Line

Details

value: FINISH_ACTION_CLEAR_LINE

FINISH_ACTION_NONE
jump to class

 FINISH_ACTION_NONE = 'FINISH_ACTION_NONE'

Finish action: None

Details

value: FINISH_ACTION_NONE

Properties

$_barIndicatorChar
jump to class

string $_barIndicatorChar = ''

Indicator character(s) within the bar

Details

$_barIndicatorChar: string
visibility: protected
default
final: false
static: false

$_barLeftChar
jump to class

string $_barLeftChar = '#'

Left character(s) within the bar

Details

$_barLeftChar: string
visibility: protected
default: #
final: false
static: false

$_barRightChar
jump to class

string $_barRightChar = '-'

Right character(s) within the bar

Details

$_barRightChar: string
visibility: protected
default: -
final: false
static: false

$_barWidth
jump to class

integer $_barWidth = ''

Width of the bar element

Details

$_barWidth: integer
visibility: protected
default
final: false
static: false

$_charset
jump to class

string $_charset = 'utf-8'

Charset of text element

Details

$_charset: string
visibility: protected
default: utf-8
final: false
static: false

$_elements
jump to class

array $_elements = 'array'

Elements to display

Details

$_elements: array
visibility: protected
default: array
final: false
static: false

$_finishAction
jump to class

string $_finishAction = 'self'

Which action to do at finish call

Details

$_finishAction: string
visibility: protected
default: self
final: false
static: false

$_outputStarted
jump to class

boolean $_outputStarted = 'false'

Wether the output started yet or not

Details

$_outputStarted: boolean
visibility: protected
default: false
final: false
static: false

$_outputStream
jump to class

resource $_outputStream = 'null'

Output-stream, when STDOUT is not defined (e.g. in CGI) or set manually

Details

$_outputStream: resource
visibility: protected
default: null
final: false
static: false

$_textWidth
jump to class

string $_textWidth = '20'

Width of the text element

Details

$_textWidth: string
visibility: protected
default: 20
final: false
static: false

$_width
jump to class

integer $_width = 'null'

Width of the progressbar

Details

$_width: integer
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
          null|array|Zend_Config $options
              =
              null
          )
        
        :

Defined by Zend_ProgressBar_Adapter

Arguments

$options: nullarrayZend_Config

Details

visibility: public
final: false
static: false

__destruct
jump to class

__destruct(
          
          )
        
        :

Close local stdout, when open

Details

visibility: public
final: false
static: false

_calculateBarWidth
jump to class

_calculateBarWidth(
          
          )
        
        :
        void

Calculate the bar width when other elements changed

Details

visibility: protected
final: false
static: false

_outputData
jump to class

_outputData(
          string $data
          )
        
        :
        void

Outputs given data to STDOUT.

This split-off is required for unit-testing.

Arguments

$data: string

Details

visibility: protected
final: false
static: false

finish
jump to class

finish(
          
          )
        
        :
        void

Defined by Zend_ProgressBar_Adapter_Interface

Details

visibility: public
final: false
static: false

getOutputStream
jump to class

getOutputStream(
          
          )
        
        :
        resource

Get the current output stream

Output

resource

Details

visibility: public
final: false
static: false

notify
jump to class

notify(
          float $current, float $max, float $percent, integer $timeTaken, integer $timeRemaining, string $text
          )
        
        :
        void

Defined by Zend_ProgressBar_Adapter_Interface

Arguments

$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

Details

visibility: public
final: false
static: false

setBarIndicatorChar
jump to class

setBarIndicatorChar(
          string $char
          )
        
        :
        Zend_ProgressBar_Adapter_Console

Set the indicator character for the bar

Arguments

$char: string

Output

Zend_ProgressBar_Adapter_Console

Details

visibility: public
final: false
static: false

setBarLeftChar
jump to class

setBarLeftChar(
          string $char
          )
        
        :
        Zend_ProgressBar_Adapter_Console

Set the left-hand character for the bar

Arguments

$char: string

Output

Zend_ProgressBar_Adapter_Console

Details

visibility: public
final: false
static: false
throws: When character is empty

setBarRightChar
jump to class

setBarRightChar(
          string $char
          )
        
        :
        Zend_ProgressBar_Adapter_Console

Set the right-hand character for the bar

Arguments

$char: string

Output

Zend_ProgressBar_Adapter_Console

Details

visibility: public
final: false
static: false
throws: When character is empty

setCharset
jump to class

setCharset(
          string $charset
          )
        
        :

Set the charset of the text element

Arguments

$charset: string

Details

visibility: public
final: false
static: false

setElements
jump to class

setElements(
          array $elements
          )
        
        :
        Zend_ProgressBar_Adapter_Console

Set the elements to display with the progressbar

Arguments

$elements: array

Output

Zend_ProgressBar_Adapter_Console

Details

visibility: public
final: false
static: false
throws: When an invalid element is foudn in the array

setFinishAction
jump to class

setFinishAction(
          string $action
          )
        
        :
        Zend_ProgressBar_Adapter_Console

Set the finish action

Arguments

$action: string

Output

Zend_ProgressBar_Adapter_Console

Details

visibility: public
final: false
static: false
throws: When an invalid action is specified

setOutputStream
jump to class

setOutputStream(
          string $resource
          )
        
        :
        Zend_ProgressBar_Adapter_Console

Set a different output-stream

Arguments

$resource: string

Output

Zend_ProgressBar_Adapter_Console

Details

visibility: public
final: false
static: false

setTextWidth
jump to class

setTextWidth(
          integer $width
          )
        
        :
        Zend_ProgressBar_Adapter_Console

Set the width of the text element

Arguments

$width: integer

Output

Zend_ProgressBar_Adapter_Console

Details

visibility: public
final: false
static: false

setWidth
jump to class

setWidth(
          integer $width
              =
              null
          )
        
        :
        Zend_ProgressBar_Adapter_Console

Set the width of the progressbar

Arguments

$width: integer

Output

Zend_ProgressBar_Adapter_Console

Details

visibility: public
final: false
static: false

API Documentation

ProgressBar/Adapter/Console.php

Description

Zend_ProgressBar_Adapter_Consolejump to top

Description

Constants

ELEMENT_PERCENTjump to class

Details

ELEMENT_BARjump to class

Details

ELEMENT_ETAjump to class

Details

ELEMENT_TEXTjump to class

Details

FINISH_ACTION_EOLjump to class

Details

FINISH_ACTION_CLEAR_LINEjump to class

Details

FINISH_ACTION_NONEjump to class

Details

Properties

$_barIndicatorCharjump to class

Details

$_barLeftCharjump to class

Details

$_barRightCharjump to class

Details

$_barWidthjump to class

Details

$_charsetjump to class

Details

$_elementsjump to class

Details

$_finishActionjump to class

Details

$_outputStartedjump to class

Details

$_outputStreamjump to class

Details

$_textWidthjump to class

Details

$_widthjump to class

Details

Methods

__constructjump to class

Arguments

Details

__destructjump to class

Details

_calculateBarWidthjump to class

Details

_outputDatajump to class

Arguments

Details

finishjump to class

Details

getOutputStreamjump to class

Output

Details

notifyjump to class

Arguments

Details

setBarIndicatorCharjump to class

Arguments

Output

Details

setBarLeftCharjump to class

Arguments

Output

Details

setBarRightCharjump to class

Arguments

Output

Details

setCharsetjump to class

Arguments

Details

setElementsjump to class

Arguments

Output

Zend_ProgressBar_Adapter_Console
jump to top

ELEMENT_PERCENT
jump to class

ELEMENT_BAR
jump to class

ELEMENT_ETA
jump to class

ELEMENT_TEXT
jump to class

FINISH_ACTION_EOL
jump to class

FINISH_ACTION_CLEAR_LINE
jump to class

FINISH_ACTION_NONE
jump to class

$_barIndicatorChar
jump to class

$_barLeftChar
jump to class

$_barRightChar
jump to class

$_barWidth
jump to class

$_charset
jump to class

$_elements
jump to class

$_finishAction
jump to class

$_outputStarted
jump to class

$_outputStream
jump to class

$_textWidth
jump to class

$_width
jump to class

__construct
jump to class

__destruct
jump to class

_calculateBarWidth
jump to class

_outputData
jump to class

finish
jump to class

getOutputStream
jump to class

notify
jump to class

setBarIndicatorChar
jump to class

setBarLeftChar
jump to class

setBarRightChar
jump to class

setCharset
jump to class

setElements
jump to class

setFinishAction
jump to class

setOutputStream
jump to class

setTextWidth
jump to class

setWidth
jump to class