Moodle  2.2.1
http://www.collinsharper.com
progress_bar Class Reference

Public Member Functions

 __construct ($html_id= '', $width=500, $autostart=false)
 create ()
 update_full ($percent, $msg)
 update ($cur, $total, $msg)
 restart ()

Detailed Description

Definition at line 2820 of file weblib.php.


Constructor & Destructor Documentation

__construct ( html_id = '',
width = 500,
autostart = false 
)

Constructor

Parameters:
string$html_id
int$width
bool$autostartDefault to false
Returns:
void, prints JS code if $autostart true

Definition at line 2840 of file weblib.php.

Here is the call graph for this function:


Member Function Documentation

create ( )

Create a new progress bar, this function will output html.

Returns:
void Echo's output

Definition at line 2859 of file weblib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

restart ( )

Restart the progress bar.

Definition at line 2971 of file weblib.php.

update ( cur,
total,
msg 
)

Update progress bar according the number of tasks

Parameters:
int$curcurrent task number
int$totaltotal task number
string$msgmessage

Definition at line 2963 of file weblib.php.

Here is the call graph for this function:

update_full ( percent,
msg 
)

Update progress bar according percent

Parameters:
int$percentfrom 1-100
string$msgthe message needed to be shown

Definition at line 2951 of file weblib.php.

Here is the caller graph for this function:


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations