Source for file sql.php

Documentation is available at sql.php

  1. <?php
  2. /**
  3. * SQL interface functions, return statuscodes as appropriate
  4. *
  5. * The SQL functions are encapsulated here to make it easier
  6. * to keep track of them, particularly for porting to other databases. Encapsulation is
  7. * done here with a functional interface not an object interface.
  8. *
  9. * @todo //TODO: work out why we didn't just use PEAR::DB and be done with it right from the beginning
  10. *
  11. * @author     Stuart Prescott
  12. * @copyright  Copyright Stuart Prescott
  13. * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  14. * @version    $Id$
  15. * @package    Bumblebee
  16. * @subpackage FormsLibrary
  17. */
  18.  
  19. /** Load ancillary functions */
  20. require_once 'inc/typeinfo.php';
  21. checkValidInclude();
  22.  
  23. /** status codes for success/failure of database actions */
  24. require_once('inc/statuscodes.php');
  25.  
  26. /**
  27. * run an sql query without returning data
  28. *
  29. * @param string $q       the sql query, properly constructed and quoted
  30. * @param boolean $fatal_sql   db errors are fatal
  31. * @return integer status from statuscodes
  32. */
  33. function db_quiet($q, $fatal_sql=0) {
  34.   //preDump(debug_backtrace());
  35.   // returns from statuscodes
  36.   $sql = mysql_query($q);
  37.   echoSQL($q);
  38.   if (! $sql) {
  39.     return echoSQLerror(mysql_error(), $fatal_sql);
  40.   } else {
  41.     return STATUS_OK; // should this return the $sql handle?
  42.   }
  43. }
  44.  
  45. /**
  46. * run an sql query and return the sql handle for further requests
  47. *
  48. * @param string $q       the sql query, properly constructed and quoted
  49. * @param boolean $fatal_sql   db errors are fatal
  50. * @return resource mysql query handle
  51. */
  52. function db_get($q, $fatal_sql=0) {
  53.   //preDump(debug_backtrace());
  54.   // returns from statuscodes or a db handle
  55.   $sql = mysql_query($q);
  56.   echoSQL($q);
  57.   if (! $sql) {
  58.     return echoSQLerror(mysql_error(), $fatal_sql);
  59.   } else {
  60.     return $sql;
  61.   }
  62. }
  63.  
  64. /**
  65. * run an sql query and return the single (or first) row returned
  66. *
  67. * @param string $q       the sql query, properly constructed and quoted
  68. * @param boolean $fatal_sql   db errors are fatal
  69. * @return mixed   array if successful, false if error
  70. */
  71. function db_get_single($q, $fatal_sql=0) {
  72.   $sql = db_get($q, $fatal_sql);
  73.   //preDump($sql);
  74.   return ($sql != STATUS_ERR ? mysql_fetch_array($sql) : false);
  75. }
  76.  
  77. /**
  78. * return the last insert ID from the database
  79. * @return integer id (row number) of previous insert operation
  80. */
  81. function db_new_id() {
  82.   return mysql_insert_id();
  83. }
  84.  
  85. /**
  86. * return the next row from a query
  87. *
  88. * @param resource db query handle
  89. * @return array next row from query
  90. */
  91. function db_fetch_array($sql) {
  92.   if (! is_resource($sql)) return null;
  93.   return mysql_fetch_array($sql);
  94. }
  95.  
  96.  
  97. /**
  98. * get the number of rows returned by a query
  99. *
  100. * @param resource db query handle
  101. * @return integer number of rows
  102. */
  103. function db_num_rows($sql) {
  104.   return mysql_num_rows($sql);
  105. }
  106.  
  107. /**
  108. * echo the SQL query to the browser
  109. *
  110. * @param string $echo       the sql query
  111. * @param boolean $success   query was successful
  112. */
  113. function echoSQL($echo, $success=0) {
  114.   $conf = ConfigReader::getInstance();
  115.   if ($conf->VerboseSQL) {
  116.     echo "<div class='sql'>".xssqw($echo, false)
  117.         .($success ? '<div>'.T_('(successful)').'</div>' : '')
  118.         ."</div>";
  119.   }
  120. }
  121.  
  122.  
  123. /**
  124. * echo the SQL query to the browser
  125. *
  126. * @param string $echo       the sql query
  127. * @param boolean $fatal     die on error
  128. */
  129. function echoSQLerror($echo, $fatal=0) {
  130.   $conf = ConfigReader::getInstance();
  131.   if ($echo != '' && $echo) {
  132.     if ($conf->VerboseSQL) {
  133.       echo "<div class='sql error'>". xssqw($echo) ."</div>";
  134.     }
  135.    if ($fatal) {
  136.       echo "<div class='sql error'>"
  137.         .sprintf(T_("Ooops. Something went very wrong. Please send the following log information to <a href='mailto:%s'>your Bumblebee Administrator</a> along with a description of what you were doing and ask them to pass it on to the Bumblebee developers. Thanks!"), $conf->AdminEmail)
  138.         .'</div>';
  139.       if ($conf->VerboseSQL) {
  140.         preDump(debug_backtrace());
  141.       } else {
  142.         logmsg(1, "SQL ERROR=[$echo]");
  143.         logmsg(1, serialize(debug_backtrace()));
  144.       }
  145.       die('<b>'.T_('Fatal SQL error. Aborting.').'</b>');
  146.     }
  147.   }
  148.   return STATUS_ERR;
  149. }
  150.  
  151. /**
  152. * construct and perform a simple SQL select
  153. *
  154. * @param string  $table  name of the table (will have TABLEPREFIX added to it
  155. * @param mixed   $key    single column name or list of columns for the WHERE clause
  156. * @param mixed   $value  single value or list of values for WHERE $key=$value
  157. * @param boolean $fatal     die on error
  158. * @param boolean $countonly   run a COUNT(*) query not a SELECT query
  159. * @return mixed   array if successful, false if error
  160. * @global string prefix for tabl nname
  161. */
  162. function quickSQLSelect($table, $key, $value, $fatal=1, $countonly=0) {
  163.   global $TABLEPREFIX;
  164.   if (! is_array($key)) {
  165.     if ($key != '') {
  166.       $key = array($key);
  167.     } else {
  168.       $key = array();
  169.     }
  170.   }
  171.   if (! is_array($value)) {
  172.     if ($value != '') {
  173.       $value = array($value);
  174.     } else {
  175.       $value = array();
  176.     }
  177.   }
  178.   $where = array();
  179.   foreach ($key as $k => $col) {
  180.     $where[] = $col.'='.qw($value[$k]);
  181.   }
  182.   $q = 'SELECT '.($countonly ? 'count(*)' : '*')
  183.       .' FROM '.$TABLEPREFIX.$table
  184.       .(count($where) ? ' WHERE '.join($where,' AND ') : '')
  185.       .' LIMIT 1';         // we only ever return one row from this func, so LIMIT the query.
  186.   return db_get_single($q, $fatal);
  187. }
  188.  
  189. /**
  190. * returns the current version of the database that is being talked to
  191. * @return string database version
  192. */
  193. function db_get_version() {
  194.   $conf = ConfigReader::getInstance();
  195.   if (! $conf->status->database) return "unavailable";
  196.   return mysql_get_server_info();
  197. }
  198.  
  199. /**
  200. * returns the name of the database software that is being talked to
  201. * @return string database server software name
  202. */
  203. function db_get_name() {
  204.   return 'MySQL';
  205. }
  206.  
  207. ?>

Documentation generated on Tue, 06 Mar 2007 10:02:00 +0000 by phpDocumentor 1.3.0