ProgressBar.php

Show: PublicProtectedPrivateinherited
Table of Contents
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

>VPropertyprotected\Zend_ProgressBar_Adapter $_adapter
Adapter for the output
>VPropertyprotectedfloat $_current
Current value
Details
Type
float
>VPropertyprotectedfloat $_max
Max value
Details
Type
float
>VPropertyprotectedfloat $_min
Min value
Details
Type
float
>VPropertyprotectedstring $_persistenceNamespace = null
Namespace for keeping the progressbar persistent
Default valuenullDetails
Type
string
>VPropertyprotectedinteger $_startTime
Start time of the progressbar, required for ETA
Details
Type
integer
>VPropertyprotectedstring $_statusText = null
Current status text
Default valuenullDetails
Type
string

Methods

methodpublic__construct(\Zend_ProgressBar_Adapter $adapter, float $min = 0, float $max = 100, string $persistenceNamespace = null) : void

Create a new progressbar backend.

Parameters
NameTypeDescription
$adapter\Zend_ProgressBar_Adapter
$minfloat
$maxfloat
$persistenceNamespacestring
Throws
ExceptionDescription
\Zend_ProgressBar_ExceptionWhen $min is greater than $max
methodpublicfinish() : void

Call the adapters finish() behaviour

methodpublicgetAdapter() : \Zend_ProgressBar_Adapter

Get the current adapter

Returns
TypeDescription
\Zend_ProgressBar_Adapter
methodpublicnext( $diff = 1, string $text = null) : void

Update the progressbar to the next value

Parameters
NameTypeDescription
$diff
$textstring
methodpublicupdate(float $value = null, string $text = null) : void

Update the progressbar

Parameters
NameTypeDescription
$valuefloat
$textstring
Documentation was generated by phpDocumentor 2.2.0 .