API Documentation

Zend/ProgressBar.php

Show: inherited
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 license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_ProgressBar  
Version
$Id: ProgressBar.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_ProgressBar

Package: Zend\ProgressBar

Zend_ProgressBar offers an interface for multiple enviroments.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected\Zend_ProgressBar_Adapter  $_adapter= ''

Adapter for the output

Propertyprotectedfloat  $_current= ''

Current value

Details
Type
float
Propertyprotectedfloat  $_max= ''

Max value

Details
Type
float
Propertyprotectedfloat  $_min= ''

Min value

Details
Type
float
Propertyprotectedstring  $_persistenceNamespace= 'null'

Namespace for keeping the progressbar persistent

Default valuenullDetails
Type
string
Propertyprotectedinteger  $_startTime= ''

Start time of the progressbar, required for ETA

Details
Type
integer
Propertyprotectedstring  $_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
Name Type Description
$adapter \Zend_ProgressBar_Adapter
$min float
$max float
$persistenceNamespace string
Throws
Exception Description
\Zend_ProgressBar_Exception When $min is greater than $max
methodpublicfinish( ) : void

Call the adapters finish() behaviour

methodpublicgetAdapter( ) : \Zend_ProgressBar_Adapter

Get the current adapter

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

Update the progressbar to the next value

Parameters
Name Type Description
$diff
$text string
methodpublicupdate( float $value = null, string $text = null ) : void

Update the progressbar

Parameters
Name Type Description
$value float
$text string
Documentation was generated by DocBlox 0.15.1.