Home » HTML » HTML_Progress2

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

This package is unmaintained.

Download latest release 2.4.2 (archived versions might be outdated)

License: BSD

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.
- allows many progress meter on same page without uses of iframe solution.
- error handling system that support native PEAR_Error, but also PEAR_ErrorStack, and
any other system you might want to plug-in.
- PHP 5 ready.

Documentation

Manual

Maintainers

• Laurent Laville (farell) — lead, active

Dependencies

Required

• PHP (>= 4.3.10)
• PEAR Installer (>= 1.5.4)
• HTML_Common (>= 1.2.1)
• Event_Dispatcher (>= 0.9.1)
• HTML_CSS (>= 1.1.2)

Optional

• PHP_Compat (>= 1.4.1)
• HTML_QuickForm (>= 3.2.6)
• HTML_QuickForm_Controller (>= 1.0.6)
• 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)
• HTML_QuickForm_Renderer_Tableless (>= 0.3.2)
• HTML_AJAX (>= 0.5.0)
• gd (extension)

Releases

• 2.4.2 (stable, 2011-12-11)
  Release notes

  License: BSD

  QA release
  Bug #17728 Patch: using pcre functions to avoid deprecation warnings
  Bug #19005 remove error_reporting (for PEAR QA team)
  Update PHPUnit compatibility

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

  License: BSD

  This release is really necessary if you use HTML_Progress2_Generator.

  * bugs
  - fix parser error on Generator/Process.php file

• 2.4.0 (stable, 2008-04-24)
  Release notes

  License: BSD

  * news
  - implement request #12532 : Add addional info to apc5 info

  * changes
  - drop support of UPM4 backend in HTML_Progress2_Upload (PHP4 patch for upload)

  * bugs
  - #13664 : setLabelAttributes does not work

  * QA
  - fix lot of CS, following recommandation of PHP_CodeSniffer 1.0.1
  - fix PHP minimum requirement (4.3.10)
  - require now at least PEAR installer 1.5.4 rather than 1.3.4
  (security vulnerability fixes)

• 2.3.0 (stable, 2007-06-12)
  Release notes

  License: BSD

  * bugs
  - Fixed Doc Bug #10879 : Problem with HTML_Progress2::setCellCount()

  * changes
  - No code changes since previous release (RC1), but change license
  from PHP 3.01 to new BSD (give more freedom)

• 2.3.0RC1 (beta, 2007-02-12)
  Release notes

  License: PHP License 3.01

  * IMPORTANT
  Final stable release 2.3.0 is plan for February 23rd.
  Please test this version as much as possible on all platform and report to me (by mail,
  or PEAR bug tracker) all problem/bug found.

  * Features list added since 2.3.0 alpha 2 version:
  - simple AJAX progress bar ; see Request #3985
  - file upload support for PHP4/5 with AFLAX (the AJAX for Adobe Flash Platform 8 or greater)
  - file upload support with HTML_AJAX and multiple backend
  (PHP5 and APC, PHP5 and uploadprogress extension, PHP 4 patch)

• 2.3.0a3 (alpha, 2007-02-02)
  Release notes

  License: PHP License 3.01

  IMPORTANT
  User Guide(s) (offline and online) will not be update until final stable release 2.3.0
  If you want some informations about AJAX progress bar, and how to do it, please
  read the mini guide HOWTO_AJAX.txt (available only for alpha releases of version 2.3.0).
  See also examples in directory examples/ajax.

  HTML_Progress2 2.3.0 requires now minimum PHP version 4.3.0 to work.

  * news
  - add file upload support for PHP4/5 with AFLAX (the AJAX for Adobe Flash Platform 8 or greater)
  See 3 basic examples (fileupload?.php) in examples/aflax directory
  - HTML_Progress2::toArray() return now settings on AFLAX client/server

  * changes
  - improve multi-label system and allow more free combination

• 2.3.0a2 (alpha, 2007-01-23)
  Release notes

  License: PHP License 3.01

  IMPORTANT
  User Guide(s) (offline and online) will not be update until final stable release 2.3.0
  If you want some informations about AJAX progress bar, and how to do it, please
  read the mini guide HOWTO_AJAX.txt (available only for alpha releases of version 2.3.0).
  See also examples in directory examples/ajax.

  Contribution to improve part of guide are welcome ! Do not hesitate to give your
  feedback.

  HTML_Progress2 2.3.0 requires now minimum PHP version 4.3.0 to work.

  * news
  - all alpha releases of version 2.3.0 are related to request #3985: Ajax progress bar
  - add PEAR::HTML_AJAX 0.5.0 as an optional dependency
  - HTML_Progress2::getScript() method has a new (optional) parameter to handle
  custom HTML_Progress2 package installation.
  If you do not used PEAR installer, parameter #2 ($path) identify location of
  directory where to find the HTML_Progress2.js file.
  It will search first in PEAR/data dir, then in same directory where HTML_Progress2
  is installed or in your user dir ($path).
  DO NOT add a trailing directory separator at end of the path !

  Credit: on a cool idea of HTML_AJAX !

  * changes
  - clean-up old implementation of AJAX progress bar; used now package HTML_AJAX
  - Javascript function calls used now OOP notation
  - Javascript code PB handler is now externalized into file HTML_Progress2.js
  - new method setupAJAX()
  - new implementation of method registerAJAX() (renamed too)

• 2.3.0a1 (alpha, 2007-01-17)
  Release notes

  License: PHP License 3.01

  IMPORTANT
  User Guide(s) (offline and online) will not be update until final stable release 2.3.0
  If you want some informations about Ajax progress bar, and how to do it, please
  read the mini guide HOWTO_AJAX.txt (available only for alpha releases of version 2.3.0).
  See also the two examples in directory examples/ajax.
  Contribution to improve part of guide and perharps drivers are welcome !

  HTML_Progress2 2.3.0 requires now minimum PHP version 4.3.0 to work.

  * news
  - request #3985: Ajax progress bar

  * changes
  - drop support of cell id mask identifier (begin private)
  - a progress bar widget (div) is now identified only by {see HTML_Progress2::getIdent()}
  rather than "tfrm" + {HTML_Progress2::getIdent()}
  - Default progress bar identifier (without prefix "tfrm") cannot be numeric (xhtml compliant)
  - Improve Javascript function setProgress() which does not need anymore the third parameter.
  - Improve Javascript function call to setElementStyle() and removed unecessary arguments
  - fix typo error (millisecond term) in phpdoc tags
  - add two new error code for ajax drivers: HTML_PROGRESS2_ERROR_INVALID_RESOURCE, HTML_PROGRESS2_ERROR_ABSTRACT
  - add new methods : registerAjax(), and fileExists()
  - add new classes: HTML_Progress2_Ajax_Common, HTML_Progress2_Ajax_StdDOMxml

• 2.2.0 (stable, 2007-01-03)
  Release notes

  License: PHP License 3.01

  * news
  - add new function importStyle() to give ability to import an existing stylesheet
  and separate PHP code from HTML layout (with CSS)

  * changes
  - improved javascript custom handler for JavaDanse example related to version 2.1.1 (bug fixed #8684)

  * QA
  - include a new revision of User Guide (TDG) that cover all versions 2.x.x
  see http://pear.laurent-laville.org/HTML_Progress2 for more format to download.

• 2.1.1 (stable, 2006-12-22)
  Release notes

  License: PHP License 3.01

  * bugs
  - fixed bug #8684 : Problem with generated JavaScript
  - fixed "examples/generatorcus.php" to use new architecture with external stylesheet introduced on August 11, 2006.

  * news (improved code)
  - used now "className" property rather than "visibility"
  and reduced div tags count used to build a progress bar (only 10 rather than 20 )
  - apply more CS (space code indent, ...)
  - add "alt" attribute to img html-tag to be more xhtml compliant
  - JS function "hideProgress" lose its second parameter (no more needed)

• 2.1.0 (stable, 2006-08-12)
  Release notes

  License: PHP License 3.01

  * bugs
  - fixed bug #8265 HTML_Page2 dependency
  - fixed typo error in removeListener() function from HTML_Progress2 and HTML_Progress2_Monitor classes

  * news
  - rewrites of HTML_Progress2_Generator to fully separate code from design
  its now easy to change skin with a simple stylesheet (see examples/generator/generatorcus2.php)
  - add alpha version of QF tableless renderer for HTML_Progress2_Generator
  - addListener() and removeListener() signatures changed. Adds notification name serves as a filter.
  - new methods get and set StyleSheet into default QF renderer (Generator/Default.php)
  - All renderers (Default, Tableless, HTMLPage2, ITDynamic, SmartyDynamic) used now the new architecture with external stylesheet
  - All remaining code (css class selector still in default renderer was moved to external CSS file: 'default.css')
  - fixed value return by apiVersion()
  - progress meter use now its own event dispatcher (called "ProgressMeter")

  * Quality Assurance
  - updates copyright date
  - removed dupplicates entries in package xml 1.0
  - The Definitive Guide is up-to-date with FAQ, Appendixes new examples, and the guide for Progress Generator

• 2.0.1 (stable, 2006-05-24)
  Release notes

  License: PHP License 3.01

  * bugs
  - fixes closing html style tag to avoid javascript error; see console of Firefox.
  - fixes Bug #7437 : wrong text in Doc (thanks to Stefan Valouch for reading it carefully)

  * news
  - PEAR::PHP_Compat package begin optional dependency (only required for PHP4)
  - upgrade license from PHP 3.0 to 3.01

  * Quality Assurance
  - The Definitive Guide revision number will now follow the package release version.
  - All examples (closing html style tag) were fixed (offline and online).

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

  License: PHP License 3.0

  * news (HTML_Progress)
  - active cell, and background progress meter support now
  background-image, background-repeat, background-position attributes

  * news (HTML_Progress_Lite)
  - add font-style attribute for all label categories
  (ability to use italic for percent and text labels)

  * improvements
  - standardized observer notify interface for all events

  * bugs
  - Fixed my first bug in HTML_Progress2_Lite::setLabelAttributes() method
  related to font group attributes.
  - Fixed bug in moveNext() method: avoid exceed max limit
  - Fixed bug setBorderPainted(false) inefficient with setBorderAttributes()

  * Quality Assurance
  The Definitive (User) Guide:
  - include a complete english guide for both beginners and expert users.
  This is the many html files version. Others format are
  available to download at URI http://pear.laurent-laville.org/HTML_Progress2/docs
  More W3C/CSS standard compliance:
  - background-color attribute has transparent rather than null string by default
  - frame attribute border renamed to border-width
  API documentation generation:
  - updates headers comment block (package and methods)
  - added @example tag to have ability to display (highlight) source code
  - added @link tag to have ability to display a screenshot (PNG image)
  - removed all @tutorial tag
  - added @ignore tag on all unit testcases and some others files
  to avoid includes in API docs

  Live demos, screenshots, source codes and much more are available on my
  project homepage at http://pear.laurent-laville.org/HTML_Progress2

• 2.0.0RC2 (beta, 2005-08-01)
  Release notes

  License: PHP License 3.0

  ---
  i will open another one month timeframe until stable release, or if a bug is found
  until third release candidate.
  Please, test it as much as possible, and report all you think important.
  ---

  * bugs
  - fixed Monitor stops before end when setMaximum is set to value higher than 200 (bug #4885)
  Thanks to Roman Stachura.

  * changes
  - observer pattern is now built with Event_Dispatcher package
  - removes all HTML_CSS dependencies
  - getStyle() and getScript() optimized now when its request the html stream generation
  (raw data only or data with script tags)

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

  * QA
  - dependencies has been revisited to higher level
  - all Examples are now back into main package. No more additional package.
  - Fix wrong project links into documentation (README, ReleaseVersion)
  Thanks to Christian Roy to have noticed me.

• 2.0.0RC1 (beta, 2005-06-23)
  Release notes

  License: PHP License 3.0

  ---
  It is important to notice that even if i will continue to maintains the HTML_Progress
  for possible bugs, no features will be added in this package. Even if it will not marks
  as deprecated, i suggest to migrate to HTML_Progress2 (see docs/migrationGuide.txt).
  ---
  * news
  - The HTML_Progress2 package has now a series of mini guides (see docs/ directory)
  - The HTML_Progress2_Lite class is recommended to users that does not want to install PEAR.
  This class has no dependencies.
  - News examples are available: See Multiple, Label, Lite version, Preload.
  - Adds the *autorun* option on HTML_Progress2_Monitor to run a progress monitor
  without need to push the Start button.

  * changes
  - DM and UI classes (from HTML_Progress 1.x) were merged into the main class.
  - Model class (from HTML_Progress 1.x) was removed.
  - A new error handling system that support native PEAR_Error (default), but also PEAR_ErrorStack,
  and any other system you might want to plug-in.
  - Progress2 and Generator does not support anymore external pre-set config file.
  - All examples have been revisited (removed those who have the same goals).
  - HTML_Progress2::getPercentComplete() method has an optional parameter.
  Return may be float (default) or integer.
  - HTML_Progress2 API changed a bit to include the new label system:
  . setCellCount() accept now zero as minimum value for smooth progress meter
  (see also HTML_Progress2_Lite).
  . moveNext() should replace incValue() (still exists)
  . moveStep() should replace setValue() (still exists)
  . setLabelAttributes() replaced setStringAttributes() (was removed)
  . isStringPainted() and setStringPainted() were removed
  . getString() was also removed
  . setString() was removed and replaced by addLabel()
  - HTML_Progress2_Monitor::callProgressHandler() public method was removed.
  - HTML_Progress2 included now the features of HTML_Progress_Lite:
  window frame, buttons, labels (text, step, crossbar).

  * improvements
  - Generator ActionProcess got two new methods to easily get PHP and/or CSS source code generated.
  - More compatibilities with PHP5 (adds __construct method).

  * QA
  - Updates headers comment block on all files
  - Dependencies has been revisited to higher level
  - Examples were removed from main package and moved into the optional package
  available at http://pear.laurent-laville.org/HTML_Progress2/

Bugs