Docs For Class WAgentBrowser

Description

This component allows you to search the agents in the system and select a number of them for some action.

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

Located in /polyphony/main/library/Wizard/Components/WAgentBrowser.class.php (line 25)

SObject
   |
   --WizardComponent
      |
      --WAgentBrowser

Variable Summary

mixed $_actionSelected

mixed $_agentsSelected

mixed $_oneType

mixed $_options

mixed $_resultPrinter

mixed $_searchButton

mixed $_searchField

mixed $_searchResults

mixed $_searchTypeSelector

Method Summary

WAgentBrowser WAgentBrowser ()

void addActionOption (mixed $action_name, mixed $label)

mixed getAllValues ()

string getMarkup (string $fieldName)

string printAgent (mixed $agent)

void reset ()

boolean update (string $fieldName)

Variables

mixed $_actionSelected = "nop" (line 39)

mixed $_agentsSelected = array() (line 28)

mixed $_oneType = false (line 35)

mixed $_options = array() (line 37)

mixed $_resultPrinter = null (line 30)

mixed $_searchButton = null (line 33)

mixed $_searchField = null (line 32)

mixed $_searchResults = array() (line 29)

mixed $_searchTypeSelector = null (line 34)

Inherited Variables

Inherited from WizardComponent

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

Methods

Constructor WAgentBrowser (line 41)

WAgentBrowser WAgentBrowser ()

addActionOption (line 82)

Adds an action to the list of actions presented to the end user.

void addActionOption (mixed $action_name, mixed $label)

getAllValues (line 146)

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

Returns an array, 0=>action selected, 1=>array(of agents selected)

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.

getMarkup (line 160)

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.

printAgent (line 193)

Callback function for the HTMLArrayResultPrinter.

static:
access: public

string printAgent (mixed $agent)

reset (line 69)

Resets the search results and the selected agents.

void reset ()

update (line 96)

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.

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