Source for file DeleteQuery.interface.php

Documentation is available at DeleteQuery.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: DeleteQuery.interface.php,v 1.7 2007/09/05 21:38:59 adamfranco Exp $
  9. */
  10. require_once("Query.abstract.php");
  11.  
  12.  
  13. /**
  14. * A DeleteQuery interface provides the tools to build an SQL DELETE query.
  15. *
  16. *
  17. * @package harmoni.dbc
  18. *
  19. * @copyright Copyright &copy; 2005, Middlebury College
  20. * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
  21. *
  22. * @version $Id: DeleteQuery.interface.php,v 1.7 2007/09/05 21:38:59 adamfranco Exp $
  23. */
  24.  
  25. interface DeleteQueryInterface
  26. extends Query
  27. {
  28.  
  29. /**
  30. * Sets the table to delete from.
  31. * @param string $table The table to delete from.
  32. * @access public
  33. */
  34. function setTable($table) ;
  35.  
  36. /**
  37. /**
  38. * *Deprecated* Specifies the condition in the WHERE clause.
  39. *
  40. * The query will execute only on rows that fulfil the condition. If this method
  41. * is never called, then the WHERE clause will not be included.
  42. * @param string The WHERE clause condition.
  43. * @access public
  44. * @deprecated July 09, 2003 - Use addWhere() instead.
  45. */
  46. function setWhere($condition) ;
  47.  
  48. /**
  49. /**
  50. * Adds a new condition in the WHERE clause.
  51. *
  52. * The query will execute only on rows that fulfil the condition. If this method
  53. * is never called, then the WHERE clause will not be included.
  54. * @param string condition The WHERE clause condition to add.
  55. * @param integer logicalOperation The logical operation to use to connect
  56. * this WHERE condition with the previous WHERE conditions. Allowed values:
  57. * <code>_AND</code> and <code>_OR</code>.
  58. * @access public
  59. * @return void
  60. */
  61. function addWhere($condition, $logicalOperation = _AND) ;
  62.  
  63. ?>

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