PEAR Progress2 logo

HTML_Progress2 : The Definitive Guide

HTML_Progress2::addLabel
Prev  Labels  Next

Name

HTML_Progress2::addLabel — Add a new label to the progress meter

Synopsis 

      require_once 'HTML/Progress2.php';
void HTML_Progress2::addLabel( $type,  
  $name,  
  $value = ' ');  
string   $type;
string   $name;
string   $value = ' ';

Description

Defines a new label identifier choosen between five categories:

  • HTML_PROGRESS2_LABEL_TEXT constant if you want a simple text zone
  • HTML_PROGRESS2_LABEL_BUTTON constant if you want a form button
  • HTML_PROGRESS2_LABEL_STEP constant if you want a step resume progress
  • HTML_PROGRESS2_LABEL_PERCENT constant if you want current progress value
  • HTML_PROGRESS2_LABEL_CROSSBAR constant if you want a little javascript animation

Parameter

string $type

Label type (text,button,step,percent,crossbar)

string $name

Label name

string $value

(optional) default label value

See

see HTML_Progress2::setLabelAttributes , HTML_Progress2::removeLabel

Throws

throws HTML_PROGRESS2_ERROR_INVALID_INPUT

Note

since 2.0.0

This function can not be called statically.

HTML_Progress2 : The Definitive Guide v 2.4.0 : April 20, 2007
Prev  Up  Next
HTML_Progress2::setLabelAttributes  Home  HTML_Progress2::removeLabel