Class: HTML_Progress_Model

Source Location: /HTML_Progress-1.2.6/Progress/model.php

Class Overview

HTML_Common
   |
   --HTML_Progress_UI
      |
      --HTML_Progress_Model

The HTML_Progress_Model class provides an easy way to set look and feel of a progress bar with external config file.

Author(s):

Laurent Laville <pear at laurent-laville.org>

Version:

Release: @package_version@

Copyright:

1997-2005 The PHP Group

Inherited Variables

Inherited Methods

Class: HTML_Progress_UI

HTML_Progress_UI::HTML_Progress_UI(): The progress bar's UI model class constructor
HTML_Progress_UI::drawCircleSegments(): Draw all circle segment pictures
HTML_Progress_UI::getBorderAttributes(): Returns the progress bar's border attributes. Assoc array (defaut) or string.
HTML_Progress_UI::getCellAttributes(): Returns the common and private cell attributes. Assoc array (defaut) or string
HTML_Progress_UI::getCellCoordinates(): Returns the coordinates of each cell for a polygonal progress shape.
HTML_Progress_UI::getCellCount(): Returns the number of cell in the progress bar. The default value is 10.
HTML_Progress_UI::getFillWay(): Returns 'natural' or 'reverse', depending of the fill way of progress bar.
HTML_Progress_UI::getOrientation(): Returns HTML_PROGRESS_BAR_HORIZONTAL or HTML_PROGRESS_BAR_VERTICAL, depending on the orientation of the progress bar.
HTML_Progress_UI::getProgressAttributes(): Returns the progress attributes. Assoc array (defaut) or string.
HTML_Progress_UI::getScript(): Get the javascript code to manage progress bar.
HTML_Progress_UI::getStringAttributes(): Returns the string attributes. Assoc array (defaut) or string.
HTML_Progress_UI::getStyle(): Get the cascading style sheet to put inline on HTML document
HTML_Progress_UI::setBorderAttributes(): Sets the progress bar's border attributes.
HTML_Progress_UI::setCellAttributes(): Sets the cell attributes for an existing cell.
HTML_Progress_UI::setCellCoordinates(): Set the coordinates of each cell for a polygonal progress shape.
HTML_Progress_UI::setCellCount(): Sets the number of cell in the progress bar
HTML_Progress_UI::setFillWay(): Sets the progress bar's fill way, which must be 'natural' or 'reverse'.
HTML_Progress_UI::setOrientation(): Sets the progress bar's orientation, which must be HTML_PROGRESS_BAR_HORIZONTAL or HTML_PROGRESS_BAR_VERTICAL.
HTML_Progress_UI::setProgressAttributes(): Sets the common progress bar attributes.
HTML_Progress_UI::setScript(): Set the external JavaScript code (file) to manage progress element.
HTML_Progress_UI::setStringAttributes(): Sets the string attributes.

Class Details

[line 48]
The HTML_Progress_Model class provides an easy way to set look and feel of a progress bar with external config file.

PHP versions 4 and 5

LICENSE: This source file is subject to version 3.0 of the PHP license that is available through the world-wide-web at the following URI: http://www.php.net/license/3_0.txt. If you did not receive a copy of the PHP License and are unable to obtain it through the web, please send a note to license@php.net so we can mail you a copy immediately.

Author: Laurent Laville <pear@laurent-laville.org>
Version: Release: @package_version@
Copyright: 1997-2005 The PHP Group
Link: http://pear.php.net/package/HTML_Progress
License: PHP License 3.0

[ Top ]

Method Detail

HTML_Progress_Model (Constructor) [line 70]

HTML_Progress_Model HTML_Progress_Model(
string
$file, string
$type)

The progress bar's UI extended model class constructor

Since: 1.0
Throws: HTML_PROGRESS_ERROR_INVALID_INPUT
Access: public

Parameters:

string	`$file`	—	file name of model properties
string	`$type`	—	type of external ressource (phpArray, iniFile, XML ...)

[ Top ]