Class WizardComponentWithChildren

Description

This is an abstract class that defines a WizardComponent that can have children.

Located in /polyphony/main/library/Wizard/WizardComponentWithChildren.abstract.php (line 26)

SObject
   |
   --WizardComponent
      |
      --WizardComponentWithChildren
Direct descendents
Class Description
PrimitiveIO_okitype
WStyleCollection This class allows for the creation of a Style Collection GUI Wizard component.
WStyleProperty This class allows for the creation of a StyleProperty GUI Wizard Component.
WComponentCollection This allows for a grouping of Components. It is a single component itself that wraps other components to allow for the addition of multiple components where a single one is expected.
WizardStep The Wizard class provides a system for registering Wizard properties and associating those properties with the appropriate form elements.
WMoreOptions The goal here is to provide a system for having a simple view that the user can expand to get more options.
WRepeatableComponentCollection This component allows for the creation of repeatable components or groups of components.
WSelectOrNew <##>
WVerifiedChangeInput This component provides a checkbox next to the input field with which the user can confirm that they wish to change this field. This is useful when making forms which allow for the editing of many fields across multiple items where the user may only wish to change one of the fields across all items.
Wizard The Wizard class provides a system for posting, retrieving, and validating user input over a series of steps, as well as maintianing the submitted values over a series of steps, until the wizard is saved.
Variable Summary
mixed $_children
Method Summary
ref addComponent (string $name, ref $component)
mixed getAllValues ()
ref getChild (string $name)
ref getChildren ()
void removeChild (string $name)
void setEnabled (boolean $enabled, [boolean $sticky = false])
boolean update (string $fieldName)
boolean validate ()
Variables
mixed $_children = array() (line 30)

Inherited Variables

Inherited from WizardComponent

WizardComponent::$_enabled
WizardComponent::$_enabledSticky
WizardComponent::$_parent
Methods
addComponent (line 39)

Adds a WizardComponent to this component. It will return the newly added component.

  • return: object
  • access: public
ref addComponent (string $name, ref $component)
  • string $name: The short-string name of the component - this is used for creating form input field names and storing data.
  • ref $component: object $component A WizardComponent to add.
getAllValues (line 122)

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.

Redefined in descendants as:
  • PrimitiveIO_okitype::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WMoreOptions::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WRepeatableComponentCollection::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WOrderedRepeatableComponentCollection::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WSelectOrNew::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WVerifiedChangeInput::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • SimpleStepWizard::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • StepWizard::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
getChild (line 65)

Returns the component specified by $name.

  • return: object
  • access: public
ref getChild (string $name)
  • string $name
getChildren (line 55)

Returns an array of all the children of this component, keyed by name.

  • return: array
  • access: public
ref getChildren ()
removeChild (line 75)

Removes the specified child from this component.

  • access: public
void removeChild (string $name)
  • string $name
setEnabled (line 139)

Sets if this component will be enabled or disabled.

  • access: public
void setEnabled (boolean $enabled, [boolean $sticky = false])
  • boolean $enabled
  • boolean $sticky: If true, future calls to setEnabled without sticky will have no effect.

Redefinition of:
WizardComponent::setEnabled()
Sets if this component will be enabled or disabled.

Redefined in descendants as:
update (line 104)

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
  • since: Jul 21, 2006
  • 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:
  • WStyleCollection::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.
  • WStyleProperty::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.
  • WMoreOptions::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.
  • WRepeatableComponentCollection::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.
  • WAddFromListRepeatableComponentCollection::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.
  • WOrderedRepeatableComponentCollection::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.
  • WSelectOrNew::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.
  • PrimitiveIO_AuthoritativeContainer::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.
  • WVerifiedChangeInput::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.
  • Wizard::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 85)

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:
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:04 -0400 by phpDocumentor 1.3.0RC3