Source for file SQLGenerator.interface.php

Documentation is available at SQLGenerator.interface.php

  1. <?php
  2. /**
  3. * @package harmoni.dbc
  4. *
  5. * @copyright Copyright &copy; 2005, Middlebury College
  6. * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
  7. *
  8. * @version $Id: SQLGenerator.interface.php,v 1.3 2005/04/07 16:33:23 adamfranco Exp $
  9. */
  10.  
  11. /**
  12. * A SQLGeneratorInterface interface is the parent of all SQLGenerator objects.
  13. * A SQLGeneratorInterface interface declares only one method, namely
  14. * generateSQLQuery(), which takes a query object as a parameter. The method
  15. * returns the SQL string representation of that query object - thus, a SQLGenerator.
  16. * @version $Id: SQLGenerator.interface.php,v 1.3 2005/04/07 16:33:23 adamfranco Exp $
  17. *
  18. * @package harmoni.dbc
  19. *
  20. * @copyright Copyright &copy; 2005, Middlebury College
  21. * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
  22. *
  23. * @version $Id: SQLGenerator.interface.php,v 1.3 2005/04/07 16:33:23 adamfranco Exp $
  24. */
  25.  
  26. class SQLGeneratorInterface {
  27.  
  28. /**
  29. * Returns a string representing the SQL query corresonding to the specified Query object.
  30. * @param object QueryInterface $query The object from which to generate the SQL string.
  31. * @return string A string representing the SQL query corresonding to this Query object.
  32. * @static
  33. * @access public
  34. */
  35. function generateSQLQuery($query) { die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); }
  36.  
  37. }
  38.  
  39. ?>

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