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

HTML_Progress 1.x Guide

introduction to HTML_Progress package

by by Laurent Laville
mailto:pear@laurent-laville.org
March 2004, Laurent Laville
(HTML_Progress 1.2)

Table of Contents

What is HTML_Progress ?

To discover what is really the HTML_Progress component (PEAR class), first read HTML_Progress (part1). You'll find a quick presentation, the license, a short image gallery, and the FAQ.

Releases

First publish release of HTML_Progress on PEAR website was on August 1st, 2003. Its introduced the first attempt of stable API version. But as i wanted HTML_Progress more open to future evolutions, i've redevelopped a second API more robust. So versions 0.4.x, 0.5.x and 0.6.x are all incompatible with the new API introduced first in version 1.0

  • 2003-11-16 (version 1.0)

    First attempt to:

  • create a Progress Monitor solution.
  • interactive tools to build progress bar (Progress Maker).
  • 2004-02-14 (version 1.1)

  • Second version of Progress Monitor, using the QuickForm rendering system.
  • Progress Uploader was born: a web-ftp file uploads solution.
  • Progress Generator became the next generation of Progress Maker.
  • 2004-03-xx (version 1.2)

  • Package Overview

    HTML_Progress provides 8 main classes to help you use progress bars:

    Global classes

  • HTML_Progress

    Main component to graphically display how much of a total task has completed. See (Using Determinate Progress Bars) for information and an example of using a typical progress bar. The section Using Indeterminate Mode tells you how to animate a progress bar to show activity before the task's scope is known.

  • Error_Raise by by Greg Beaver
    mailto:cellog@php.net

    The Error_Raise static class contains tremendously simple and powerful error management based on error codes.

  • Error_Util by by Greg Beaver
    mailto:cellog@php.net

    This class is used for advanced retrieval of context information, and for callback validation. It also has a few miscellaneous functions for processing display of variables.

  • Until this package is accepted as a PEAR package, it can be downloaded at http://www.chiaraquartet.net/Error_Raise-0.2.2.tgz, and was integrated in HTML_Progress package.


    Data Model class

  • HTML_Progress_DM

    This class handles any mathematical issues arising from assigning faulty values.


  • User Interface classes

  • HTML_Common

    This class provides methods for html code display and attributes handling. It is a base class for other HTML classes and can be downloaded at PEAR under HTML_Common package.

  • HTML_Progress_UI

    This class provides a basic look and feel implementation of a progress bar.

  • HTML_Progress_Model

    This class provides an easy way to set look and feel of a progress bar with external config file. This class requires another great PEAR package, the Config package which provides methods for configuration manipulation.

  • HTML_Progress_Generator

    This class provides an easy way to build and run demo of your own progress bar. You can also save final PHP and/or CSS source-code. HTML_Progress_Generator become the next generation of interactive tools after ProgressMaker (included in HTML_Progress 1.0)


  • Observers classes

  • HTML_Progress_Observer

    This class implements the observer pattern for watching progress bar activity and taking actions on exceptional events.

  • HTML_Progress_Monitor

    This class allow an easy way to display progress in a dialog. The user can cancel the task. It requires another PEAR package, the HTML_QuickForm package which provides methods for creating, validating, processing HTML forms.

  • HTML_Progress_Uploader

    This class provides a GUI interface (with progress bar) to manage files to upload to a ftp server with your web browser.



  • Documentation generated on Sun, 16 May 2004 05:21:19 -0400 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.