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


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

Class: HTML_Progress2_Generator

Source Location: /HTML_Progress2-2.0.0RC1/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: @package_version@

Copyright:

  • 1997-2005 The PHP Group

Methods

Inherited Variables

Inherited Methods

Class Details

[line 53]
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.

PHP versions 4 and 5

LICENSE: This source file is subject to version 3.0 of the PHP license that is available through the world-wide-web at the following URI: http://www.php.net/license/3_0.txt. If you did not receive a copy of the PHP License and are unable to obtain it through the web, please send a note to license@php.net so we can mail you a copy immediately.



[ Top ]

Method Detail

__construct (Constructor)   [line 133]

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 96]

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 ]

createButtons   [line 287]

void createButtons( &$page, array $buttons, [mixed $attributes = null], object $page)

Adds all necessary buttons to the given page object.
  • Since: 2.0.0
  • Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
  • Access: public

Parameters:

object   $page   —  Page where to put the button
array   $buttons   —  Key/label of each button/event to handle
mixed   $attributes   —  (optional) Either a typical HTML attribute string or an associative array.
   &$page   — 

[ Top ]

createProgressBar   [line 431]

object createProgressBar( )

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

[ Top ]

createProgressStructure   [line 470]

array createProgressStructure( )

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

[ Top ]

createTabs   [line 245]

void createTabs( &$page, [mixed $attributes = null], object $page)

Adds all necessary tabs to the given page object.
  • Since: 2.0.0
  • Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
  • Access: public

Parameters:

object   $page   —  Page where to put the button
mixed   $attributes   —  (optional) Either a typical HTML attribute string or an associative array.
   &$page   — 

[ Top ]

disableButton   [line 391]

void disableButton( &$page, [array $events = array()], object $page)

Disables certain buttons for a page.

Buttons [ = events] : back, next, cancel, reset, apply, help


Parameters:

object   $page   —  Page where you want to activate buttons
array   $events   —  (optional) List of buttons
   &$page   — 

[ Top ]

enableButton   [line 345]

void enableButton( &$page, [array $events = array()], object $page)

Enables certain buttons for a page.

Buttons [ = events] : back, next, cancel, reset, apply, help


Parameters:

object   $page   —  Page where you want to activate buttons
array   $events   —  (optional) List of buttons
   &$page   — 

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