Docs For Class HTML_Progress2

__construct (Constructor) [line 203]

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

Constructor (ZE2) 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_Progress2_Monitor();

Creates a progress bar into a dialog box, with only a new form name. $monitor = new HTML_Progress2_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_Progress2_Monitor($formName, $attributes);

Since: 2.0.0
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Access: protected

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 ]

HTML_Progress2_Monitor (Constructor) [line 167]

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

Constructor (ZE1)

Since: 2.0.0
Access: public

Parameters:

	`$formName`	—
	`$attributes`	—
	`$errorPrefs`	—

[ Top ]

accept [line 542]

void accept(

&$renderer, object
$renderer)

Accepts a renderer.

Accepts a QF renderer for design pattern.

Since: 2.0.0
Access: public

Parameters:

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

[ Top ]

addListener [line 280]

void addListener(
mixed
$callback)

Adds a new observer.

Adds a new observer to the Event Dispatcher that will listen for all messages emitted by this HTML_Progress2 instance.

See: HTML_Progress2_Monitor::removeListener()
Throws: HTML_PROGRESS2_ERROR_INVALID_CALLBACK
Since: 2.0.0
Access: public

Parameters:

mixed $callback — PHP callback that will act as listener

[ Top ]

display [line 526]

void display(
)

Renders the initial state of progress monitor.

This function should be used only to display initial state of the progress monitor with default QF renderer. If you use another QF renderer (Smarty, ITDynamic, ...) read template engine renderer related documentation.

Since: 2.0.0RC2
Access: public

[ Top ]

getProgressElement [line 431]

object &getProgressElement(
)

Returns a reference to the progress bar.

This function returns a reference to the progress meter used with the monitor. Its allow to change easily part or all basic options.

See: HTML_Progress2_Monitor::setProgressElement()
Since: 2.0.0
Access: public

[ Top ]

getScript [line 474]

string getScript(
[boolean
$raw = true])

Returns javascript progress meter handler.

Get the javascript URL or inline code that will handle the progress meter refresh.

Since: 2.0.0
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Access: public

Parameters:

boolean $raw — (optional) html output with script tags or just raw data

[ Top ]

getStyle [line 448]

string getStyle(
[boolean
$raw = true])

Returns the cascading style sheet (CSS).

Get the CSS required to display the progress meter in a HTML document.

Since: 2.0.0
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Access: public

Parameters:

boolean $raw — (optional) html output with script tags or just raw data

[ Top ]

isCanceled [line 356]

bool isCanceled(
)

Detect if progress monitor is stopped.

This function returns TRUE if progress monitor was canceled by user, FALSE otherwise.

Since: 2.0.0
Access: public

[ Top ]

isStarted [line 340]

bool isStarted(
)

Detect if progress monitor is started.

This function returns TRUE if progress monitor was started by user, FALSE otherwise.

Since: 2.0.0
Access: public

[ Top ]

removeListener [line 309]

bool removeListener(
mixed
$callback)

Removes a registered observer.

This function removes a registered observer, and if there are no more observer, remove the event dispatcher interface too.

Return: True if observer was removed, false otherwise
See: HTML_Progress2_Monitor::addListener()
Throws: HTML_PROGRESS2_ERROR_INVALID_CALLBACK
Since: 2.0.0
Access: public

Parameters:

mixed $callback — PHP callback that act as listener

[ Top ]

run [line 375]

void run(
)

Runs the progress monitor.

This function accept both modes: indeterminate and determinate, and execute all actions defined in the user callback identified by HTML_Progress2::setProgressHandler() method.

All observers are also notified of main changes (start, stop meter).

Since: 2.0.0
Access: public

[ Top ]

setCaption [line 574]

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: 2.0.0
Access: public

Parameters:

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

[ Top ]

setProgressElement [line 405]

void setProgressElement(

&$bar, object
$bar)

Links a progress bar to this monitor.

This function allow to define a complete progress bar from scratch.

See: HTML_Progress2_Monitor::getProgressElement()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

object	`$bar`	—	a html_progress2 instance
	`&$bar`	—

[ Top ]

toHtml [line 496]

string toHtml(
)

Returns the progress monitor structure as HTML.

Get html code required to display the progress monitor in any html document.

Since: 2.0.0
Access: public

[ Top ]

Class: HTML_Progress2_Monitor

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$autorun =

$buttonCancel =

$buttonStart =

$caption = array()

$dispatcher =

$windowname =

Method Detail

__construct (Constructor) [line 203]

Parameters:

HTML_Progress2_Monitor (Constructor) [line 167]

Parameters:

accept [line 542]

Parameters:

addListener [line 280]

Parameters:

display [line 526]

getProgressElement [line 431]

getScript [line 474]

Parameters:

getStyle [line 448]

Parameters:

isCanceled [line 356]

isStarted [line 340]

removeListener [line 309]

Parameters:

run [line 375]

setCaption [line 574]

Parameters:

setProgressElement [line 405]

Parameters:

toHtml [line 496]