HTML_Progress
[ class tree: HTML_Progress ] [ index: HTML_Progress ] [ all elements ]

Class: HTML_Progress_Generator

Source Location: /HTML_Progress-1.2.6/Progress/generator.php

Class Overview

HTML_QuickForm_Controller
   |
   --HTML_Progress_Generator

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


Author(s):

Version:

  • Release: 1.2.6

Copyright:

  • 1997-2005 The PHP Group

Methods


Inherited Variables

Inherited Methods


Class Details

[line 56]
The HTML_Progress_Generator class provides an easy way to dynamic 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

HTML_Progress_Generator (Constructor)   [line 124]

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

Constructor Summary

  • Creates a progress bar generator wizard with customized actions: progress bar preview, form rendering, buttons manager
    1.    $controllerName 'myPrivateGenerator';
    2.    $attributes = array(
    3.         'preview' => name of a HTML_QuickForm_Action instance
    4.                      (default 'ActionPreview'see 'HTML/Progress/generator/preview.php')
    5.         'display' => name of a HTML_QuickForm_Action_Display instance
    6.                      (default 'ActionDisplay'see 'HTML/Progress/generator/default.php')
    7.         'process' => name of a HTML_QuickForm_Action instance
    8.                      (default 'ActionProcess'see 'HTML/Progress/generator/process.php')
    9.    );
    10.    $generator = new HTML_Progress_Generator($controllerName$attributes);

  • Since: 1.1
  • Throws: HTML_PROGRESS_ERROR_INVALID_INPUT
  • 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 ]

createButtons   [line 284]

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

Adds all necessary buttons to the given page object.
  • Since: 1.1
  • Throws: HTML_PROGRESS_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 428]

object HTML_Progress createProgressBar( )

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

[ Top ]

createTabs   [line 242]

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

Adds all necessary tabs to the given page object.
  • Since: 1.1
  • Throws: HTML_PROGRESS_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 388]

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

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 15:24:46 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.