PEAR Progress2 logo

HTML_Progress2 : The Definitive Guide

HTML_Progress2::getPercentComplete
Prev  Go to next step  Next

Name

HTML_Progress2::getPercentComplete — Returns the percent complete of the progress meter

Synopsis 

      require_once 'HTML/Progress2.php';
float HTML_Progress2::getPercentComplete( $float = TRUE);  
boolean   $float = TRUE;

Description

Note that this number is between 0.00 and 1.00 when $float = true. And this number is between 0 and 100 when $float = false.

Parameter

boolean $float

(optional) float or integer format

See

see HTML_Progress2::getValue , HTML_Progress2::getMaximum

Throws

throws HTML_PROGRESS2_ERROR_INVALID_INPUT

Note

since 2.0.0

This function can not be called statically.

HTML_Progress2 : The Definitive Guide v 2.4.0 : April 20, 2007
Prev  Up  Next
HTML_Progress2::moveNext  Home  Graphical Handler