Class WizardStepContainer

Description
Description | Descendents | Vars (details) | Methods (details)

This is a special WizardComponent that will keep track of WizardSteps and switch from one to the other.

Located in /polyphony/main/library/Wizard/Components/WizardStepContainer.class.php (line 24) 

SObject
   |
   --WizardComponent
      |
      --WizardStepContainer
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
WLogicStepContainer StepContainer that add steps to its stack as the wizard goes along
Variable Summary
Description | Descendents | Vars (details) | Methods (details)
mixed $_currStep
mixed $_stepNames
mixed $_steps
Method Summary
Description | Descendents | Vars (details) | Methods (details)
void WizardStepContainer ()
ref addStep (string $name, ref $step)
mixed getAllValues ()
integer getCurrentStep ()
string getCurrentStepName ()
string getMarkup (string $fieldName)
ref getStep (string $name)
ref getSteps ()
boolean hasNext ()
boolean hasPrevious ()
void nextStep ()
void previousStep ()
void setStep (string $name, [mixed $context = array()])
void setStepByKey (integer $key, [mixed $context = array()])
boolean update (string $fieldName)
boolean validate ()
Variables
Description | Descendents | Vars (details) | Methods (details)
mixed $_currStep (line 25)
mixed $_stepNames (line 27)
mixed $_steps (line 26)

Inherited Variables

Inherited from WizardComponent

WizardComponent::$_enabled
 WizardComponent::$_enabledSticky
 WizardComponent::$_parent
Methods
Description | Descendents | Vars (details) Methods (details)
Constructor WizardStepContainer (line 34)

Constructor

  • access: public
void WizardStepContainer ()
addStep (line 47)

Adds a new WizardStep to this container.

  • return: object The new step object.
  • access: public
ref addStep (string $name, ref $step)
  • string $name: A reference/ID name for this wizard.
  • ref $step: object $step
getAllValues (line 234)

Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.

  • access: public
mixed getAllValues ()
Redefinition of:
WizardComponent::getAllValues()
Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
getCurrentStep (line 62)

Returns the current step number (starting at zero).

  • access: public
integer getCurrentStep ()
getCurrentStepName (line 73)

Gets the short-name associated with the current step.

  • access: public
string getCurrentStepName ()
getMarkup (line 250)

Returns a block of XHTML-valid code that contains markup for this specific component.

  • access: public
string getMarkup (string $fieldName)
  • string $fieldName: The field name to use when outputting form data or similar parameters/information.
Redefinition of:
WizardComponent::getMarkup()
Returns a block of XHTML-valid code that contains markup for this specific component.
getStep (line 130)

Returns the step referenced by $name.

  • return: object
  • access: public
ref getStep (string $name)
  • string $name
getSteps (line 120)

Returns an array of steps keyed by step name/id.

  • return: array
  • access: public
ref getSteps ()
hasNext (line 174)

Returns if this StepContainer has a next step.

  • access: public
boolean hasNext ()
Redefined in descendants as:
hasPrevious (line 183)

Returns if this StepContainer has a previous step.

  • access: public
boolean hasPrevious ()
Redefined in descendants as:
nextStep (line 142)

Goes to the next step, if possible.

  • access: public
void nextStep ()
Redefined in descendants as:
previousStep (line 158)

Goes to the previous step, if possible.

  • access: public
void previousStep ()
Redefined in descendants as:
setStep (line 84)

Sets the step to the one given by $name.

  • access: public
void setStep (string $name, [mixed $context = array()])
  • string $name
setStepByKey (line 110)

Set the step to the one given by key

  • since: 4/2/07
  • access: public
void setStepByKey (integer $key, [mixed $context = array()])
  • integer $key
update (line 217)

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.

  • return: - TRUE if everything is OK
  • access: public
boolean update (string $fieldName)
  • string $fieldName: The field name to use when outputting form data or similar parameters/information.
Redefinition of:
WizardComponent::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.
Redefined in descendants as:
validate (line 197)

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

By default, this will just return TRUE.

In this implementation, we will go through our steps and validate each one in turn. The first one that doesn't validate, we will move to that step so that the person can enter the information that is required.

  • access: public
boolean validate ()
Redefinition of:
WizardComponent::validate()
Returns true if this component (and all child components if applicable) have valid values.
Redefined in descendants as:

Inherited Methods

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()

Documentation generated on Wed, 19 Sep 2007 10:28:06 -0400 by phpDocumentor 1.3.0RC3