Docs For Class WLogicStepContainer

Description

StepContainer that add steps to its stack as the wizard goes along

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: WLogicStepContainer.class.php,v 1.7 2007/09/19 14:04:51 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 5/31/06

Located in /polyphony/main/library/Wizard/Components/WLogicStepContainer.class.php (line 25)

SObject
   |
   --WizardComponent
      |
      --WizardStepContainer
         |
         --WLogicStepContainer

Variable Summary

mixed $_backNamesStack

mixed $_backStepsStack

mixed $_forwardNamesStack

mixed $_forwardStepsStack

mixed $_stepStack

Method Summary

void WLogicStepContainer ()

boolean canGoBack ()

boolean canGoForward ()

void goBack ()

void goForward ()

boolean hasNext ()

void hasPrevious ()

void nextStep ([ref $button = null])

void previousStep ()

void pushSteps (array $steps)

void setRequiredSteps (mixed $arrayOfSteps, array $arrayOfSteps )

boolean update (string $fieldName)

boolean validate ()

Variables

mixed $_backNamesStack (line 29)

mixed $_backStepsStack (line 30)

mixed $_forwardNamesStack (line 31)

mixed $_forwardStepsStack (line 32)

mixed $_stepStack (line 27)

Inherited Variables

Inherited from WizardStepContainer

WizardStepContainer::$_currStep
WizardStepContainer::$_stepNames
WizardStepContainer::$_steps

Inherited from WizardComponent

WizardComponent::$_enabled
WizardComponent::$_enabledSticky
WizardComponent::$_parent

Methods

Constructor WLogicStepContainer (line 44)

Constructor

since: 5/31/06
access: public

void WLogicStepContainer ()

canGoBack (line 198)

Returns if this StepContainer has a next forward step.

access: public

boolean canGoBack ()

canGoForward (line 189)

Returns if this StepContainer has a next forward step.

access: public

boolean canGoForward ()

goBack (line 140)

Go backward in the history, if possible.

access: public

void goBack ()

goForward (line 167)

Go forward in the history, if possible.

access: public

void goForward ()

hasNext (line 213)

Returns if this StepContainer has a next step.

access: public

boolean hasNext ()

Redefinition of:

WizardStepContainer::hasNext(): Returns if this StepContainer has a next step.

hasPrevious (line 218)

void hasPrevious ()

Redefinition of:

WizardStepContainer::hasPrevious(): Returns if this StepContainer has a previous step.

nextStep (line 99)

Goes to the next step, if possible, by popping the next step off the stack.

access: public

void nextStep ([ref $button = null])

ref $button: object WLogicButton $button that has logic attached

Redefinition of:

WizardStepContainer::nextStep(): Goes to the next step, if possible.

previousStep (line 203)

void previousStep ()

Redefinition of:

WizardStepContainer::previousStep(): Goes to the previous step, if possible.

pushSteps (line 244)

adds the passed steps to the current step stack if they are not there

since: 5/31/06
access: public

void pushSteps (array $steps)

array $steps

setRequiredSteps (line 74)

Set the steps for this step container. Remove forward and backward capability.

access: public

void setRequiredSteps (mixed $arrayOfSteps, array $arrayOfSteps )

array $arrayOfSteps : $return void

update (line 62)

tells the wizard component to update itself... via the current step.

since: 5/31/06
access: public

boolean update (string $fieldName)

string $fieldName

Redefinition of:

WizardStepContainer::update(): Tells the wizard component to update itself - this may include getting form post data or validation - whatever this particular component wants to do every pageload.

validate (line 230)

Returns true if this component (and all child components if applicable) have valid values.

By default, this will just return TRUE.

access: public

boolean validate ()

Redefinition of:

WizardStepContainer::validate(): Returns true if this component (and all child components if applicable) have valid values.

Inherited Methods

Inherited From WizardStepContainer

WizardStepContainer::WizardStepContainer()
WizardStepContainer::addStep()
WizardStepContainer::getAllValues()
WizardStepContainer::getCurrentStep()
WizardStepContainer::getCurrentStepName()
WizardStepContainer::getMarkup()
WizardStepContainer::getStep()
WizardStepContainer::getSteps()
WizardStepContainer::hasNext()
WizardStepContainer::hasPrevious()
WizardStepContainer::nextStep()
WizardStepContainer::previousStep()
WizardStepContainer::setStep()
WizardStepContainer::setStepByKey()
WizardStepContainer::update()
WizardStepContainer::validate()

Inherited From WizardComponent

WizardComponent::getAllValues()
WizardComponent::getMarkup()
WizardComponent::getWizard()
WizardComponent::isEnabled()
WizardComponent::setEnabled()
WizardComponent::setParent()
WizardComponent::update()
WizardComponent::validate()

Inherited From SObject

SObject::asA()
SObject::asString()
SObject::copy()
SObject::copySameFrom()
SObject::copyTwoLevel()
SObject::deepCopy()
SObject::isEqual()
SObject::isEqualTo()
SObject::isNotEqualTo()
SObject::isNotReferenceTo()
SObject::isReferenceTo()
SObject::newFrom()
SObject::postCopy()
SObject::printableString()
SObject::shallowCopy()
SObject::_deepCopyArray()