Source for file WECRule.interface.php

Documentation is available at WECRule.interface.php

  1. <?php
  2. /**
  3. * @since Jul 23, 2005
  4. * @package polyphony.wizard.errorchecking
  5. *
  6. * @copyright Copyright &copy; 2005, Middlebury College
  7. * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
  8. *
  9. * @version $Id: WECRule.interface.php,v 1.5 2007/09/19 14:04:52 adamfranco Exp $
  10. */
  11. /**
  12. * An interface that defines rules for javascript error checking with the {@link Wizard}.
  13. *
  14. * @since Jul 23, 2005
  15. * @package polyphony.wizard.errorchecking
  16. *
  17. * @copyright Copyright &copy; 2005, Middlebury College
  18. * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
  19. *
  20. * @version $Id: WECRule.interface.php,v 1.5 2007/09/19 14:04:52 adamfranco Exp $
  21. */
  22. interface WECRule {
  23. /**
  24. * Returns a block of javascript code defining a function like so:
  25. *
  26. * function(id) {
  27. * var el = getWizardElement(id);
  28. * return el.value.match(/\w+/);
  29. * }
  30. * @access public
  31. * @return string
  32. */
  33. function generateJavaScript () ;
  34. /**
  35. /**
  36. * Returns true if the passed {@link WizardComponent} validates against this rule.
  37. * @param ref object $component
  38. * @access public
  39. * @return boolean
  40. */
  41. function checkValue ($component) ;
  42.  
  43.  
  44.  
  45. ?>

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