HTML_Progress
[ class tree: HTML_Progress ] [ index: HTML_Progress ] [ all elements ]
Prev Next
HTML_Progress::setMinimum
sets the new progress meter minimum value

Synopsis

require_once 'HTML/Progress.php';

void HTML_Progress::setMinimum( integer $min)

Description

This method is used to set the minimal value in the mathematical model of the progress meter.

Parameter

    integer $min
  • the new progress meter minimum value.

Throws

Possible PEAR_Error values

Error level Error code Error message Solution
exception HTML_PROGRESS_ERROR_INVALID_INPUT invalid input, parameter #1 "$min" was expecting "integer" Fixed the cast of parameter
error HTML_PROGRESS_ERROR_INVALID_INPUT invalid input, parameter #1 "$min" was expecting "positive" Give an integer greater than zero
error HTML_PROGRESS_ERROR_INVALID_INPUT invalid input, parameter #1 "$min" was expecting "less than max" Give an integer between zero and max. value

Note

( HTML_Progress >= 1.0 )

This function can not be called statically.

If the minimum value is different from previous minimum, all change listeners are notified.

This method is also a wrapper for HTML_Progress_DM::setMinimum.

See

HTML_Progress::getMinimum

Example

  1. <?php
  2. require_once 'HTML/Progress.php';
  3.  
  4. $bar = new HTML_Progress();
  5.  
  6. $bar->setMinimum(20);
  7. printf('direct way: minimum = %d <br/>', $bar->getMinimum());
  8.  
  9. $dm =& $bar->getDM();
  10. $dm->setMinimum(20);
  11. printf('another way: minimum = %d <br/>', $dm->getMinimum());
  12. ?>

Prev Up Next
HTML_Progress::getMinimum Reference Guide HTML_Progress::getValue

Documentation generated on Sun, 12 Sep 2004 20:23:17 +0200 by phpDocumentor 1.3.0RC3