Source for file ActionSource.abstract.php

Documentation is available at ActionSource.abstract.php

  1. <?php
  2.  
  3. /**
  4. * An abstract class for all ActionSource classes. ActionSource classes give the {@link ActionHandler} places to look for
  5. * modules and actions for execution.
  6. *
  7. * @package harmoni.actions
  8. *
  9. * @copyright Copyright &copy; 2005, Middlebury College
  10. * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
  11. *
  12. * @version $Id: ActionSource.abstract.php,v 1.5 2007/09/04 20:25:29 adamfranco Exp $
  13. *
  14. * @abstract
  15. */
  16. class ActionSource {
  17. /**
  18. * Checks to see if a given modules/action pair exists for execution within this source.
  19. * @param string $module
  20. * @param string $action
  21. * @access public
  22. * @return boolean
  23. */
  24. function actionExists($module, $action)
  25. {
  26. return false;
  27. }
  28. /**
  29. * Executes the specified action in the specified module, using the Harmoni object as a base.
  30. * @param string $module The module in which to execute.
  31. * @param string $action The specific action to execute.
  32. * @param ref object $harmoni A reference to a {@link Harmoni} object.
  33. * @access public
  34. * @return ref mixed A {@link Layout} or TRUE/FALSE
  35. */
  36. function executeAction($module, $action, $harmoni)
  37. {
  38. }
  39. }

Documentation generated on Wed, 19 Sep 2007 10:21:19 -0400 by phpDocumentor 1.3.0RC3