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

Class: HTML_Progress_DM

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

Class Overview


HTML loading bar with only PHP and JS interface.


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 1997-2005 The PHP Group

Methods


Inherited Variables

Inherited Methods


Class Details

[line 41]
HTML loading bar with only PHP and JS interface.

The HTML_Progress_DM class handles any mathematical issues arising from assigning faulty values.



[ Top ]


Method Detail

HTML_Progress_DM (Constructor)   [line 117]

HTML_Progress_DM HTML_Progress_DM( )

The data model class constructor

Constructor Summary

  • Creates a progress mathematical model with a minimum value set to 0, a maximum value set to 100, and a increment value set to +1. By default, the value is initialized to be equal to the minimum value.
    1.    $html = new HTML_Progress_DM();
  • Creates a progress mathematical model with minimum and maximum set to specified values, and a increment value set to +1. By default, the value is initialized to be equal to the minimum value.
    1.    $html = new HTML_Progress_DM($min$max);
  • Creates a progress mathematical model with minimum, maximum and increment set to specified values. By default, the value is initialized to be equal to the minimum value.
    1.    $html = new HTML_Progress_DM($min$max$inc);

  • Since: 1.0
  • Throws: HTML_PROGRESS_ERROR_INVALID_INPUT
  • Access: public

[ Top ]

getIncrement   [line 356]

integer getIncrement( )

Returns the progress bar's increment value. The default value is +1.

[ Top ]

getMaximum   [line 301]

integer getMaximum( )

Returns the progress bar's maximum value. The default value is 100.

[ Top ]

getMinimum   [line 246]

integer getMinimum( )

Returns the progress bar's minimum value. The default value is 0.

[ Top ]

getPercentComplete   [line 472]

mixed getPercentComplete( [boolean $float = true])

Returns the percent complete for the progress bar. Note that this number is between 0.00 and 1.00 or 0 and 100.

Parameters:

boolean   $float   —  (optional) float or integer format

[ Top ]

getValue   [line 401]

integer getValue( )

Returns the progress bar's current value. The value is always between the minimum and maximum values, inclusive.

By default, the value is initialized with the minimum value.


[ Top ]

incValue   [line 453]

void incValue( )

Updates the progress bar's current value by adding increment value.

[ Top ]

setIncrement   [line 372]

void setIncrement( integer $inc)

Sets the progress bar's increment value.

Parameters:

integer   $inc   —  progress bar's increment value

[ Top ]

setMaximum   [line 317]

void setMaximum( integer $max)

Sets the progress bar's maximum value.

Parameters:

integer   $max   —  progress bar's maximal value

[ Top ]

setMinimum   [line 262]

void setMinimum( integer $min)

Sets the progress bar's minimum value.

Parameters:

integer   $min   —  progress bar's minimal value

[ Top ]

setValue   [line 419]

void setValue( integer $val)

Sets the progress bar's current value.

If the new value is different from previous value, all change listeners are notified.


Parameters:

integer   $val   —  progress bar's current value

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:24:46 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.