Docs For Class HTML_Progress2

__construct (Constructor) [line 184]

HTML_Progress2_Generator __construct(
[string
$controllerName = 'ProgressGenerator'], [array
$attributes = array()], [array
$errorPrefs = array()])

Constructor (ZE2) Summary

Creates a standard progress bar generator wizard.

   $generator = new HTML_Progress2_Generator();

Creates a progress bar generator wizard with customized actions: progress bar preview, form rendering, buttons manager

   $controllerName = 'myPrivateGenerator';
   $attributes = array(
        'preview' => name of a HTML_QuickForm_Action instance
                     (default 'ActionPreview',
                      see 'HTML/Progress2/Generator/Preview.php')
        'display' => name of a HTML_QuickForm_Action_Display instance
                     (default 'ActionDisplay',
                      see 'HTML/Progress2/Generator/Default.php')
        'process' => name of a HTML_QuickForm_Action instance
                     (default 'ActionProcess',
                      see 'HTML/Progress2/Generator/Process.php')
   );
   $generator = new HTML_Progress2_Generator($controllerName, $attributes);

Since: version 2.0.0 (2005-10-01)
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Access: protected

Parameters:

string	`$controllerName`	—	(optional) Name of generator wizard (QuickForm)
array	`$attributes`	—	(optional) List of renderer options
array	`$errorPrefs`	—	(optional) Hash of parameters to configure error handler

[ Top ]

HTML_Progress2_Generator (Constructor) [line 142]

HTML_Progress2_Generator HTML_Progress2_Generator(
[string
$controllerName = 'ProgressGenerator'], [array
$attributes = array()], [array
$errorPrefs = array()])

Constructor (ZE1)

Since: version 2.0.0 (2005-10-01)
Access: public

Parameters:

string	`$controllerName`	—	(optional) Name of generator wizard (QuickForm)
array	`$attributes`	—	(optional) List of renderer options
array	`$errorPrefs`	—	(optional) Hash of parameters to configure error handler

[ Top ]

addAction [line 401]

void addAction(
string
$actionName, object
&$action)

Registers a handler for a specific action.

Since: version 2.1.0 (2006-08-12)
Access: public

Parameters:

string	`$actionName`	—	name of the action
object	`&$action`	—	the handler for the action

[ Top ]

addActions [line 349]

void addActions(
[mixed
$actions = null])

Adds common actions for the frontend wizard

Since: version 2.1.0 (2006-08-12)
Access: public

Parameters:

mixed $actions — (optional) Identify for each action a class handler

[ Top ]

addPage [line 320]

void addPage(
array
$page)

Add a specific page to wizard or each page one by one

Since: version 2.1.0 (2006-08-12)
Access: public

Parameters:

array $page — a single Wizard page definition

[ Top ]

addPages [line 299]

void addPages(
[mixed
$pages = null])

Adds all pages of wizard at once

Since: version 2.1.0 (2006-08-12)
Access: public

Parameters:

mixed $pages — Wizard pages definition array or null if used defaults

[ Top ]

createProgressBar [line 435]

object createProgressBar(
)

Creates a progress bar with options choosen on all wizard tabs.

Since: version 2.0.0 (2005-10-01)
Access: public

[ Top ]

createProgressStructure [line 474]

array createProgressStructure(
)

Creates a progress bar structure with options choosen on all wizard tabs.

See: HTML_Progress2::toArray()
Since: version 2.0.0 (2005-10-01)
Access: public

[ Top ]

isIncludeable [line 417]

boolean isIncludeable(
string
$file)

Returns whether or not a file is in the include path.

Return: true if the file is in the include path.
Since: version 2.1.0 (2006-08-12)
Access: public

Parameters:

string $file — filename to test

[ Top ]

singleton [line 275]

object HTML_Progress2_Generator &singleton(
[string
$controllerName = 'ProgressGenerator'], [array
$attributes = array()], [array
$errorPrefs = array()])

Returns a unique instance of the given progress generator wizard.

Since: version 2.1.0 (2006-08-12)
Access: public

Parameters:

string	`$controllerName`	—	(optional) Name of generator wizard (QuickForm)
array	`$attributes`	—	(optional) List of renderer options
array	`$errorPrefs`	—	(optional) Hash of parameters to configure error handler

[ Top ]

Class: HTML_Progress2_Generator

Class Overview

Author(s):

Version:

Copyright:

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

__construct (Constructor) [line 184]

Parameters:

HTML_Progress2_Generator (Constructor) [line 142]

Parameters:

addAction [line 401]

Parameters:

addActions [line 349]

Parameters:

addPage [line 320]

Parameters:

addPages [line 299]

Parameters:

createProgressBar [line 435]

createProgressStructure [line 474]

isIncludeable [line 417]

Parameters:

singleton [line 275]

Parameters: