Class: HTML_Progress2_Lite

Source Location: /HTML_Progress2-2.1.0/Progress2_Lite.php

Class Overview

Standalone HTML loading bar with only PHP and JS interface.

Author(s):

Laurent Laville <pear at laurent-laville.org>
Gerd Weitenberg <hahnebuechen at web.de>
Mika Turin <turin at inbox.lv>

Version:

Release: 2.1.0

Copyright:

2005-2006 The PHP Group

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

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

The HTML_Progress2_Lite class allow you to add a quick horizontal or vertical loading bar to any of your xhtml document. You should have a browser that accept DHTML feature.

This class has no dependency and can be used completely outside the PEAR infrastructure.

Here is a basic example:

 <html>

 <body>
 <?php
 require_once 'HTML/Progress2_Lite.php';
 
 function myProcess()
 {
     for ($i=0; $i<100000; $i++) { }
 }
 
 $pbl = new HTML_Progress2_Lite();
 $pbl->addLabel('text','txt1','Progress2 Lite - Basic Example');
 $pbl->display();
 
 for($i=1; $i<=100; $i++) {
     $pbl->moveStep($i);
     myProcess();
 }
 ?>
 </body>
 </html>

Author: Laurent Laville <pear@laurent-laville.org>
Author: Gerd Weitenberg <hahnebuechen@web.de>
Author: Mika Turin <turin@inbox.lv>
Version: Release: 2.1.0
Copyright: 2005-2006 The PHP Group
Link: Improve version of Gerd Weitenberg
Link: From an original idea of Mike Turin
Link: http://pear.php.net/package/HTML_Progress2
Since: Class available since Release 2.0.0RC1
License: PHP License 3.01

[ Top ]

Class Variables

$background_color = '#C0C0C0'

[line 222]

Progress bar foreground color.

Since: 2.0.0
Access: public

Type:

string

[ Top ]

$border = array('width' => 1, 'style' => 'solid', 'color' => '#000000')

[line 239]

Progress bar border properties

 $border = array(

    'width' => 1          # width size in pixel
    'style' => 'solid'    # style (solid, dashed, dotted ...)
    'color' => '#000000'  # color
 );

Since: 2.0.0
Access: public

Type:

array

[ Top ]

$direction = 'right'

[line 248]

Direction of motion (right, left, up, down).

Since: 2.0.0
Access: public

Type:

string

[ Top ]

$foreground_color = '#0033FF'

[line 213]

Progress bar foreground color.

Since: 2.0.0
Access: public

Type:

string

[ Top ]

$frame = array('show' => false)

[line 273]

Progress bar frame properties

 $frame = array(

    'show' => false,      # frame show (true/false)
    'left' => 200,        # frame position from left
    'top' => 100,         # frame position from top
    'width' => 320,       # frame width
    'height' => 90,       # frame height
    'color' => '#C0C0C0', # frame color
    'border-width' => 2,                                   # frame border width
    'border-style' => 'solid',                             # frame border style (solid,
                                                           # dashed, dotted, inset ...)
    'border-color' => '#DFDFDF #404040 #404040 #DFDFDF'    # frame border color (3dfx)
 );

See: HTML_Progress2_Lite::setFrameAttributes()
Since: 2.0.0
Access: public

Type:

array

[ Top ]

$height =

[line 195]

Progress bar height in pixel.

Since: 2.0.0
Access: public

Type:

integer

[ Top ]

$label = array()

[line 303]

Progress bar labels properties

 $label = array(

    'name' => array(                  # label name
      'type' => 'text',               # label type
                                      # (text,button,step,percent,crossbar)
      'value' => '&nbsp;',            # label value
      'left' => ($left),              # label position from left
      'top' => ($top - 16),           # label position from top
      'width' => 0,                   # label width
      'height' => 0,                  # label height
      'align' => 'left',              # label align
      'background-color' => 'transparent',          # label background color
      'font-family' => 'Verdana, Tahoma, Arial',    # label font family
      'font-size' => 11,                            # label font size
      'font-weight' => 'normal',                    # label font weight
      'font-style' => 'normal',                     # label font style
      'color' => '#000000'                          # label font color
 );

See: HTML_Progress2_Lite::addLabel(), HTML_Progress2_Lite::setLabelAttributes()
Since: 2.0.0
Access: public

Type:

array

[ Top ]

$left =

[line 168]

Progress bar position from left.

Since: 2.0.0
Access: public

Type:

integer

[ Top ]

$max =

[line 150]

Maximum steps of the progress bar.

Since: 2.0.0
Access: public

Type:

integer

[ Top ]

$min =

[line 141]

Minimum steps of the progress bar.

Since: 2.0.0
Access: public

Type:

integer

[ Top ]

$padding =

[line 204]

Progress bar padding in pixel.

Since: 2.0.0
Access: public

Type:

integer

[ Top ]

$position =

[line 159]

Progress bar position (absolute, relative).

Since: 2.0.0
Access: public

Type:

string

[ Top ]

$top =

[line 177]

Progress bar position from top.

Since: 2.0.0
Access: public

Type:

integer

[ Top ]

$width =

[line 186]

Progress bar width in pixel.

Since: 2.0.0
Access: public

Type:

integer

[ Top ]

Method Detail

__construct (Constructor) [line 327]

object __construct(
[array
$options = array()], [string
$id = null])

Constructor (ZE2) Summary.

Since: 2.0.0
Access: protected

Parameters:

array	`$options`	—	(optional) has of style parameters for the progress bar
string	`$id`	—	(optional) progress bar unique identifier

[ Top ]

HTML_Progress2_Lite (Constructor) [line 311]

HTML_Progress2_Lite HTML_Progress2_Lite(
[
$options = array()], [
$id = null])

Constructor (ZE1)

Since: 2.0.0
Access: public

Parameters:

	`$options`	—
	`$id`	—

[ Top ]

addButton [line 525]

void addButton(
string
$name, string
$value, string
$action, [string
$target = 'self'])

Add a new button with the progress bar.

See: HTML_Progress2_Lite::removeButton(), HTML_Progress2_Lite::addLabel()
Since: 2.0.0
Access: public

Parameters:

string	`$name`	—	Button name
string	`$value`	—	Label value
string	`$action`	—	Action to do (see QUERY_STRING)
string	`$target`	—	(optional) Frame target (default is self)

[ Top ]

addLabel [line 402]

void addLabel(
string
$type, string
$name, [string
$value = '&nbsp;'])

Add a new label to the progress bar.

See: HTML_Progress2_Lite::setLabelAttributes(), HTML_Progress2_Lite::removeLabel()
Since: 2.0.0
Access: public

Parameters:

string	`$type`	—	Label type (text,button,step,percent,crossbar)
string	`$name`	—	Label name
string	`$value`	—	(optional) default label value

[ Top ]

display [line 975]

void display(
)

Show the renders of the progress bar.

See: HTML_Progress2_Lite::toHtml()
Since: 2.0.0
Access: public

[ Top ]

hide [line 988]

void hide(
)

Hides the progress bar.

Since: 2.0.0
Access: public

[ Top ]

moveMin [line 792]

void moveMin(
)

Changes value of the progress bar to the minimum step.

See: HTML_Progress2_Lite::moveStep()
Since: 2.0.0
Access: public

[ Top ]

moveNext [line 779]

void moveNext(
)

Changes value of the progress bar to the next step.

See: HTML_Progress2_Lite::moveStep()
Since: 2.0.0
Access: public

[ Top ]

moveStep [line 732]

void moveStep(
integer
$step)

Changes new step value of the progress bar.

Since: 2.0.0
Access: public

Parameters:

integer $step — new step value

[ Top ]

removeButton [line 542]

void removeButton(
string
$name)

Removes a button to the progress bar.

See: HTML_Progress2_Lite::addButton()
Since: 2.0.0
Access: public

Parameters:

string $name — Label name

[ Top ]

removeLabel [line 505]

void removeLabel(
string
$name)

Removes a label to the progress bar.

See: HTML_Progress2_Lite::addLabel()
Since: 2.0.0
Access: public

Parameters:

string $name — Label name

[ Top ]

setBarAttributes [line 593]

void setBarAttributes(
[array
$attributes = array()])

Defines main style of a progress bar.

Since: 2.0.0
Access: public

Parameters:

array $attributes — (optional) hash of style parameters

[ Top ]

setDirection [line 370]

void setDirection(
string
$direction)

Moves the progress bar in all directions (left, right, up , down).

Since: 2.0.0
Access: public

Parameters:

string $direction — fill way of the progress bar

[ Top ]

setFrameAttributes [line 558]

void setFrameAttributes(
[array
$attributes = array()])

Build a frame around the progress bar.

Since: 2.0.0
Access: public

Parameters:

array $attributes — (optional) hash of style parameters

[ Top ]

setLabelAttributes [line 645]

void setLabelAttributes(
string
$name, [array
$attributes = array()])

Defines style of a progress bar label.

See: HTML_Progress2_Lite::addLabel()
Since: 2.0.0
Access: public

Parameters:

string	`$name`	—	Label identifier
array	`$attributes`	—	(optional) hash of style parameters

[ Top ]

show [line 1003]

void show(
)

Shows a progress bar hidden.

Since: 2.0.0
Access: public

[ Top ]

toHtml [line 805]

string toHtml(
)

Returns the progress bar structure as HTML.

See: HTML_Progress2_Lite::display()
Since: 2.0.0
Access: public

[ Top ]