Docs For Class HTML_Progress

HTML_Progress_Monitor (Constructor) [line 121]

HTML_Progress_Monitor HTML_Progress_Monitor(
[string
$formName = 'ProgressMonitor'], [array
$attributes = array()], [array
$errorPrefs = array()])

Constructor Summary

Creates a standard progress bar into a dialog box (QuickForm). Form name, buttons 'start', 'cancel' labels and style, and title of dialog box may also be changed. $monitor = new HTML_Progress_Monitor();

Creates a progress bar into a dialog box, with only a new form name. $monitor = new HTML_Progress_Monitor($formName);

Creates a progress bar into a dialog box, with a new form name, new buttons name and style, and also a different title box. $monitor = new HTML_Progress_Monitor($formName, $attributes);

Since: 1.0
Throws: HTML_PROGRESS_ERROR_INVALID_INPUT
Access: public

Parameters:

string	`$formName`	—	(optional) Name of monitor dialog box (QuickForm)
array	`$attributes`	—	(optional) List of renderer options
array	`$errorPrefs`	—	(optional) Hash of params to configure error handler

[ Top ]

accept [line 366]

void accept(

&$renderer, object
$renderer)

Accepts a renderer

Since: 1.1
Access: public

Parameters:

object	`$renderer`	—	An HTML_QuickForm_Renderer object
	`&$renderer`	—

[ Top ]

callProgressHandler [line 221]

void callProgressHandler(
integer
$arg)

Calls a user-defined progress handler function.

Deprecated:
Since: 1.1
Access: public

Parameters:

integer $arg — Current value of the progress bar.

[ Top ]

getProgressElement [line 301]

object &getProgressElement(
)

Returns a reference to the progress bar object used with the monitor.

See: HTML_Progress_Monitor::setProgressElement()
Since: 1.1
Access: public

[ Top ]

getScript [line 325]

string getScript(
)

Returns progress javascript.

Since: 1.0
Access: public

[ Top ]

getStyle [line 313]

string getStyle(
)

Returns progress styles (StyleSheet).

Since: 1.0
Access: public

[ Top ]

isCanceled [line 246]

bool isCanceled(
)

Returns TRUE if progress was canceled by user, FALSE otherwise.

Since: 1.0
Access: public

[ Top ]

isStarted [line 233]

bool isStarted(
)

Returns TRUE if progress was started by user, FALSE otherwise.

Since: 1.1
Access: public

[ Top ]

notify [line 184]

void notify(
mixed
$event)

Listens all progress events from this monitor.

See: HTML_Progress::process()
Deprecated:
Throws: HTML_PROGRESS_ERROR_INVALID_INPUT
Since: 1.0
Access: public

Parameters:

mixed $event — A hash describing the progress event.

[ Top ]

run [line 259]

void run(
)

Display Monitor and catch user action (cancel button).

Since: 1.0
Access: public

[ Top ]

setCaption [line 398]

void setCaption(
[string
$caption = '&nbsp;'], [array
$args = array()])

Display a caption on action in progress.

The idea of a simple utility function for replacing variables with values in an message template, come from sprintfErrorMessage function of Error_Raise package by Greg Beaver.

This simple str_replace-based function can be used to have an order-independent sprintf, so messages can be passed in with different grammar ordering, or other possibilities without changing the source code.

Variables should simply be surrounded by % as in %varname%

Since: 1.1
Access: public

Parameters:

string	`$caption`	—	(optional) message template
array	`$args`	—	(optional) associative array of template var -> message text

[ Top ]

setProgressElement [line 277]

void setProgressElement(
object
$bar)

Attach a progress bar to this monitor.

See: HTML_Progress_Monitor::getProgressElement()
Throws: HTML_PROGRESS_ERROR_INVALID_INPUT
Since: 1.1
Access: public

Parameters:

object $bar — a html_progress instance

[ Top ]

setProgressHandler [line 199]

void setProgressHandler(
mixed
$handler)

Sets a user-defined progress handler function.

See: HTML_Progress::setProgressHandler()
Throws: HTML_PROGRESS_ERROR_INVALID_CALLBACK
Since: 1.1
Access: public

Parameters:

mixed $handler — Name of function or a class-method.

[ Top ]

toHtml [line 352]

string toHtml(
)

Returns Monitor forms as a Html string.

Since: 1.0
Access: public

[ Top ]

Class: HTML_Progress_Monitor

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$buttonCancel =

$buttonStart =

$windowname =

Method Detail

HTML_Progress_Monitor (Constructor) [line 121]

Parameters:

accept [line 366]

Parameters:

callProgressHandler [line 221]

Parameters:

getProgressElement [line 301]

getScript [line 325]

getStyle [line 313]

isCanceled [line 246]

isStarted [line 233]

notify [line 184]

Parameters:

run [line 259]

setCaption [line 398]

Parameters:

setProgressElement [line 277]

Parameters:

setProgressHandler [line 199]

Parameters:

toHtml [line 352]