Docs For Class edit_agent

Description

This action will allow for the modification of group Membership.

version: $Id: edit_agent_details.act.php,v 1.23 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_agent_details.act.php (line 27)

Action
   |
   --WizardAction
      |
      --MainWindowAction
         |
         --edit_agent_detailsAction

Method Summary

void addProperty (mixed $agent)

void advancedViewAgentDetails (object Agent $agent)

void buildContent ()

void clearProperties (mixed $agent)

void confirmClearProperties (mixed $agent)

void confirmDeleteAgent (mixed $agent)

void deleteAgent (mixed $agent)

void deleteProperty (mixed $agent)

void editAgent (mixed $agent)

string getHeadingText ()

boolean isAuthorizedToExecute ()

void printCourseOfferings (mixed $offerings)

void updateDisplayName (mixed $agent)

void updateProperty (mixed $agent)

void viewAgentDetails (object Agent $agent)

void _getUsableProperties (mixed $agent)

void _printOffering (mixed $offering, mixed $term)

void _printRowFromPropertiesArray (mixed $propertiesArray, mixed $key, mixed $keyAlias)

Variables

Inherited Variables

Inherited from MainWindowAction

MainWindowAction::$_actionRows

Methods

addProperty (line 473)

*

Adds a property to the agent

void addProperty (mixed $agent)

advancedViewAgentDetails (line 241)

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

since: 7/19/05
access: public

void advancedViewAgentDetails (object Agent $agent)

object Agent $agent

buildContent (line 83)

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

*

Clears all the properties

void clearProperties (mixed $agent)

confirmClearProperties (line 299)

*

Offers a confirmation screen for clearing of properties

void confirmClearProperties (mixed $agent)

confirmDeleteAgent (line 329)

*

offers a confirmation screen for deleting an entire agent

void confirmDeleteAgent (mixed $agent)

deleteAgent (line 341)

*

Handles the actual deletion of an agent

void deleteAgent (mixed $agent)

deleteProperty (line 497)

* Deletes a property from the agent. Duh.

void deleteProperty (mixed $agent)

editAgent (line 362)

* 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 64)

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.

isAuthorizedToExecute (line 37)

Check Authorizations

since: 4/26/05
access: public

boolean isAuthorizedToExecute ()

Redefinition of:

Action::isAuthorizedToExecute(): Check Authorizations

printCourseOfferings (line 633)

void printCourseOfferings (mixed $offerings)

updateDisplayName (line 519)

*

Stores a new display name for the agent

void updateDisplayName (mixed $agent)

updateProperty (line 445)

**

Updates property from the edit agent form

void updateProperty (mixed $agent)

viewAgentDetails (line 153)

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

_getUsableProperties (line 543)

*

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)

_printOffering (line 592)

*

Print the course offering

void _printOffering (mixed $offering, mixed $term)

_printRowFromPropertiesArray (line 576)

* Tries to print a key value pair from the propertiesArray from getUsableProperties in a table.

It ignores type, and uses an alias for the key

void _printRowFromPropertiesArray (mixed $propertiesArray, mixed $key, mixed $keyAlias)

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

Class edit_agent_detailsAction

Inherited Variables

Inherited Methods