Examples TOC examples

Model

$Date: 2005/07/25 10:25:30 $

Table of contents

Introduction
Render options
Ouput
PHP source syntax highlight

Introduction

This example requires :

PEAR::HTML_Progress 1.2.2 or better.

This example will run a horizontal ProgressBar, with limits (min = 0, max = 60) and increment set to 5 in the mathematical model TimerProgress.

The custom string is center aligned at bottom side of the progress bar. Cells have default size and colors.

First introduction of progress handler (user-callback). Function is defined on lines 21 thru 38, and attached on progress bar at line 45.

Render options

Here are options to build this progress bar string (percent text info):

width  = 170
height = 20
valign = bottom
align  = center

HTML_Progress_UI::setStringAttributes()

Output

Screenshot

PHP source syntax highlight

<?php
/**
 * ProgressBar model example.
 *
 * @version    $Id: model.php,v 1.2 2005/07/25 10:25:30 farell Exp $
 * @author     Laurent Laville <pear@laurent-laville.org>
 * @package    HTML_Progress
 * @subpackage Examples
 */
 
require_once 'HTML/Progress.php';
 
class TimerProgress extends HTML_Progress_DM
{
    function TimerProgress()
    {
        $this->HTML_Progress_DM(0,60,5);
    }
}
 
function myFunctionHandler($progressValue, &$obj)
{
    if ($obj->getPercentComplete() == 0.25) {
        $obj->setString('Fourth part way done!');
    }
    if ($obj->getPercentComplete() == 0.5) {
        $obj->setString('Half way done!');
    }
    if ($obj->getPercentComplete() == 0.75) {
        $obj->setString('Three quarters way done!');
    }
    if ($obj->getPercentComplete() == 1) {
        $obj->setString('All done!');
        $obj->display();
    } else {
        $obj->sleep();
    }
}
 
$timer = new TimerProgress();
$bar = new HTML_Progress($timer);
$bar->setAnimSpeed(100);
$bar->setStringPainted(true);          // get space for the string
$bar->setString('');                   // but don't paint it
$bar->setProgressHandler('myFunctionHandler');
 
$ui =& $bar->getUI();
$ui->setTab('    ');
$ui->setStringAttributes('width=170 height=20 valign=bottom align=center');
?>
<html>
<head>
<title>ProgressBar model example</title>
<style type="text/css">
<!--
<?php echo $bar->getStyle(); ?>
 
body {
    background-color: #FFFFFF;
    color: #000000;
    font-family: Verdana, Arial;
}
 
a:visited, a:active, a:link {
    color: navy;
}
// -->
</style>
<script type="text/javascript">
<!--
<?php echo $bar->getScript(); ?>
//-->
</script>
</head>
<body>
 
<?php
echo $bar->toHtml();
$bar->run();
?>
 
</body>
</html>