Docs For Class Action

Description

This class is the most simple abstraction of an action. It provides a structure for common methods

since: 4/28/05
version: $Id: Action.class.php,v 1.9 2007/09/19 14:04:41 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /polyphony/main/library/AbstractActions/Action.class.php (line 23)

Direct descendents

Class	Description
ForceAuthAction	The ForceAuthAction forces token collection via HTTP Authentication to allow
WizardAction	This class is an abstract class that provides a structure for building actions
XmlAction	A generic class for writing XML responses
loginAction	Change the language to the one specified by the user
login_typeAction	Change the language to the one specified by the user
logoutAction	Change the language to the one specified by the user
logout_typeAction	Change the language to the one specified by the user
addAjaxAction
browse_xmlAction
getFileAction	Give the user the file that they wish to download
filebrowserAction	This class is the most simple abstraction of an action. It provides a structure for common methods
browse_helpAction	This is the help-browser action which enables browsing of help documentation.
changeAction	Change the language to the one specified by the user

Method Summary

mixed execute ()

string getHeadingText ()

string getUnauthorizedMessage ()

boolean isAuthorizedToExecute ()

string requestedAction ()

string requestedModule ()

Methods

execute (line 78)

Execute this action.

since: 4/25/05
access: public

mixed execute ()

Redefined in descendants as:

RSSAction::execute() : Build the content for this action
viewfileAction::execute() : Build the content for this action
viewthumbnailAction::execute() : Build the content for this action
MainWindowAction::execute() : Execute this action. This is a template method that handles setting up components of the screen as well as authorization, delegating the various parts to descendent classes.
emptyAjaxAction::execute() : Build the content for this action
AuthZXmlAction::execute() : Execute this action
addTagAction::execute() : Execute this action.
deleteUserAction::execute() : Execute this action.
getAllUserTagsAction::execute() : Execute this action.
getTagsAction::execute() : Execute this action.
getTagsByUserAction::execute() : Execute this action.
getTagsNotByUserAction::execute() : Execute this action.
removeTagAction::execute() : Execute this action.
renameUserAction::execute() : Execute this action.
loginAction::execute() : Execute this action.
login_typeAction::execute() : Execute this action.
logoutAction::execute() : Execute this action.
logout_typeAction::execute() : Execute this action.
addAjaxAction::execute() : Build the content for this action
browse_xmlAction::execute() : Build the content for this action
getFileAction::execute() : Execute the action
filebrowserAction::execute() : Execute this action.
browse_helpAction::execute() : Execute this action.
changeAction::execute() : Execute this action.

getHeadingText (line 67)

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

since: 4/26/05
access: public

string getHeadingText ()

Redefined in descendants as:

add_delete_groupAction::getHeadingText() : Return the heading text for this action, or an empty string.
agent_SearchAction::getHeadingText() : Return the heading text for this action, or an empty string.
create_agentAction::getHeadingText() : Return the heading text for this action, or an empty string.
deleteAction::getHeadingText() : Return the heading text for this action, or an empty string.
edit_agent_detailsAction::getHeadingText() : Return the heading text for this action, or an empty string.
edit_agentsAction::getHeadingText() : Return the heading text for this action, or an empty string.
edit_propertiesAction::getHeadingText() : Return the heading text for this action, or an empty string.
group_browseAction::getHeadingText() : Return the heading text for this action, or an empty string.
group_membershipAction::getHeadingText() : Return the heading text for this action, or an empty string.
username_password_formAction::getHeadingText() : Return the heading text for this action, or an empty string.
browse_authorizationsAction::getHeadingText() : Return the heading text for this action, or an empty string.
choose_agentAction::getHeadingText() : Return the heading text for this action, or an empty string.
clear_authorizationsAction::getHeadingText() : Return the heading text for this action, or an empty string.
edit_authorizationsAction::getHeadingText() : Return the heading text for this action, or an empty string.
addAction::getHeadingText() : Return the heading text for this action, or an empty string.
downAction::getHeadingText() : Return the heading text for this action, or an empty string.
emptyAjaxAction::getHeadingText() : Return the heading text for this action, or an empty string.
exportAction::getHeadingText() : Return the heading text for this action, or an empty string.
removeAction::getHeadingText() : Return the heading text for this action, or an empty string.
upAction::getHeadingText() : Return the heading text for this action, or an empty string.
viewAction::getHeadingText() : Return the heading text for this action, or an empty string.
course_searchAction::getHeadingText() : Return the heading text for this action, or an empty string.
createcourseAction::getHeadingText() : Return the heading text for this action, or an empty string.
createcoursesectionAction::getHeadingText() : Return the heading text for this action, or an empty string.
createnewtermAction::getHeadingText() : Return the heading text for this action, or an empty string.
createnewtypeAction::getHeadingText() : Return the heading text for this action, or an empty string.
edit_offering_detailsAction::getHeadingText() : Return the heading text for this action, or an empty string.
edit_section_detailsAction::getHeadingText() : Return the heading text for this action, or an empty string.
edit_section_rosterAction::getHeadingText() : Return the heading text for this action, or an empty string.
suck_by_agentAction::getHeadingText() : Return the heading text for this action, or an empty string.
suck_it_upAction::getHeadingText() : Return the heading text for this action, or an empty string.
theme_editorAction::getHeadingText() : Return the heading text for this action, or an empty string.
browseAction::getHeadingText() : Return the heading text for this action, or an empty string.
TagAction::getHeadingText() : Return the heading text for this action, or an empty string.
allAction::getHeadingText() : Return the heading text for this action, or an empty string.
userAction::getHeadingText() : Return the heading text for this action, or an empty string.
viewRepositoryAction::getHeadingText() : Return the heading text for this action, or an empty string.
change_passwordAction::getHeadingText() : Return the heading text for this action, or an empty string.
addAjaxAction::getHeadingText() : Return the heading text for this action, or an empty string.
browse_xmlAction::getHeadingText() : Return the heading text for this action, or an empty string.
filebrowserAction::getHeadingText() : Return the heading text for this action, or an empty string.
browse_helpAction::getHeadingText() : Return the heading text for this action, or an empty string.

getUnauthorizedMessage (line 44)

Answer the message to print when the user is not authorized to execute this action

since: 7/18/05
access: public

string getUnauthorizedMessage ()

Redefined in descendants as:

viewfileAction::getUnauthorizedMessage() : Return a junk image that says you can't view the file
viewthumbnailAction::getUnauthorizedMessage() : Return a junk image that says you can't view the file
add_groupAction::getUnauthorizedMessage() : Return the "unauthorized" string to pring
edit_agentsAction::getUnauthorizedMessage() : Return the "unauthorized" string to pring
exportAction::getUnauthorizedMessage() : Return the "unauthorized" string to pring
createnewtermAction::getUnauthorizedMessage() : Return the "unauthorized" string to pring
createnewtypeAction::getUnauthorizedMessage() : Return the "unauthorized" string to pring
theme_editorAction::getUnauthorizedMessage() : Return the "unauthorized" string to pring <em>Note: I think that's supposed to mean print--Tim</em>
change_passwordAction::getUnauthorizedMessage()
XmlAction::getUnauthorizedMessage() : Answer a unauthorized response

isAuthorizedToExecute (line 32)

Check Authorizations

since: 4/26/05
access: public

boolean isAuthorizedToExecute ()

Redefined in descendants as:

ForceAuthAction::isAuthorizedToExecute() : Check Authorizations
add_delete_groupAction::isAuthorizedToExecute() : Check Authorizations
add_groupAction::isAuthorizedToExecute() : Check Authorizations
add_to_groupAction::isAuthorizedToExecute() : Check Authorizations
agent_SearchAction::isAuthorizedToExecute() : Check Authorizations
create_agentAction::isAuthorizedToExecute() : Check Authorizations
deleteAction::isAuthorizedToExecute() : Check Authorizations
edit_agent_detailsAction::isAuthorizedToExecute() : Check Authorizations
edit_agentsAction::isAuthorizedToExecute() : Check Authorizations
edit_propertiesAction::isAuthorizedToExecute() : Check Authorizations
group_browseAction::isAuthorizedToExecute() : Check Authorizations
group_membershipAction::isAuthorizedToExecute() : Check Authorizations
remove_from_groupAction::isAuthorizedToExecute() : Check Authorizations
username_password_formAction::isAuthorizedToExecute() : Check Authorizations
browse_authorizationsAction::isAuthorizedToExecute() : Check Authorizations
choose_agentAction::isAuthorizedToExecute() : Check Authorizations
clear_authorizationsAction::isAuthorizedToExecute() : Check Authorizations
edit_authorizationsAction::isAuthorizedToExecute() : Check Authorizations
addAction::isAuthorizedToExecute() : Check Authorizations
downAction::isAuthorizedToExecute() : Check Authorizations
emptyAction::isAuthorizedToExecute()
emptyAjaxAction::isAuthorizedToExecute() : Check Authorizations
exportAction::isAuthorizedToExecute() : Check Authorizations
removeAction::isAuthorizedToExecute() : Check Authorizations
upAction::isAuthorizedToExecute() : Check Authorizations
viewAction::isAuthorizedToExecute() : Check Authorizations
course_searchAction::isAuthorizedToExecute() : Check Authorizations
createcourseAction::isAuthorizedToExecute() : Check Authorizations
createcoursesectionAction::isAuthorizedToExecute() : Check Authorizations
createnewtermAction::isAuthorizedToExecute() : Check Authorizations
createnewtypeAction::isAuthorizedToExecute() : Check Authorizations
edit_offering_detailsAction::isAuthorizedToExecute() : Check Authorizations
edit_section_detailsAction::isAuthorizedToExecute() : Check Authorizations
edit_section_rosterAction::isAuthorizedToExecute() : Check Authorizations
suck_by_agentAction::isAuthorizedToExecute() : Check Authorizations
suck_it_upAction::isAuthorizedToExecute() : Check Authorizations
viewExifAction::isAuthorizedToExecute() : Check Authorizations
theme_editorAction::isAuthorizedToExecute() : Check Authorizations
browseAction::isAuthorizedToExecute() : Check Authorizations
allAction::isAuthorizedToExecute() : Check Authorizations
userAction::isAuthorizedToExecute() : Check Authorizations
viewRepositoryAction::isAuthorizedToExecute() : Check Authorizations
change_passwordAction::isAuthorizedToExecute() : Check Authorizations
getWhoCanDoAction::isAuthorizedToExecute() : Check Authorizations
TagXmlAction::isAuthorizedToExecute() : Check Authorizations
loginAction::isAuthorizedToExecute() : Check Authorizations
login_typeAction::isAuthorizedToExecute() : Check Authorizations
logoutAction::isAuthorizedToExecute() : Check Authorizations
logout_typeAction::isAuthorizedToExecute() : Check Authorizations
addAjaxAction::isAuthorizedToExecute() : Check Authorizations
browse_xmlAction::isAuthorizedToExecute() : Check Authorizations
filebrowserAction::isAuthorizedToExecute() : Check Authorizations
browse_helpAction::isAuthorizedToExecute() : Check Authorizations
changeAction::isAuthorizedToExecute() : Check Authorizations

requestedAction (line 104)

Answer the requested action, maybe other than this action's action if this action was chained onto another's request.

since: 6/3/05
access: public

string requestedAction ()

requestedModule (line 90)

Answer the requested module, maybe other than this action's module if this action was chained onto another's request.

since: 6/3/05
access: public

string requestedModule ()