HTML_Progress2
[ class tree: HTML_Progress2 ] [ index: HTML_Progress2 ] [ all elements ]
Packages:
HTML_Progress2


Classes:
ActionDisplay
ActionDump
ActionPreview
ActionProcess
HTML_Progress2
HTML_Progress2_Error
HTML_Progress2_Generator
HTML_Progress2_Lite
HTML_Progress2_Monitor
Files:
Default.php
Dump.php
Error.php
Generator.php
HTMLPage2.php
ITDynamic.php
Monitor.php
Preview.php
Process.php
Progress2.php
Progress2_Lite.php
SmartyDynamic.php
Tableless.php

subpackage Examples
ancestor.php
bgimages.php
bgimagesEnh.php
bluesand.php
bullit.php
circle.php
ellipse.php
errorbasic.php
errorcustom.php
errorignore.php
errorlogger.php
errorstackcustom.php
errorstackignore.php
errorstacklogger.php
generatorcus.php
generatorcus2.php
generatordef.php
half.php
hidden.php
itxstatic.php
javadanse.php
liteall.php
litebasic.php
mailer1.php
mailer2.php
mixed.php
mixed.php
monitor.php
monitorcus.php
monitordef.php
monitordyn.php
monitorlog.php
monitorpg2.php
nostring.php
observer1.php
observer2.php
observer3.php
percent1.php
percent2.php
rectangle.php
square.php
squareback.php
swf.php
text1.php
text2.php
userstring.php
vertical.php
vlimit.php
windowstyle.php
windowstyle2.php

Class: HTML_Progress2_Generator

Source Location: /HTML_Progress2-2.1.0/Progress2/Generator.php

Class Overview

HTML_QuickForm_Controller
   |
   --HTML_Progress2_Generator

The HTML_Progress2_Generator class provides an easy way to build progress bar, show a preview, and save php/css code for a later reuse.


Author(s):

Version:

  • Release: 2.1.0

Copyright:

  • 2005-2006 The PHP Group

Methods

Inherited Variables

Inherited Methods

Class Details

[line 46]
The HTML_Progress2_Generator class provides an easy way to build progress bar, show a preview, and save php/css code for a later reuse.


[ Top ]

Method Detail

__construct (Constructor)   [line 154]

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

Constructor (ZE2) Summary

  • Creates a progress bar generator wizard with customized actions: progress bar preview, form rendering, buttons manager 
    1.    $controllerName = 'myPrivateGenerator';
      2. 

    2.    $attributes = array(
      3. 

    3.         'preview' => name of a HTML_QuickForm_Action instance
      4. 

    4.                      (default 'ActionPreview', see 'HTML/Progress2/Generator/Preview.php')
      5. 

    5.         'display' => name of a HTML_QuickForm_Action_Display instance
      6. 

    6.                      (default 'ActionDisplay', see 'HTML/Progress2/Generator/Default.php')
      7. 

    7.         'process' => name of a HTML_QuickForm_Action instance
      8. 

    8.                      (default 'ActionProcess', see 'HTML/Progress2/Generator/Process.php')
      9. 

    9.    );
      10. 

    10.    $generator = new HTML_Progress2_Generator($controllerName, $attributes);
      11.

  • Since: 2.0.0
  • 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 params to configure error handler
   $controllerName   — 

[ Top ]

HTML_Progress2_Generator (Constructor)   [line 117]

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

Constructor (ZE1)
  • Since: 2.0.0
  • Access: public

Parameters:

   $controllerName   — 
   $attributes   — 
   $errorPrefs   — 

[ Top ]

addAction   [line 348]

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

Registers a handler for a specific action.
  • Since: 2.1.0
  • Access: public

Parameters:

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

[ Top ]

addActions   [line 297]

void addActions( [ $actions = null])

Adds common actions for the frontend wizard
  • Since: 2.1.0
  • Access: public

Parameters:

   $actions   — 

[ Top ]

addPage   [line 271]

void addPage( array $page)

Add a specific page to wizard or each page one by one
  • Since: 2.1.0
  • Access: public

Parameters:

array   $page   —  a single Wizard page definition

[ Top ]

addPages   [line 251]

void addPages( [mixed $pages = null])

Adds all pages of wizard at once
  • Since: 2.1.0
  • Access: public

Parameters:

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

[ Top ]

createProgressBar   [line 384]

object createProgressBar( )

Creates a progress bar with options choosen on all wizard tabs.
  • Since: 2.0.0
  • Access: public

[ Top ]

createProgressStructure   [line 423]

array createProgressStructure( )

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

[ Top ]

isIncludeable   [line 363]

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: 2.1.0
  • Access: public

Parameters:

string   $file   — 

[ Top ]

singleton   [line 231]

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

Returns a unique instance of the given progress generator wizard.
  • Since: 2.1.0
  • Access: public

Parameters:

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

[ Top ]
Documentation generated on Mon, 11 Mar 2019 14:42:48 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.