Abstract class for Zend_ProgressBar_Adapters

category Zend
package Zend_ProgressBar
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Create a new 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.

Parameters

$options

nullarray\Zend_Config

Called when the progress is explicitly finished

finish() : void

Notify the adapter about an update

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

Parameters

$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

Set options via a Zend_Config instance

setConfig(\Zend_Config $config) : \Zend_ProgressBar_Adapter

Parameters

$config

\Zend_Config

Returns

\Zend_ProgressBar_Adapter

Set options via an array

setOptions(array $options) : \Zend_ProgressBar_Adapter

Parameters

$options

array

Returns

\Zend_ProgressBar_Adapter

 Properties

 

Option keys to skip when calling setOptions()

$_skipOptions : array

Default

array('options', 'config')