Docs For Class ClassMethodsActionSource

Description

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.

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

Located in /harmoni/core/actionHandler/actionSources/ClassMethodsActionSource.class.php (line 16)

ActionSource
   |
   --ClassMethodsActionSource

Variable Summary

string $_basePath

string $_fileExtension

Method Summary

void ClassMethodsActionSource (string $basePath, string $fileExtension)

boolean actionExists (string $module, string $action)

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

string _mkFullPath (mixed $module, mixed $action)

Variables

string $_basePath (line 22)

var: The base path on the filesystem to look for module folders.
access: private

string $_fileExtension (line 28)

var: The extension to add onto action names to locate their associated files.
access: private

Methods

Constructor ClassMethodsActionSource (line 38)

Constructor

access: public

void ClassMethodsActionSource (string $basePath, string $fileExtension)

string $basePath: The base path on the filesystem which contains the module class declarations.
string $fileExtension: The extension to add onto module names to find the files, such that the module "main" might look for a file named "main.class.php" with a file extension of ".class.php".

actionExists (line 50)

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

access: public

boolean actionExists (string $module, string $action)

string $module
string $action

Redefinition of:

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

executeAction (line 88)

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

return: mixed A Layout or TRUE/FALSE
access: public

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

string $module: The module in which to execute.
string $action: The specific action to execute.
ref $harmoni: object $harmoni A reference to a Harmoni object.

Redefinition of:

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

_mkFullPath (line 74)

Makes a full pathname to an action file.

access: private

string _mkFullPath (mixed $module, mixed $action)

Inherited Methods

Inherited From ActionSource

ActionSource::actionExists()
ActionSource::executeAction()