HTML_Progress::setIncrement

HTML_Progress

Prev |  | Next
HTML_Progress::setIncrement sets the new progress meter increment value ## Synopsis require_once 'HTML/Progress.php'; void HTML_Progress::setIncrement( int $inc) ## Description This method is used to set the increment value in the mathematical model of the progress meter. ## Parameter integer $inc the new progress meter increment value. ## Throws

Possible PEAR_Error values

Error level | Error code | Error message | Solution
exception | HTML_PROGRESS_ERROR_INVALID_INPUT | invalid input, parameter #1 "$inc" was expecting "integer" | Fixed the cast of parameter
error | HTML_PROGRESS_ERROR_INVALID_INPUT | invalid input, parameter #1 "$inc" was expecting "not equal zero" | Give an integer greater than zero
## Note ( HTML_Progress >= 1.0 )
| This function can not be called statically.
| This method is also a wrapper for HTML_Progress_DM::setIncrement.
## See HTML_Progress::getIncrement ## Example

    <?php
    require_once 'HTML/Progress.php';

    $bar = new HTML_Progress();

    $bar->setIncrement(10);
    printf('direct way: increment = %d <br/>', $bar->getIncrement());

    $dm =& $bar->getDM();
    $dm->setIncrement(10);
    printf('another way: increment = %d <br/>', $dm->getIncrement());
    ?>
Prev | Up | Next
HTML_Progress::getIncrement | Reference Guide | HTML_Progress::getMaximum
Documentation generated on Sun, 12 Sep 2004 20:23:15 +0200 by phpDocumentor 1.3.0RC3