Docs For Class WSaveCancelListener

Description

Supplies an event listener to a Wizard and keeps track of if a Save or Cancel event was posted. This is useful for when saving Wizards in session to handle events.

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: WSaveCancelListener.class.php,v 1.6 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/WSaveCancelListener.class.php (line 25)

SObject
   |
   --WizardComponent
      |
      --WizardEventListener
         |
         --WSaveCancelListener

Variable Summary

mixed $_added

mixed $_cancel

mixed $_save

Method Summary

mixed getAllValues ()

string getMarkup (string $fieldName)

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

boolean isCancelRequested ()

boolean isSaveRequested ()

void setParent (ref $parent)

boolean update (string $fieldName)

void _attemptAdding ()

Variables

mixed $_added = false (line 31)

mixed $_cancel = false (line 29)

mixed $_save = false (line 28)

Inherited Variables

Inherited from WizardComponent

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

Methods

getAllValues (line 99)

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.

getMarkup (line 111)

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:

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

handleEvent (line 124)

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.

isCancelRequested (line 89)

Returns TRUE if a cancel event was triggered this pageload.

access: public

boolean isCancelRequested ()

isSaveRequested (line 80)

Returns TRUE if a save event was triggered this pageload.

access: public

boolean isSaveRequested ()

setParent (line 40)

Sets this component's parent (some kind of WizardComponentWithChildren so that it can have access to its information, if needed.

access: public

void setParent (ref $parent)

ref $parent: object $parent

Redefinition of:

WizardEventListener::setParent(): Sets this component's parent (some kind of WizardComponentWithChildren so that it can have access to its information, if needed.

update (line 70)

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.

_attemptAdding (line 51)

Attempts to add ourselves to the parent Wizard as an EventListener.

access: public

void _attemptAdding ()

Redefinition of:

WizardEventListener::_attemptAdding(): Attempts to add ourselves to the parent Wizard as an EventListener.

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