Class: Wizard

Source Location: /gui/Wizard.php

Class Overview

UIModule
   |
   --Wizard

Wizard is a primary control structure that acts as a UI module containing "Cards" that are progressively encountered by the user depending on programmed state transitions and user entries.

Author(s):

brian.fioca@pangomedia.com

Variables

Constants

Methods

Inherited Constants

Class: UIModule

UIModule::USER

Inherited Variables

Class: UIModule

UIModule::$_arContent
UIModule::$_oSession

Inherited Methods

Class: UIModule

UIModule::__construct()
UIModule::addContent(): add Content to this module - ex. a Page, or another Module
UIModule::draw(): draws (by calling draw()) all Content that has been added to this Module
UIModule::getContent(): gets the array of all content added to this module
UIModule::handleEvents(): Method where Intra module event handling should go
UIModule::init(): Method where module initialization code should go
UIModule::setLoginRequired(): Sets whether the user needs to be logged in to access this module.

Class Details

[line 28]
Wizard is a primary control structure that acts as a UI module containing "Cards" that are progressively encountered by the user depending on programmed state transitions and user entries.

Tags:

abstract:
author:	brian.fioca@pangomedia.com

[ Top ]

Class Variables

$_arCards = array()

[line 42]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_oCurrentCard =

[line 38]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_oFinishCard =

[line 39]

Tags:

access:

protected

Type:

mixed

[ Top ]

Class Methods

constructor __construct [line 44]

Wizard __construct(
)

Overrides UIModule::__construct() (parent method not documented)

[ Top ]

method addCard [line 49]

void addCard(
mixed
$stCardName, mixed
$oCard, [mixed
$boFinishCard = false])

Tags:

access:

protected

[ Top ]

method getCurrentCard [line 109]

void getCurrentCard(
)

Tags:

access:

protected

[ Top ]

method getNextCard [line 57]

void getNextCard(
)

Tags:

access:

protected

[ Top ]

method getPreviousCard [line 83]

void getPreviousCard(
)

Tags:

access:

protected

[ Top ]

method getState [line 118]

void getState(
)

Tags:

access:

public

[ Top ]

method getUserId [line 123]

void getUserId(
)

Tags:

access:

public

[ Top ]

method processFinish [line 128]

void processFinish(
)

Tags:

access:	protected
abstract:

[ Top ]

Class Constants

CANCEL_BUTTON_NAME = 'cancelbutton'

[line 34]

[ Top ]

FINISH_BUTTON_NAME = 'finishbutton'

[line 35]

[ Top ]

NEXT_BUTTON_NAME = 'nextbutton'

[line 32]

[ Top ]

PARAM_PAGE_STATE = 'WIZARD_STATE'

[line 30]

[ Top ]

PREV_BUTTON_NAME = 'prevbutton'

[line 33]

[ Top ]

Documentation generated on Sun, 27 Nov 2005 13:16:01 -0500 by phpDocumentor 1.3.0RC3