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

Public Member Functions

 __construct (Zend_ProgressBar_Adapter $adapter, $min=0, $max=100, $persistenceNamespace=null)
 Create a new progressbar backend.
 
 getAdapter ()
 Get the current adapter.
 
 update ($value=null, $text=null)
 Update the progressbar.
 
 next ($diff=1, $text=null)
 Update the progressbar to the next value.
 
 finish ()
 Call the adapters finish() behaviour.
 

Protected Attributes

 $_min
 
 $_max
 
 $_current
 
 $_startTime
 
 $_statusText = null
 
 $_adapter
 
 $_persistenceNamespace = null
 

Constructor & Destructor Documentation

__construct ( Zend_ProgressBar_Adapter  $adapter,
  $min = 0,
  $max = 100,
  $persistenceNamespace = null 
)

Create a new progressbar backend.

Parameters
Zend_ProgressBar_Adapter$adapter
float$min
float$max
string$persistenceNamespace
Exceptions
Zend_ProgressBar_ExceptionWhen $min is greater than $max

Member Function Documentation

finish ( )

Call the adapters finish() behaviour.

Returns
void
getAdapter ( )

Get the current adapter.

Returns
Zend_ProgressBar_Adapter
next (   $diff = 1,
  $text = null 
)

Update the progressbar to the next value.

Parameters
string$text
Returns
void
update (   $value = null,
  $text = null 
)

Update the progressbar.

Parameters
float$value
string$text
Returns
void

Member Data Documentation

$_adapter
protected
$_current
protected
$_max
protected
$_min
protected
$_persistenceNamespace = null
protected
$_startTime
protected
$_statusText = null
protected