HTML_Progress
[ class tree: HTML_Progress ] [ index: HTML_Progress ] [ all elements ]
Packages:
HTML_Progress


Tutorials/Manuals:
Package-level: Class-level: Classes:
HTML_Progress
   Bar1Observer
   MyObserver
   TimerProgress
Progress_UI
   ActionDisplay
   ActionPreview
   ActionProcess
Progress_DM
   HTML_Progress_DM
Progress_Observer
   HTML_Progress_Observer
Progress_Default2
Files:
ancestor.php
bgimages.php
bluesand.php
bluesandplus.php
bullit.php
circleback.php
circleplain.php
constructor_basic.php
constructor_horizontal_limit.php
constructor_model.php
constructor_vertical.php
constructor_vertical_limit.php
display_errors.php
ellipse.php
form_output.php
generator_custom.php
generator_default.php
generator_embedded.php
generator_htmlpage.php
generator_itdynamic.php
generator_smartydynamic.php
horizontal_nostring.php
horizontal_string.php
indeterminate.php
javadanse.php
log_errors.php
monitor_complex.php
monitor_default1.php
monitor_default2.php
monitor_function_callback.php
monitor_htmlpage.php
monitor_itdynamic.php
monitor_method_callback.php
monitor_simple.php
multiple_vertical.php
observer_complex.php
observer_simple.php
observer_standard.php
Progress.php
progressHandler.php
ProgressMaker.php
progressModels.php
rectangle.php
rectangleback.php
redsandback.php
smallest.php
square.php
squareback.php
template_embedded.php
uploader1.php
uploader2.php
uploader_default1.php
uploader_default2.php
uploader_itdynamic1.php
uploader_itdynamic2.php

subpackage Progress_DM
DM.php

subpackage Progress_Observer
monitor.php
observer.php
uploader.php

subpackage Progress_UI
default.php
generator.php
HTMLPage.php
ITDynamic.php
model.php
pages.php
preview.php
process.php
SmartyDynamic.php
UI.php

Prev Next

setString Manual

sets the current value of the progress string

by by Laurent Laville
mailto:pear@laurent-laville.org
 November 2003, Laurent Laville
(HTML_Progress 1.0+)

Synopsis

void setString( $str )

Attributes

Name Type Default
str  string   Null  

Description

The setString() method is used to print a custom string. The default value is null, that means the progress bar displays the value returned by HTML_Progress::getPercentComplete() method formatted as a percent such as 33%.

Example

Example below will produced a progress bar with a custom string. It's a dynamic example, the progress bar will run. 

  1. <?php 
    2. 

  2. require_once ('HTML/Progress.php');
    3. 

  3.  
    4. 

  4. $bar = new HTML_Progress();
    5. 

  5. $bar->setAnimSpeed(100);
    6. 

  6. $bar->setIncrement(5);
    7. 

  7. $bar->setStringPainted(true);          // get space for the string
    8. 

  8. $bar->setString('');                   // but don't paint it
    9. 

  9.  
    10. 

  10. $ui =& $bar->getUI();
    11. 

  11. $ui->setStringAttributes('width=350 align=left');
    12. 

  12.  
    13. 

  13. ?>
    14. 

  14. <!DOCTYPE html
    15. 

  15.     PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    16. 

  16.     "http://www.w3c.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
    17. 

  17.  
    18. 

  18. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
    19. 

  19. <head>
    20. 

  20. <title>Horizontal String ProgressBar example</title>
    21. 

  21. <style type="text/css">
    22. 

  22. <!--
    23. 

  23. <?php echo $bar->getStyle(); ?>
    24. 

  24. // -->
    25. 

  25. </style>
    26. 

  26. <script type="text/javascript">
    27. 

  27. <!--
    28. 

  28. <?php echo $bar->getScript(); ?>
    29. 

  29. //-->
    30. 

  30. </script>
    31. 

  31. </head>
    32. 

  32. <body>
    33. 

  33.  
    34. 

  34. <?php 
    35. 

  35. echo $bar->toHtml(); 
    36. 

  36.  
    37. 

  37. $pkg = array('PEAR', 'Archive_Tar', 'Config', 
    38. 

  38.     'HTML_QuickForm', 'HTML_CSS', 'HTML_Page', 'HTML_Template_Sigma', 
    39. 

  39.     'Log', 'MDB', 'PHPUnit');
    40. 

  40.  
    41. 

  41. do {
    42. 

  42.     $val = $bar->getValue();
    43. 

  43.     $i = floor($val / 10);
    44. 

  44.     $msg = ($val == 100) ? '' : "&nbsp; installing package ($val %) ... : ".$pkg[$i];
    45. 

  45.     $bar->setString($msg);
    46. 

  46.  
    47. 

  47.     $bar->display();
    48. 

  48.     if ($bar->getPercentComplete() == 1) {
    49. 

  49.         break;   // the progress bar has reached 100%
    50. 

  50.     }
    51. 

  51.     $bar->incValue();
    52. 

  52. } while(1);
    53. 

  53. ?>
    54. 

  54.  
    55. 

  55. </body>
    56. 

  56. </html>
    57.

See Also

Take care that setString() method is not enough to display a custom string. You should also decide to paint the custom string. To do it, see setStringPainted Manual.

Prev   Next
setStringAttributes Manual getStringAttributes Manual
Documentation generated on Mon, 11 Mar 2019 10:15:06 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.