Docs For Class HTML_QuickForm

$delta = array()

[line 83]

Set of paths from a state to another (FSM's transitions set)

Type:

array

[ Top ]

$finalStates = array()

[line 75]

List of final states (pages) in which the wizard stops (FSM's final states)

Type:

array

[ Top ]

$inputProducer = null

[line 91]

Function that determines the current input of the FSM, as an array of values, used to establish the next page of the wizard

Type:

function

[ Top ]

$startingState =

[line 67]

The first state (page) of the wizard (FSM's starting state)

Type:

string

[ Top ]

$states = array()

[line 59]

List of states (pages in form of pageName => className) of the wizard (FSM's set of states)

Type:

array

[ Top ]

constructor HTML_QuickForm_Wizard [line 101]

Wizard HTML_QuickForm_Wizard(
string
$name, [boolean
$modal = true])

Constructor

Parameters:

string	$name	name of the wizard
boolean	$modal	modal mode flag

[ Top ]

method addPage [line 130]

void addPage(
string
$pageName, string
$className, boolean
$isStart, [boolean
$isFinal = false])

Add a page to the wizard

Parameters:

string	$pageName	name of the page
string	$className	class of the page
boolean	$isStart	if true the page represents the start state of the FSM
boolean	$isFinal	if true the page represents a final state of the FSM

[ Top ]

method addTransition [line 161]

void addTransition(
string
$fromPage, mixed
$input, string
$toPage)

Add a transition from a state (page) to another

Parameters:

string	$fromPage
mixed	$input
string	$toPage

[ Top ]

method fromXML [line 280]

void fromXML(
string
$xml, [boolean
$isFile = false])

Import the FSM from a XML document

Parameters:

string	$xml	filename of a XML document or XML itself
boolean	$isFile	if true $xml represents a filename

[ Top ]

method getBackName [line 333]

string getBackName(
string
$pageName)

Returns the name of the previous page

Parameters:

string

$pageName

[ Top ]

method getCurrentPage [line 317]

string getCurrentPage(
)

Returns the name of the current page

[ Top ]

method getFSM [line 196]

array getFSM(
)

Returns an array representing the FSM

[ Top ]

method getNextName [line 346]

string getNextName(
mixed
$pageName)

Returns the name of the next page (overloading of Controller method)

[ Top ]

method getPageNames [line 364]

array getPageNames(
)

Returns the names of all pages

[ Top ]

method isFinal [line 186]

boolean isFinal(
string
$pageName)

Checks if the specified page is final

Tags:

return:

true if $pageName is a final page, false otherwise

Parameters:

string

$pageName

[ Top ]

method loadValues [line 374]

void loadValues(
array
$values)

Load values into pages' elements

Parameters:

array

$values

values to put into pages' elements

[ Top ]

method reset [line 306]

void reset(
)

Resets the wizard

[ Top ]

method setFSM [line 235]

void setFSM(
array
$fsm)

Set the FSM of the wizard

Parameters:

array

$fsm

array representing a FSM

[ Top ]

method setInputProducer [line 175]

void setInputProducer(
function
$inputProducer)

Sets the producer of input to the FSM

Parameters:

function

$inputProducer

new function that produces current input of the FSM

[ Top ]

method _getInput [line 428]

array _getInput(
)

Returns the current input of the wizard

[ Top ]

method _getNextPage [line 393]

string _getNextPage(
mixed
$pageName)

Returns next page that match specified page and current input of the FSM

[ Top ]

method _pop [line 471]

string _pop(
string
$current)

Pops the page previous the specified page from the stack

Tags:

return:

page in stack before specified page

Parameters:

string

$current

current page

[ Top ]

method _push [line 444]

void _push(
string
$old, string
$new)

Pushes the new page into the stack of pages

Parameters:

string	$old	actual page
string	$new	new page

[ Top ]

Class: HTML_QuickForm_Wizard

Class Overview

Author(s):

Version:

Variables

Methods

Class Details

Tags:

Class Variables

$delta = array()

$finalStates = array()

$inputProducer = null

$startingState =

$states = array()

Class Methods

constructor HTML_QuickForm_Wizard [line 101]

Parameters:

method addPage [line 130]

Parameters:

method addTransition [line 161]

Parameters:

method fromXML [line 280]

Parameters:

method getBackName [line 333]

Parameters:

method getCurrentPage [line 317]

method getFSM [line 196]

method getNextName [line 346]

method getPageNames [line 364]

method isFinal [line 186]

Tags:

Parameters:

method loadValues [line 374]

Parameters:

method reset [line 306]

method setFSM [line 235]

Parameters:

method setInputProducer [line 175]

Parameters:

method _getInput [line 428]

method _getNextPage [line 393]

method _pop [line 471]

Tags:

Parameters:

method _push [line 444]

Parameters: