Source for file UpdateQuery.interface.php

Documentation is available at UpdateQuery.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: UpdateQuery.interface.php,v 1.7 2007/09/05 21:38:59 adamfranco Exp $
  9. */
  10. require_once("Query.interface.php");
  11.  
  12.  
  13. /**
  14. * An UpdateQuery interface provides the tools to build an SQL UPDATE 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: UpdateQuery.interface.php,v 1.7 2007/09/05 21:38:59 adamfranco Exp $
  23. */
  24.  
  25. interface UpdateQueryInterface
  26. extends Query
  27. {
  28.  
  29. /**
  30. * Sets the table to update.
  31. * @param string $table The table to update.
  32. * @access public
  33. */
  34. function setTable($table);
  35.  
  36. /**
  37. /**
  38. * Sets the columns to update in the table.
  39. * @param array $table The columns to update in the table.
  40. * @access public
  41. */
  42. function setColumns($columns) ;
  43.  
  44. /**
  45. /**
  46. * Specifies the values that the will be assigned to the columns specified with setColumns().
  47. *
  48. * @param array The values that the will be assigned to the columns specified with setColumns().
  49. * @access public
  50. */
  51. function setValues($values) ;
  52.  
  53. /**
  54. /**
  55. * *Deprecated* Specifies the condition in the WHERE clause.
  56. *
  57. * The query will execute only on rows that fulfil the condition. If this method
  58. * is never called, then the WHERE clause will not be included.
  59. * @param string The WHERE clause condition.
  60. * @access public
  61. * @deprecated July 09, 2003 - Use addWhere() instead.
  62. */
  63. function setWhere($condition) ;
  64.  
  65. /**
  66. /**
  67. * Adds a new condition in the WHERE clause.
  68. *
  69. * The query will execute only on rows that fulfil the condition. If this method
  70. * is never called, then the WHERE clause will not be included.
  71. * @param string condition The WHERE clause condition to add.
  72. * @param integer logicalOperation The logical operation to use to connect
  73. * this WHERE condition with the previous WHERE conditions. Allowed values:
  74. * <code>_AND</code> and <code>_OR</code>.
  75. * @access public
  76. * @return void
  77. */
  78. function addWhere($condition, $logicalOperation = _AND) ;
  79.  
  80.  
  81. ?>

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