Zend Framework  3.0
Public Member Functions | Protected Attributes | List of all members
ProgressBar Class Reference

Zend offers an interface for multiple environments. More...

Public Member Functions

 __construct (Adapter\AbstractAdapter $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
 

Detailed Description

Zend offers an interface for multiple environments.

Constructor & Destructor Documentation

__construct ( Adapter\AbstractAdapter  $adapter,
  $min = 0,
  $max = 100,
  $persistenceNamespace = null 
)

Create a new progressbar backend.

Parameters
Adapter\AbstractAdapter$adapter
float | int$min
float | int$max
string | null$persistenceNamespace
Exceptions
Exception\OutOfRangeExceptionWhen $min is greater than $max

Member Function Documentation

finish ( )

Call the adapters finish() behaviour.

Returns
void
getAdapter ( )

Get the current adapter.

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

Update the progressbar to the next value.

Parameters
int$diff
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