Docs For Class edit_propertiesAction

Description

This action allows for the editing of properties in agents.

version: $Id: edit_properties.act.php,v 1.10 2007/09/19 14:04:52 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 11/10/04

Located in /polyphony/main/modules/agents/edit_properties.act.php (line 27)

Action
   |
   --WizardAction
      |
      --MainWindowAction
         |
         --edit_propertiesAction

Variable Summary

mixed $_agentList

Method Summary

void addProperty (mixed $agent)

void buildContent ()

void clearProperties (mixed $agent)

void confirmClearProperties (mixed $agent)

void confirmDeleteAgent (mixed $agent)

void createWizard ()

void deleteAgent (mixed $agent)

void deleteProperty (mixed $agent)

void editAgent (mixed $agent)

string getHeadingText ()

void getReturnUrl ()

boolean isAuthorizedToExecute ()

void saveWizard (mixed $cacheName)

void updateDisplayName (mixed $agent)

void updateProperty (mixed $agent)

void viewAgentDetails (object Agent $agent)

void _getAgentList ()

void _getUsableProperties (mixed $agent)

Variables

mixed $_agentList = null (line 65)

Inherited Variables

Inherited from MainWindowAction

MainWindowAction::$_actionRows

Methods

addProperty (line 560)

*

Adds a property to the agent

void addProperty (mixed $agent)

buildContent (line 89)

Build the content for this action

since: 4/26/05
access: public

void buildContent ()

Redefinition of:

MainWindowAction::buildContent(): Build the content for this action.

clearProperties (line 398)

*

Clears all the properties

void clearProperties (mixed $agent)

confirmClearProperties (line 386)

*

Offers a confirmation screen for clearing of properties

void confirmClearProperties (mixed $agent)

confirmDeleteAgent (line 416)

*

offers a confirmation screen for deleting an entire agent

void confirmDeleteAgent (mixed $agent)

createWizard (line 114)

void createWizard ()

Redefinition of:

WizardAction::createWizard(): Create a new Wizard for this action. Caching of this Wizard is handled by getWizard() and does not need to be implemented here.

deleteAgent (line 428)

*

Handles the actual deletion of an agent

void deleteAgent (mixed $agent)

deleteProperty (line 584)

* Deletes a property from the agent. Duh.

void deleteProperty (mixed $agent)

editAgent (line 449)

* displays the screen for editing agents Type for new property is arbitrarily set as the type of the agent should probably draw from a list of usable types later on.

Some of these attributes are not "properties" per se and don't have types in that case, I've arbitrarily entered "Immutable Reality" under type

void editAgent (mixed $agent)

getHeadingText (line 61)

Return the heading text for this action, or an empty string.

since: 4/26/05
access: public

string getHeadingText ()

Redefinition of:

Action::getHeadingText(): Return the heading text for this action, or an empty string.

getReturnUrl (line 330)

void getReturnUrl ()

Redefinition of:

WizardAction::getReturnUrl(): Return the URL that this action should return to when completed.

isAuthorizedToExecute (line 37)

Check Authorizations

since: 4/26/05
access: public

boolean isAuthorizedToExecute ()

Redefinition of:

Action::isAuthorizedToExecute(): Check Authorizations

saveWizard (line 268)

void saveWizard (mixed $cacheName)

Redefinition of:

WizardAction::saveWizard(): Save our results. Tearing down and unsetting the Wizard is handled by in runWizard() and does not need to be implemented here.

updateDisplayName (line 606)

*

Stores a new display name for the agent

void updateDisplayName (mixed $agent)

updateProperty (line 532)

**

Updates property from the edit agent form

void updateProperty (mixed $agent)

viewAgentDetails (line 345)

shows the details of the agent's properties and gives menu of actions

since: 7/19/05
access: public

void viewAgentDetails (object Agent $agent)

object Agent $agent

_getAgentList (line 66)

void _getAgentList ()

_getUsableProperties (line 630)

*

creates a two dimensional array of key (value/type) pairs, preserving most of the information from the object modify at will

void _getUsableProperties (mixed $agent)

Inherited Methods

Inherited From MainWindowAction

MainWindowAction::buildContent()
MainWindowAction::execute()
MainWindowAction::getActionRows()

Inherited From WizardAction

WizardAction::cancelWizard()
WizardAction::cleanCacheName()
WizardAction::closeWizard()
WizardAction::createWizard()
WizardAction::getReturnUrl()
WizardAction::getWizard()
WizardAction::runWizard()
WizardAction::saveWizard()

Inherited From Action

Action::execute()
Action::getHeadingText()
Action::getUnauthorizedMessage()
Action::isAuthorizedToExecute()
Action::requestedAction()
Action::requestedModule()