Home » HTML » HTML_Progress

How to include a loading bar in your XHTML documents quickly and easily.

This package is unmaintained.

Download latest release 1.2.6 (archived versions might be outdated)

License: PHP License 3.0

Description

This package provides a way to add a loading bar fully customizable in existing XHTML documents.
Your browser should accept DHTML feature.

Features:
- create horizontal, vertival bar and also circle, ellipse and polygons (square, rectangle).
- allows usage of existing external StyleSheet and/or JavaScript.
- all elements (progress, cells, labels) are customizable by their html properties.
- percent/labels are floating all around the progress meter.
- compliant with all CSS/XHMTL standards.
- integration with all template engines is very easy.
- implements Observer design pattern. It is possible to add Listeners.
- adds a customizable monitor pattern to display a progress bar.
User-end can abort progress at any time.
- Look and feel can be sets by internal API or external config file
- allows many progress meter on same page without uses of iframe solution.

Maintainers

• Laurent Laville (farell) — lead, active
• Stefan Neufeind (neufeind) — contributor, active
• Christian Wenz (wenz) — helper, active

Dependencies

Required

• PHP (>= 4.2.0)
• PEAR Installer (>= 1.5.4)
• HTML_Common (>= 1.2.1)

Optional

• PEAR (>= 1.5.4)
• HTML_QuickForm (>= 3.2.4, exclude 3.2.4)
• HTML_QuickForm_Controller (>= 1.0.4)
• Image_Color (>= 1.0.1)
• HTML_Page2 (>= 0.5.0beta)
• HTML_Template_IT (>= 1.1)
• HTML_Template_Sigma (>= 1.1.2)
• Log (>= 1.8.7)
• Config (>= 1.10)
• gd (extension)

Releases

• 1.2.6 (stable, 2008-07-24)
  Release notes

  License: PHP License 3.0

  QA RELEASE

  As version 1 of the package.xml files will no longer be supported with
  the introduction of PEAR2/Pyrus, the PEAR Group required all packages
  be converted to version 2 by September 1st, 2008

  This version only add a version 2 of package.xml and upgrade some old dependencies.
  There are no new features or bug fixes.

• 1.2.5 (stable, 2005-11-01)
  Release notes

  License: PHP License 3.0

  * IMPORTANT
  - Version 1.2.4 or better is considered as deprecated in favour of HTML_Progress2 2.0.0
  A migration guide (and much more) exists in The Definitive (User) Guide available online
  at URI http://www.laurent-laville.org/pear/HTML_Progress2/docs/TDG/en/index.html

  * bugs
  - fixed bug #5654 : 'Passing by reference' notice error under PHP 4.4.0

• 1.2.4 (stable, 2005-10-01)
  Release notes

  License: PHP License 3.0

  * IMPORTANT
  - Version 1.2.4 is considered as deprecated in favour of HTML_Progress2 2.0.0
  A migration guide (and much more) exists in The Definitive (User) Guide available online
  at URI http://www.laurent-laville.org/pear/HTML_Progress2/docs/TDG/en/index.html

  * bugs
  - setBorderPainted(false) inefficient with setBorderAttributes()
  and a positive width attribute value. Always show a border
  arround the progress bar.

  * Quality Assurance
  - updates headers comment blocks

• 1.2.3 (stable, 2005-08-28)
  Release notes

  License: PHP License 3.0

  *IMPORTANT*
  This release should be the last one of the branch 1 of HTML_Progress, unless
  bugs are found. There are NO CODE CHANGES since version 1.2.2

  * changes
  - online documentation links were changed:
  . API (only) can be view at URI http://pear.laurent-laville.org/HTML_Progress/docs/API/
  . User Guide can be view at URI http://pear.laurent-laville.org/HTML_Progress/docs/TDG/
  - The User Guide also called The Definitive Guide (TDG) is an old version, but
  the HTML (many pages) and Windows Help Compiled versions are now included
  in the binary distribution (see docs/ directory).

  * Quality Assurance
  - API documentation auto-generation is back (no more 404 error on PEAR website)
  - improved API doc reading and removed unnecessary stuff (unit testcases, ...)

• 1.2.2 (stable, 2005-08-01)
  Release notes

  License: PHP License 3.0

  * bugs
  - fixed setMaximum with value higher than 200 when using a progress monitor (bug #4885)
  - fixed call time pass by reference error in progress monitor

  * changes
  - getPercentComplete() method has an optional parameter.
  Return may be float (default) or integer.
  - removed HTML_CSS dependency

  * improvements
  - generation of stylesheet is (average) 20 times faster without HTML_CSS

  * QA
  - Updates headers comment block on all files
  - Dependencies has been revisited to higher level
  - Fix wrong project links into documentation (README, ReleaseVersion)
  Thanks to Christian Roy to have noticed me.

• 1.2.1 (stable, 2005-05-15)
  Release notes

  License: PHP License 3.0

  Very few changes since 1.2.0

  * changes
  - fixed gd dependency check in pear install procedure
  explains are behind http://marc.theaimsgroup.com/?l=pear-dev&m=110924162309851&w=2
  - fixed bug#2577 Call time pass by reference error

• 1.2.0 (stable, 2004-09-12)
  Release notes

  License: PHP License 3.0

  * changes
  - PEAR_ErrorStack was replaced by a simple way to plug in any error handling system
  you might want (default used PEAR_Error object)
  - Log package dependency was removed (no more used for logging)
  - HTML_Progress_Model and HTML_Progress_Uploader classes were removed

  * improvements
  - HTML_Progress::sleep() method use now in most case the PHP usleep() function

  * news
  - The Definitive Guide:
  http://pear.laurent-laville.org/HTML_Progress/apidoc/
  HTML/ read it online the html version
  CHM/ download (190 kb) the Windows Help Compiled version
  PDF/ download (757 kb) the Acrobat Reader version

• 1.2.0RC3 (beta, 2004-07-05)
  Release notes

  License: PHP License 3.0

  * QA
  - package.xml should not contain md5sum or provides for readability

  * changes
  - suite of PHPUnit TestCases are now fully compatible with PHP5
  - method raiseError has a new optional parameter ( $msg: static message )

  * bugs fixes
  - missing ident class in stylesheet production in HTML_Progress::getStyle()
  - sometimes circle, ellipse segments pictures were generated with horiz. bottom line
  (it's no more exists)

  * new features
  - 2 new methods to easily manage API errors ( hasErrors(), getError() )
  - 1 new method to hide a progress meter when necessary ( request by JH Szeto )
  - 2 new methods to simplify your job: sleep(), run()
  - 2 new methods to introduce user-callback: process(), setProgressHandler()

  * to do
  - preload segments pictures before progress meter (circle, ellipse) start

• 1.2.0RC2 (beta, 2004-05-05)
  Release notes

  License: PHP License 3.0

  * important
  - unless someone found a new bug, this release candidate will be the last before
  publication of stable version

  * changes
  - suite of PHPUnit TestCases are now fully compatible with PEAR_ErrorStack
  - completed API docs with PHPDocumentor 1.3.0RC3

  * bug fixes
  - css problem for progress circle, ellipse. Thanks to Olivier Hondermarck
  (webmaster of http://www.toutjavascript.com)

• 1.2.0RC1 (beta, 2004-04-18)
  Release notes

  License: PHP License 3.0

  * TODO
  - this 1st RC is still marked as beta due to status of packages :
  . Net_FTP 1.3.0
  . PEAR_ErrorStack in PEAR 1.3.1

  and of course due to first try to generate Progress Circle as new shape with GD extension.
  PLEASE, i need feedback, and tests results on different platform, before a stable version
  is publish !
  - Make suite of PHPUnit TestCase compatible with PEAR_ErrorStack

  * changes
  - new error manager (PEAR_ErrorStack) replace previous Error_Raise package
  - Net_FTP package with observer pattern is used to replace my Progress/FTP/Upload class
  - new method HTML_Progress_UI::setCellCoordinates to manage polygonal cells coordinates
  - new method HTML_Progress_UI::drawCircleSegments to create circle pictures collection
  - HTML_Progress_Monitor::setAnimSpeed() method is now deprecated.
  Use HTML_Progress::setAnimSpeed() instead.
  - full API docs - reference guide - made with phpDocumentor 1.3.0RC3

  * feature additions
  - HTML_Progress now display new shapes like: circle, ellipse, square and rectangle.

  * dependencies
  - Net_FTP 1.3 or greater, to manage ftp communications for HTML_Progress_Uploader
  - PEAR 1.3.1 or greater for PEAR_ErrorStack, to manage errors
  instead of previous solution: Error_Raise
  - Log 1.8.0 or greater, to logs internal HTML_Progress errors
  - Image_Color 1.0.0 or greater to define circle segment colors
  - GD 2.0.1 or greater to use imagefilledarc function to draw circle segments

• 1.1 (stable, 2004-02-14)
  Release notes

  License: PHP License 3.0

  * changes
  - HTML_Progress_Generator become the next generation of interactive tools
  to dynamically build, run demo and save source-code of your own progress bar.
  - HTML_Progress (Monitor, Generator, Uploader) support now the QF renderer system
  for a better and easy presentation.

  * feature additions
  - HTML_Progress now implements a file upload solution trough a ftp connection,
  called HTML_Progress_Uploader.

  * dependencies
  - PHP 4.3 or greater, and ftp extension loaded is required if you use HTML_Progress_Uploader
  - HTML_CSS parser function in version 0.3.1 is required for HTML_Progress_Generator

  * credit
  - Tomas VV Cox for reused idea and part of his HTTP_Upload package code.

• 1.0 (stable, 2003-11-16)
  Release notes

  License: PHP License 3.0

  * changes
  - Errors are managed by Error_Raise package (by Greg Beaver).
  - ProgressMaker got some pre-sets UI models as example.
  - better compatibility with older PHP versions; requires PHP 4.1.0 or better.
  - HTML_Page package is now only necessary for some examples.
  - HTML_CSS package is optional. Easy way to generate a progress stylesheet.
  - CSS id and class selectors are customizable.
  - phpUnits test were added for API.

  * feature additions
  - HTML_Progress now implements a Observer design pattern. It is possible to add Listeners.
  - HTML_Progress now adds a customizable UI monitor pattern to display a progress bar.
  User-end can abort progress at any time.
  - Look and feel can be sets by internal API or external config file.
  - Allows many progress bar on same page without uses of iframe solution.

• 0.6.2 (stable, 2003-09-24)
• 0.6.1 (stable, 2003-09-09)
• 0.6.0 (stable, 2003-08-29)
• 0.5.0 (stable, 2003-08-07)
• 0.4.2 (stable, 2003-08-01)

Bugs