Public Member Functions | Protected Attributes

Zend_ProgressBar Class Reference

Public Member Functions

 __construct (Zend_ProgressBar_Adapter $adapter, $min=0, $max=100, $persistenceNamespace=null)
 getAdapter ()
 update ($value=null, $text=null)
 next ($diff=1, $text=null)
 finish ()

Protected Attributes

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

Detailed Description

Definition at line 28 of file ProgressBar.php.


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

Definition at line 88 of file ProgressBar.php.


Member Function Documentation

finish (  )

Call the adapters finish() behaviour

Returns:
void

Definition at line 201 of file ProgressBar.php.

getAdapter (  )

Get the current adapter

Returns:
Zend_ProgressBar_Adapter

Definition at line 135 of file ProgressBar.php.

next ( diff = 1,
text = null 
)

Update the progressbar to the next value

Parameters:
string$text
Returns:
void

Definition at line 191 of file ProgressBar.php.

update ( value = null,
text = null 
)

Update the progressbar

Parameters:
float$value
string$text
Returns:
void

Definition at line 147 of file ProgressBar.php.


The documentation for this class was generated from the following file: