ProgressBar.php
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_ProgressBar
- Version
- $Id$
\Zend_ProgressBar
Package: Zend_ProgressBar
Zend_ProgressBar offers an interface for multiple enviroments.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
string $_persistenceNamespace = null
Namespace for keeping the progressbar persistent
Default value
null
Details- Type
- string
Methods
__construct(\Zend_ProgressBar_Adapter $adapter, float $min = 0, float $max = 100, string $persistenceNamespace = null) : void
Create a new progressbar backend.
Parameters
Throws
Name | Type | Description |
---|---|---|
$adapter | \Zend_ProgressBar_Adapter | |
$min | float | |
$max | float | |
$persistenceNamespace | string |
Exception | Description |
---|---|
\Zend_ProgressBar_Exception | When $min is greater than $max |
getAdapter() : \Zend_ProgressBar_Adapter
Get the current adapter
Returns
Type | Description |
---|---|
\Zend_ProgressBar_Adapter |
next( $diff = 1, string $text = null) : void
Update the progressbar to the next value
Parameters
Name | Type | Description |
---|---|---|
$diff | ||
$text | string |