Source for file InsertQuery.interface.php

Documentation is available at InsertQuery.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: InsertQuery.interface.php,v 1.5 2007/09/05 21:38:59 adamfranco Exp $
  9. */
  10. require_once("Query.interface.php");
  11.  
  12. /**
  13. * An InsertQuery interface provides the tools to build an SQL INSERT query.
  14. *
  15. *
  16. * @package harmoni.dbc
  17. *
  18. * @copyright Copyright &copy; 2005, Middlebury College
  19. * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
  20. *
  21. * @version $Id: InsertQuery.interface.php,v 1.5 2007/09/05 21:38:59 adamfranco Exp $
  22. */
  23.  
  24. interface InsertQueryInterface
  25. extends Query
  26. {
  27.  
  28. /**
  29. * Sets the table to insert into.
  30. * @param string $table The table to insert into.
  31. * @access public
  32. */
  33. function setTable($table) ;
  34.  
  35. /**
  36. /**
  37. * Sets the columns to insert into the table.
  38. * @param array $table The columns to insert into the table.
  39. * @access public
  40. */
  41. function setColumns($columns) ;
  42.  
  43. /**
  44. /**
  45. * Adds one row of values to insert into the table.
  46. *
  47. * By calling this method multiple times, you can insert many rows of
  48. * information using just one query.
  49. * @param array $values One row of values to insert into the table. Must
  50. * match the order of columns specified with the setColumns() method.
  51. * @access public
  52. */
  53. function addRowOfValues($values) ;
  54. /**
  55. /**
  56. * This is an alias for addRowOfValues for compatability with the UpdateQuery class.
  57. * Adds one row of values to insert into the table.
  58. * By calling this method multiple times, you can insert many rows of
  59. * information using just one query.
  60. * @see InsertQueryInterface::addRowOfValues
  61. * @param array $values One row of values to insert into the table. Must
  62. * match the order of columns specified with the setColumns() method.
  63. * @access public
  64. */
  65. function setValues($values) ;
  66.  
  67. /**
  68. /**
  69. * Sets the autoincrement column.
  70. * Sets the autoincrement column. This could be useful with Oracle, for example.
  71. * Do not include this column with the setColumns() method - it will be added
  72. * automatically.
  73. * @param string $column The autoincrement column.
  74. * @param string $sequence The sequence to use for generating new ids.
  75. * @access public
  76. */
  77. function setAutoIncrementColumn($column, $sequence) ;
  78.  
  79.  
  80. ?>

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