Docs For Class WUpdateListener

Description

Supplies an event listener to a Wizard for update events, this will pass the control back to the wizard if it would like it.

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

Located in /polyphony/main/library/Wizard/Components/WUpdateListener.class.php (line 27)

SObject
   |
   --WizardComponent
      |
      --WizardEventListener
         |
         --WUpdateListener

Variable Summary

mixed $_added

mixed $_callBackFunction

Method Summary

WUpdateListener WUpdateListener (string $callBack)

mixed getAllValues ()

void handleEvent (string $eventType, ref $source, array $context)

boolean update (string $fieldName)

Variables

mixed $_added = false (line 31)

mixed $_callBackFunction (line 32)

Inherited Variables

Inherited from WizardComponent

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

Methods

Constructor WUpdateListener (line 41)

constructor

since: 8/04/06
access: public

WUpdateListener WUpdateListener (string $callBack)

string $callBack: the function to call when the event is called

getAllValues (line 64)

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:

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

handleEvent (line 77)

Handles an event triggered by an EventTrigger. The event type is passed in case this particular EventListener is handling more than one type of event.

access: public

void handleEvent (string $eventType, ref $source, array $context)

string $eventType
array $context: An array of contextual parameters - the content will be dependent on the thrown event.
ref $source: object $source The source object of the event.

Redefinition of:

WizardEventListener::handleEvent(): Handles an event triggered by an EventTrigger. The event type is passed in case this particular EventListener is handling more than one type of event.

update (line 54)

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:

WizardEventListener::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.

Inherited Methods

Inherited From WizardEventListener

WizardEventListener::getAllValues()
WizardEventListener::getMarkup()
WizardEventListener::handleEvent()
WizardEventListener::setParent()
WizardEventListener::update()
WizardEventListener::_attemptAdding()

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