Docs For Class WOrderedRepeatableComponentCollection

Description

This component allows for the creation of ordered repeatable components or groups of components.

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

Located in /polyphony/main/library/Wizard/Components/WOrderedRepeatableComponentCollection.class.php (line 26)

SObject
   |
   --WizardComponent
      |
      --WizardComponentWithChildren
         |
         --WRepeatableComponentCollection
            |
            --WOrderedRepeatableComponentCollection

Variable Summary

mixed $_nextId

mixed $_orderedSet

Method Summary

WOrderedRepeatableComponentCollection WOrderedRepeatableComponentCollection ()

mixed getAllValues ()

string getMarkup (string $fieldName)

void rebuildPositionSelects ()

void setEnabled (boolean $enabled, [boolean $sticky = false])

boolean update (string $fieldName)

void _addElement ([boolean $removable = true])

void _removeElements (array $ar)

Variables

mixed $_nextId (line 31)

mixed $_orderedSet (line 30)

Inherited Variables

Inherited from WRepeatableComponentCollection

WRepeatableComponentCollection::$_addButton
WRepeatableComponentCollection::$_collections
WRepeatableComponentCollection::$_max
WRepeatableComponentCollection::$_min
WRepeatableComponentCollection::$_num
WRepeatableComponentCollection::$_prefixFunction
WRepeatableComponentCollection::$_text

Inherited from WizardComponentWithChildren

WizardComponentWithChildren::$_children

Inherited from WizardComponent

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

Methods

Constructor WOrderedRepeatableComponentCollection (line 33)

WOrderedRepeatableComponentCollection WOrderedRepeatableComponentCollection ()

getAllValues (line 198)

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:

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

getMarkup (line 220)

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:

WRepeatableComponentCollection::getMarkup(): Returns a block of XHTML-valid code that contains markup for this specific component.

rebuildPositionSelects (line 95)

Rebuild our position selects

since: 5/16/06
access: public

void rebuildPositionSelects ()

setEnabled (line 184)

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:

WRepeatableComponentCollection::setEnabled(): Sets if this component will be enabled or disabled.

update (line 135)

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:

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.

_addElement (line 46)

Adds a new element to the end of the list.

access: private

void _addElement ([boolean $removable = true])

boolean $removable: Can this collection be removed by the user?

Redefinition of:

WRepeatableComponentCollection::_addElement(): Adds a new element to the end of the list.

_removeElements (line 78)

Removes the elements from our list.

access: private

void _removeElements (array $ar)

array $ar: An array of element keys.

Redefinition of:

WRepeatableComponentCollection::_removeElements(): Removes the elements from our list.

Inherited Methods

Inherited From WRepeatableComponentCollection

WRepeatableComponentCollection::WRepeatableComponentCollection()
WRepeatableComponentCollection::addValueCollection()
WRepeatableComponentCollection::getAllValues()
WRepeatableComponentCollection::getMarkup()
WRepeatableComponentCollection::setAddLabel()
WRepeatableComponentCollection::setContent()
WRepeatableComponentCollection::setElementLayout()
WRepeatableComponentCollection::setEnabled()
WRepeatableComponentCollection::setMaximum()
WRepeatableComponentCollection::setMiminum()
WRepeatableComponentCollection::setRemoveLabel()
WRepeatableComponentCollection::setStartingNumber()
WRepeatableComponentCollection::setValue()
WRepeatableComponentCollection::update()
WRepeatableComponentCollection::usePrefixFunction()
WRepeatableComponentCollection::validate()
WRepeatableComponentCollection::_addElement()
WRepeatableComponentCollection::_ensureNumber()
WRepeatableComponentCollection::_getAllValues()
WRepeatableComponentCollection::_removeElements()

Inherited From WizardComponentWithChildren

WizardComponentWithChildren::addComponent()
WizardComponentWithChildren::getAllValues()
WizardComponentWithChildren::getChild()
WizardComponentWithChildren::getChildren()
WizardComponentWithChildren::removeChild()
WizardComponentWithChildren::setEnabled()
WizardComponentWithChildren::update()
WizardComponentWithChildren::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()