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

set 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
str string

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%.

If you have provided a custom progress string and want to revert to the built-in-behavior, set the string back to null.

The progress string is painted only if the isStringPainted() method returns TRUE.

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. <!DOCTYPE html
    14. 

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

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

  16.  
    17. 

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

  18. <head>
    19. 

  19. <title>setString example</title>
    20. 

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

  21. <!--
    22. 

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

  23. // -->
    24. 

  24. </style>
    25. 

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

  26. <!--
    27. 

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

  28. //-->
    29. 

  29. </script>
    30. 

  30. </head>
    31. 

  31. <body>
    32. 

  32.  
    33. 

  33. <?php 
    34. 

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

  35.  
    36. 

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

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

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

  39.  
    40. 

  40. do {
    41. 

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

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

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

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

  45.  
    46. 

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

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

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

  49.     }
    50. 

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

  51. } while(1);
    52. 

  52. ?>
    53. 

  53.  
    54. 

  54. </body>
    55. 

  55. </html>
    56.

See Also

getString Manual, isStringPainted Manual, setStringPainted Manual

Prev Up Next
getString Manual Reference Guides isStringPainted Manual
Documentation generated on Mon, 11 Mar 2019 10:15:04 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.