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

Class: Wizard

Source Location: /includes/Wizard.inc.php

Class Overview


This is the base class for each wizard. It is not instantiated by itself.


Variables

Methods


Child classes:

WizardOverviewDetail
This wizard implements an overview page and a details page
WizardSearchFormAndResults
This wizard implements a search form and results page

Class Details

[line 6]
This is the base class for each wizard. It is not instantiated by itself.



[ Top ]


Class Variables

$aTableInfo = array()

[line 17]



Tags:

access:  protected

Type:   mixed


[ Top ]

$oPageTemp =  NULL

[line 20]



Tags:

access:  protected

Type:   mixed


[ Top ]

$oParentApp =  NULL

[line 11]



Tags:

access:  protected

Type:   mixed


[ Top ]

$oParentAppDb =  NULL

[line 14]



Tags:

access:  protected

Type:   mixed


[ Top ]

$sPageTempId =  "__temp__"

[line 8]



Tags:

static:  
access:  public

Type:   mixed


[ Top ]

$sTitle =  "Wizard"

[line 24]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 29]

Wizard __construct( mixed $oParentApp)

Construct a new component



Tags:

access:  public


Overridden in child classes as:

WizardOverviewDetail::__construct()
Construct a new component
WizardSearchFormAndResults::__construct()
Construct a new component

[ Top ]

method getCurrentStep [line 120]

int getCurrentStep( )

Returns the currently active step in the wizard



Tags:

return:  The current step
static:  
access:  public


[ Top ]

method getNumSteps [line 111]

int getNumSteps( )

Returns the number of steps in this wizard.

This function is overwritten by each wizard.




Tags:

return:  Number of steps
access:  public


Overridden in child classes as:

WizardOverviewDetail::getNumSteps()
Returns the number of steps in this wizard
WizardSearchFormAndResults::getNumSteps()
Returns the number of steps in this wizard

[ Top ]

method getParentApp [line 50]

Application getParentApp( )

Returns the parent Application of this wizard



Tags:

return:  A reference to the parent app
access:  public


[ Top ]

method getParentAppDb [line 59]

AppDatabase getParentAppDb( )

Returns the parent Application's database



Tags:

return:  A reference to the parent app's database
access:  public


[ Top ]

method getTitle [line 41]

string getTitle( )

Returns the wizard's title



Tags:

return:  The wizard's title, e.g. "Overview & details page"
access:  public


[ Top ]

method handleParameterUi [line 188]

void handleParameterUi( )

Handles the user's input to the wizards parameter UI

This function is overwritten by each wizard




Tags:

access:  public


Overridden in child classes as:

WizardOverviewDetail::handleParameterUi()
Handles the user's input to the wizards parameter UI
WizardSearchFormAndResults::handleParameterUi()
Handles the user's input to the wizards parameter UI

[ Top ]

method handleParameterUiForCurrentStep [line 196]

boolean handleParameterUiForCurrentStep( )

Handles the user's input to the wizards parameter UI



Tags:

return:  TRUE if successful, FALSE if error occurred
access:  public


[ Top ]

method initialize [line 267]

void initialize( )

Initializes a new wizard, setting all parameters to their default values.

This function is extended by each wizard




Tags:

access:  public


Overridden in child classes as:

WizardOverviewDetail::initialize()
Initializes a new wizard, setting all parameters to their default values
WizardSearchFormAndResults::initialize()
Initializes a new wizard, setting all parameters to their default values

[ Top ]

method performActionAndFinish [line 275]

void performActionAndFinish( )

Performs the wizards action and cleans up.

This function is extended by each wizard.




Tags:

access:  protected


Overridden in child classes as:

WizardOverviewDetail::performActionAndFinish()
Performs the wizards action and finishes
WizardSearchFormAndResults::performActionAndFinish()
Performs the wizards action and finishes

[ Top ]

method printButtons [line 156]

void printButtons( )

Prints the wizard's buttons, e.g. < Previous, Next >, Cancel depending on the current step



Tags:

access:  public


[ Top ]

method printErrorMessage [line 255]

void printErrorMessage( )

Outputs an error message if one is contained in the temp variable "wizardErrorMessage".

After outputting the error message it is removed from the session




Tags:

access:  protected


[ Top ]

method printFinishCancelButtons [line 98]

void printFinishCancelButtons( )

Outputs the HTML to display a Finish and a Cancel button



Tags:

static:  
access:  public


[ Top ]

method printHtmlForCurrentStep [line 181]

void printHtmlForCurrentStep( )

Prints the HTML for a particular step in the wizard.

This function is overwritten by each wizard




Tags:

access:  public


Overridden in child classes as:

WizardOverviewDetail::printHtmlForCurrentStep()
Prints the HTML for a particular step in the wizard
WizardSearchFormAndResults::printHtmlForCurrentStep()
Prints the HTML for a particular step in the wizard

[ Top ]

method printNextCancelButtons [line 66]

void printNextCancelButtons( )

Outputs the HTML to display a Next > and a Cancel button



Tags:

static:  
access:  public


[ Top ]

method printPreviousFinishCancelButtons [line 87]

void printPreviousFinishCancelButtons( )

Outputs the HTML to display a < Previous, Finish and a Cancel button



Tags:

static:  
access:  public


[ Top ]

method printPreviousNextCancelButtons [line 76]

void printPreviousNextCancelButtons( )

Outputs the HTML to display a < Previous, Next > and a Cancel button



Tags:

static:  
access:  public


[ Top ]

method printUiContentsEnd [line 241]

void printUiContentsEnd( )

Outputs HTML to end the help column within the wizard window



Tags:

access:  public


[ Top ]

method printUiContentsStart [line 227]

void printUiContentsStart( string $sHelpText)

Outputs the HTML for the left-hand help column within the wizard window



Tags:

access:  public


Parameters:

string   $sHelpText   The help text that the help column will be filled with

[ Top ]

method setCurrentStep [line 129]

void setCurrentStep( int $iStepNr)

Sets the currently active step in the wizard



Tags:

static:  
access:  public


Parameters:

int   $iStepNr   The step number

[ Top ]


Documentation generated on Wed, 12 Jan 2005 17:53:17 -0500 by phpDocumentor 1.3.0RC3