ProgressBar.php
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_ProgressBar
- version
- $Id: ProgressBar.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_ProgressBar
Description
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 license@zend.com so we can send you a copy immediately.
Zend_ProgressBar
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_ProgressBar
- Properties
- $_min
- $_max
- $_current
- $_startTime
- $_statusText
- $_adapter
- $_persistenceNamespace
- Methods
- __construct
- getAdapter
- update
- next
- finish
Description
Zend_ProgressBar offers an interface for multiple enviroments.
Properties
$_adapter
Zend_ProgressBar_Adapter $_adapter = ''Adapter for the output
Details
- $_adapter
-
Zend_ProgressBar_Adapter
- visibility
- protected
- default
- final
- false
- static
- false
$_current
float $_current = ''Current value
Details
- $_current
- float
- visibility
- protected
- default
- final
- false
- static
- false
$_max
float $_max = ''Max value
Details
- $_max
- float
- visibility
- protected
- default
- final
- false
- static
- false
$_min
float $_min = ''Min value
Details
- $_min
- float
- visibility
- protected
- default
- final
- false
- static
- false
$_persistenceNamespace
string $_persistenceNamespace = 'null'Namespace for keeping the progressbar persistent
Details
- $_persistenceNamespace
- string
- visibility
- protected
- default
- null
- final
- false
- static
- false
$_startTime
integer $_startTime = ''Start time of the progressbar, required for ETA
Details
- $_startTime
- integer
- visibility
- protected
- default
- final
- false
- static
- false
$_statusText
string $_statusText = 'null'Current status text
Details
- $_statusText
- string
- visibility
- protected
- default
- null
- final
- false
- static
- false
Methods
__construct
__construct(
Zend_ProgressBar_Adapter $adapter, float $min
=
0, float $max
=
100, string $persistenceNamespace
=
null
)
:
Create a new progressbar backend.
Arguments
- $adapter
- Zend_ProgressBar_Adapter
- $min
- float
- $max
- float
- $persistenceNamespace
- string
Details
- visibility
- public
- final
- false
- static
- false
- throws
- When $min is greater than $max
finish
finish(
)
:
voidCall the adapters finish() behaviour
Details
- visibility
- public
- final
- false
- static
- false
getAdapter
getAdapter(
)
:
Zend_ProgressBar_AdapterGet the current adapter
Output
Details
- visibility
- public
- final
- false
- static
- false
next
next(
$diff
=
1, string $text
=
null
)
:
voidUpdate the progressbar to the next value
Arguments
- $diff
- $text
- string
Details
- visibility
- public
- final
- false
- static
- false
update
update(
float $value
=
null, string $text
=
null
)
:
voidUpdate the progressbar
Arguments
- $value
- float
- $text
- string
Details
- visibility
- public
- final
- false
- static
- false