Source for file Query.interface.php

Documentation is available at Query.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: Query.interface.php,v 1.8 2007/09/05 21:38:59 adamfranco Exp $
  9. */
  10. /**
  11. * A constant for an UNKNOWN query type.
  12. * @const UNKNOWN A constant for an UNKNOWN query type.
  13. * @access public
  14. */
  15. define("UNKNOWN", 1);
  16.  
  17. /**
  18. * A constant for a SELECT query type.
  19. * @const SELECT A constant for a SELECT query type.
  20. * @access public
  21. */
  22. define("SELECT", 1);
  23.  
  24. /**
  25. * A constant for an UPDATE query type.
  26. * @const UPDATE A constant for an UPDATE query type.
  27. * @access public
  28. */
  29. define("UPDATE", 2);
  30.  
  31. /**
  32. * A constant for an INSERT query type.
  33. * @const INSERT A constant for an INSERT query type.
  34. * @access public
  35. */
  36. define("INSERT", 3);
  37.  
  38. /**
  39. * A constant for a DELETE query type.
  40. * @const DELETE A constant for a DELETE query type.
  41. * @access public
  42. */
  43. define("DELETE", 4);
  44.  
  45. /**
  46. * A constant for a GENERIC query type.
  47. * @const GENERIC A constant for a GENERIC query type.
  48. * @access public
  49. */
  50. define("GENERIC", 5);
  51. /**
  52. * Defines a constant for 'AND' operations (used in WHERE and JOIN clauses)
  53. * @const integer _AND
  54. */
  55. define("_AND", 7);
  56. /**
  57. * Defines a constant for 'OR' operations (used in WHERE and JOIN clauses)
  58. * @const integer _OR
  59. */
  60. define("_OR", 8);
  61.  
  62. /**
  63. * A generic Query interface to be implemented by all Query objects.
  64. *
  65. *
  66. * @package harmoni.dbc
  67. *
  68. * @copyright Copyright &copy; 2005, Middlebury College
  69. * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
  70. *
  71. * @version $Id: Query.interface.php,v 1.8 2007/09/05 21:38:59 adamfranco Exp $
  72. */
  73.  
  74. interface Query {
  75.  
  76. /**
  77. * Resets the query.
  78. * @access public
  79. */
  80. public function reset() ;
  81. /**
  82. /**
  83. * Returns the type of this query.
  84. * Returns the type of this query: SELECT, INSERT, DELETE,
  85. * or UPDATE.
  86. * @access public
  87. * @return integer The type of this query: SELECT, INSERT, DELETE, or UPDATE.
  88. */
  89. public function getType() ;
  90.  
  91.  
  92. ?>

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