Docs For Class ActionSource

Description

An abstract class for all ActionSource classes. ActionSource classes give the ActionHandler places to look for modules and actions for execution.

abstract:
version: $Id: ActionSource.abstract.php,v 1.5 2007/09/04 20:25:29 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Direct descendents

Class	Description
ClassesActionSource	The ClassesActionSource looks for actions as classes located within include files.
ClassMethodsActionSource	The ClassMethodsActionSource looks for actions as methods located within a class. The action names correspond to a method of the same name within a class. The class name is the same as module name.
FlatFileActionSource	The FlatFileActionSource class allows one to execute Harmoni actions (see ActionHandler) which are contained within

Method Summary

boolean actionExists (string $module, string $action)

ref executeAction (string $module, string $action, ref $harmoni)

Methods

actionExists (line 25)

Checks to see if a given modules/action pair exists for execution within this source.

boolean actionExists (string $module, string $action)

Redefined in descendants as:

ClassesActionSource::actionExists() : Checks to see if a given modules/action pair exists for execution within this source.
ClassMethodsActionSource::actionExists() : Checks to see if a given modules/action pair exists for execution within this source.
FlatFileActionSource::actionExists() : Checks to see if a given modules/action pair exists for execution within this source.

executeAction (line 38)

Executes the specified action in the specified module, using the Harmoni object as a base.

ref executeAction (string $module, string $action, ref $harmoni)

Redefined in descendants as:

ClassesActionSource::executeAction() : Executes the specified action in the specified module, using the Harmoni object as a base.
ClassMethodsActionSource::executeAction() : Executes the specified action in the specified module, using the Harmoni object as a base.
FlatFileActionSource::executeAction() : Executes the specified action in the specified module, using the Harmoni object as a base.