Zend Framework  1.12
Public Member Functions | Protected Attributes | List of all members
Zend_ProgressBar_Adapter Class Reference

Public Member Functions

 __construct ($options=null)
 Create a new adapter.
 
 setConfig (Zend_Config $config)
 Set options via a Zend_Config instance.
 
 setOptions (array $options)
 Set options via an array.
 
 notify ($current, $max, $percent, $timeTaken, $timeRemaining, $text)
 Notify the adapter about an update.
 
 finish ()
 Called when the progress is explicitly finished.
 

Protected Attributes

 $_skipOptions
 

Constructor & Destructor Documentation

__construct (   $options = null)

Create a new adapter.

$options may be either be an array or a Zend_Config object which specifies adapter related options.

Parameters
null | array | Zend_Config$options

Member Function Documentation

finish ( )
abstract

Called when the progress is explicitly finished.

Returns
void
notify (   $current,
  $max,
  $percent,
  $timeTaken,
  $timeRemaining,
  $text 
)
abstract

Notify the adapter about an update.

Parameters
float$currentCurrent progress value
float$maxMax progress value
float$percentCurrent percent value
integer$timeTakenTaken time in seconds
integer$timeRemainingRemaining time in seconds
string$textStatus text
Returns
void
setConfig ( Zend_Config  $config)

Set options via a Zend_Config instance.

Parameters
Zend_Config$config
Returns
Zend_ProgressBar_Adapter
setOptions ( array  $options)

Set options via an array.

Parameters
array$options
Returns
Zend_ProgressBar_Adapter

Member Data Documentation

$_skipOptions
protected
Initial value:
= array(
'options',
'config',
)