3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
6 * Contains the DB_common base class
10 * LICENSE: This source file is subject to version 3.0 of the PHP license
11 * that is available through the world-wide-web at the following URI:
12 * http://www.php.net/license/3_0.txt. If you did not receive a copy of
13 * the PHP License and are unable to obtain it through the web, please
14 * send a note to license@php.net so we can mail you a copy immediately.
18 * @author Stig Bakken <ssb@php.net>
19 * @author Tomas V.V. Cox <cox@idecnet.com>
20 * @author Daniel Convissor <danielc@php.net>
21 * @copyright 1997-2007 The PHP Group
22 * @license http://www.php.net/license/3_0.txt PHP License 3.0
24 * @link http://pear.php.net/package/DB
28 * Obtain the PEAR class so it can be extended from
30 require_once 'PEAR.php';
33 * DB_common is the base class from which each database driver class extends
35 * All common methods are declared here. If a given DBMS driver contains
36 * a particular method, that method will overload the one here.
40 * @author Stig Bakken <ssb@php.net>
41 * @author Tomas V.V. Cox <cox@idecnet.com>
42 * @author Daniel Convissor <danielc@php.net>
43 * @copyright 1997-2007 The PHP Group
44 * @license http://www.php.net/license/3_0.txt PHP License 3.0
45 * @version Release: 1.9.2
46 * @link http://pear.php.net/package/DB
48 class DB_common extends PEAR
53 * The current default fetch mode
56 public $fetchmode = DB_FETCHMODE_ORDERED;
59 * The name of the class into which results should be fetched when
60 * DB_FETCHMODE_OBJECT is in effect
64 public $fetchmode_object_class = 'stdClass';
67 * Was a connection present when the object was serialized()?
69 * @see DB_common::__sleep(), DB_common::__wake()
71 public $was_connected = null;
74 * The most recently executed query
77 public $last_query = '';
80 * Run-time configuration options
82 * The 'optimize' option has been deprecated. Use the 'portability'
86 * @see DB_common::setOption()
88 public $options = array(
89 'result_buffering' => 500,
90 'persistent' => false,
93 'seqname_format' => '%s_seq',
95 'portability' => DB_PORTABILITY_NONE,
96 'optimize' => 'performance', // Deprecated. Use 'portability'.
100 * The parameters from the most recently executed query
102 * @since Property available since Release 1.7.0
104 public $last_parameters = array();
107 * The elements from each prepared statement
110 public $prepare_tokens = array();
113 * The data types of the various elements in each prepared statement
116 public $prepare_types = array();
119 * The prepared queries
122 public $prepared_queries = array();
125 * Flag indicating that the last query was a manipulation query.
129 public $_last_query_manip = false;
132 * Flag indicating that the next query <em>must</em> be a manipulation
137 public $_next_query_manip = false;
144 * This constructor calls <kbd>$this->PEAR('DB_Error')</kbd>
148 public function __construct()
150 $this->PEAR('DB_Error');
157 * Automatically indicates which properties should be saved
158 * when PHP's serialize() function is called
160 * @return array the array of properties names that should be saved
162 public function __sleep()
164 if ($this->connection) {
165 // Don't disconnect(), people use serialize() for many reasons
166 $this->was_connected = true;
168 $this->was_connected = false;
170 if (isset($this->autocommit)) {
171 return array('autocommit',
176 'fetchmode_object_class',
181 return array('dbsyntax',
185 'fetchmode_object_class',
196 * Automatically reconnects to the database when PHP's unserialize()
199 * The reconnection attempt is only performed if the object was connected
200 * at the time PHP's serialize() function was run.
204 public function __wakeup()
206 if ($this->was_connected) {
207 $this->connect($this->dsn, $this->options['persistent']);
215 * DEPRECATED: String conversion method
217 * @return string a string describing the current PEAR DB object
219 * @deprecated Method deprecated in Release 1.7.0
221 public function toString()
223 return $this->__toString();
230 * Automatic string conversion for PHP 5
232 * @return string a string describing the current PEAR DB object
234 * @since Method available since Release 1.7.0
236 public function __toString()
238 $info = strtolower(get_class($this));
239 $info .= ': (phptype=' . $this->phptype .
240 ', dbsyntax=' . $this->dbsyntax .
242 if ($this->connection) {
243 $info .= ' [connected]';
252 * DEPRECATED: Quotes a string so it can be safely used within string
253 * delimiters in a query
255 * @param string $string the string to be quoted
257 * @return string the quoted string
259 * @see DB_common::quoteSmart(), DB_common::escapeSimple()
260 * @deprecated Method deprecated some time before Release 1.2
262 public function quoteString($string)
264 $string = $this->quoteSmart($string);
265 if ($string{0} == "'") {
266 return substr($string, 1, -1);
275 * Formats input so it can be safely used in a query
277 * The output depends on the PHP data type of input and the database
280 * @param mixed $in the data to be formatted
282 * @return mixed the formatted data. The format depends on the input's
286 * <kbd>input</kbd> -> <samp>returns</samp>
289 * <kbd>null</kbd> -> the string <samp>NULL</samp>
292 * <kbd>integer</kbd> or <kbd>double</kbd> -> the unquoted number
295 * <kbd>bool</kbd> -> output depends on the driver in use
296 * Most drivers return integers: <samp>1</samp> if
297 * <kbd>true</kbd> or <samp>0</samp> if
299 * Some return strings: <samp>TRUE</samp> if
300 * <kbd>true</kbd> or <samp>FALSE</samp> if
302 * Finally one returns strings: <samp>T</samp> if
303 * <kbd>true</kbd> or <samp>F</samp> if
304 * <kbd>false</kbd>. Here is a list of each DBMS,
305 * the values returned and the suggested column type:
308 * <kbd>dbase</kbd> -> <samp>T/F</samp>
309 * (<kbd>Logical</kbd>)
312 * <kbd>fbase</kbd> -> <samp>TRUE/FALSE</samp>
313 * (<kbd>BOOLEAN</kbd>)
316 * <kbd>ibase</kbd> -> <samp>1/0</samp>
317 * (<kbd>SMALLINT</kbd>) [1]
320 * <kbd>ifx</kbd> -> <samp>1/0</samp>
321 * (<kbd>SMALLINT</kbd>) [1]
324 * <kbd>msql</kbd> -> <samp>1/0</samp>
325 * (<kbd>INTEGER</kbd>)
328 * <kbd>mssql</kbd> -> <samp>1/0</samp>
332 * <kbd>mysql</kbd> -> <samp>1/0</samp>
333 * (<kbd>TINYINT(1)</kbd>)
336 * <kbd>mysqli</kbd> -> <samp>1/0</samp>
337 * (<kbd>TINYINT(1)</kbd>)
340 * <kbd>oci8</kbd> -> <samp>1/0</samp>
341 * (<kbd>NUMBER(1)</kbd>)
344 * <kbd>odbc</kbd> -> <samp>1/0</samp>
345 * (<kbd>SMALLINT</kbd>) [1]
348 * <kbd>pgsql</kbd> -> <samp>TRUE/FALSE</samp>
349 * (<kbd>BOOLEAN</kbd>)
352 * <kbd>sqlite</kbd> -> <samp>1/0</samp>
353 * (<kbd>INTEGER</kbd>)
356 * <kbd>sybase</kbd> -> <samp>1/0</samp>
357 * (<kbd>TINYINT(1)</kbd>)
360 * [1] Accommodate the lowest common denominator because not all
361 * versions of have <kbd>BOOLEAN</kbd>.
364 * other (including strings and numeric strings) ->
365 * the data with single quotes escaped by preceeding
366 * single quotes, backslashes are escaped by preceeding
367 * backslashes, then the whole string is encapsulated
368 * between single quotes
372 * @see DB_common::escapeSimple()
373 * @since Method available since Release 1.6.0
375 public function quoteSmart($in)
379 } elseif (is_float($in)) {
380 return $this->quoteFloat($in);
381 } elseif (is_bool($in)) {
382 return $this->quoteBoolean($in);
383 } elseif (is_null($in)) {
386 if ($this->dbsyntax == 'access'
387 && preg_match('/^#.+#$/', $in)) {
388 return $this->escapeSimple($in);
390 return "'" . $this->escapeSimple($in) . "'";
395 // {{{ quoteIdentifier()
398 * Formats a float value for use within a query in a locale-independent
401 * @param float the float value to be quoted.
402 * @return string the quoted string.
403 * @see DB_common::quoteSmart()
404 * @since Method available since release 1.7.8.
406 public function quoteFloat($float)
408 return "'" . $this->escapeSimple(str_replace(',', '.', strval(floatval($float)))) . "'";
415 * Escapes a string according to the current DBMS's standards
417 * In SQLite, this makes things safe for inserts/updates, but may
418 * cause problems when performing text comparisons against columns
419 * containing binary data. See the
420 * {@link http://php.net/sqlite_escape_string PHP manual} for more info.
422 * @param string $str the string to be escaped
424 * @return string the escaped string
426 * @see DB_common::quoteSmart()
427 * @since Method available since Release 1.6.0
429 public function escapeSimple($str)
431 return str_replace("'", "''", $str);
435 // {{{ quoteBoolean()
438 * Formats a boolean value for use within a query in a locale-independent
441 * @param boolean the boolean value to be quoted.
442 * @return string the quoted string.
443 * @see DB_common::quoteSmart()
444 * @since Method available since release 1.7.8.
446 public function quoteBoolean($boolean)
448 return $boolean ? '1' : '0';
455 * DEPRECATED: Quotes a string so it can be safely used in a query
457 * @param string $string the string to quote
459 * @return string the quoted string or the string <samp>NULL</samp>
460 * if the value submitted is <kbd>null</kbd>.
462 * @see DB_common::quoteSmart(), DB_common::escapeSimple()
463 * @deprecated Deprecated in release 1.6.0
465 public function quote($string = null)
467 return $this->quoteSmart($string);
471 // {{{ escapeSimple()
474 * Quotes a string so it can be safely used as a table or column name
476 * Delimiting style depends on which database driver is being used.
478 * NOTE: just because you CAN use delimited identifiers doesn't mean
479 * you SHOULD use them. In general, they end up causing way more
480 * problems than they solve.
482 * Portability is broken by using the following characters inside
483 * delimited identifiers:
484 * + backtick (<kbd>`</kbd>) -- due to MySQL
485 * + double quote (<kbd>"</kbd>) -- due to Oracle
486 * + brackets (<kbd>[</kbd> or <kbd>]</kbd>) -- due to Access
488 * Delimited identifiers are known to generally work correctly under
489 * the following drivers:
498 * + sybase (must execute <kbd>set quoted_identifier on</kbd> sometime
501 * InterBase doesn't seem to be able to use delimited identifiers
502 * via PHP 4. They work fine under PHP 5.
504 * @param string $str the identifier name to be quoted
506 * @return string the quoted identifier
508 * @since Method available since Release 1.6.0
510 public function quoteIdentifier($str)
512 return '"' . str_replace('"', '""', $str) . '"';
519 * Tells whether the present driver supports a given feature
521 * @param string $feature the feature you're curious about
523 * @return bool whether this driver supports $feature
525 public function provides($feature)
527 return $this->features[$feature];
531 // {{{ setFetchMode()
534 * Sets the fetch mode that should be used by default for query results
536 * @param integer $fetchmode DB_FETCHMODE_ORDERED, DB_FETCHMODE_ASSOC
537 * or DB_FETCHMODE_OBJECT
538 * @param string $object_class the class name of the object to be returned
539 * by the fetch methods when the
540 * DB_FETCHMODE_OBJECT mode is selected.
541 * If no class is specified by default a cast
542 * to object from the assoc array row will be
543 * done. There is also the posibility to use
544 * and extend the 'DB_row' class.
547 * @see DB_FETCHMODE_ORDERED, DB_FETCHMODE_ASSOC, DB_FETCHMODE_OBJECT
549 public function setFetchMode($fetchmode, $object_class = 'stdClass')
551 switch ($fetchmode) {
552 case DB_FETCHMODE_OBJECT:
553 $this->fetchmode_object_class = $object_class;
555 case DB_FETCHMODE_ORDERED:
556 case DB_FETCHMODE_ASSOC:
557 $this->fetchmode = $fetchmode;
560 return $this->raiseError('invalid fetchmode mode');
569 * Communicates an error and invoke error callbacks, etc
571 * Basically a wrapper for PEAR::raiseError without the message string.
573 * @param mixed integer error code, or a PEAR error object (all
574 * other parameters are ignored if this parameter is
576 * @param int error mode, see PEAR_Error docs
577 * @param mixed if error mode is PEAR_ERROR_TRIGGER, this is the
578 * error level (E_USER_NOTICE etc). If error mode is
579 * PEAR_ERROR_CALLBACK, this is the callback function,
580 * either as a function name, or as an array of an
581 * object and method name. For other error modes this
582 * parameter is ignored.
583 * @param string extra debug information. Defaults to the last
584 * query and native error code.
585 * @param mixed native error code, integer or string depending the
587 * @param mixed dummy parameter for E_STRICT compatibility with
589 * @param mixed dummy parameter for E_STRICT compatibility with
592 * @return object the PEAR_Error object
596 public function &raiseError(
606 // The error is yet a DB error object
607 if (is_object($code)) {
608 // because we the static PEAR::raiseError, our global
609 // handler should be used if it is set
610 if ($mode === null && !empty($this->_default_error_mode)) {
611 $mode = $this->_default_error_mode;
612 $options = $this->_default_error_options;
614 $tmp = PEAR::raiseError(
626 if ($userinfo === null) {
627 $userinfo = $this->last_query;
631 $userinfo .= ' [nativecode=' . trim($nativecode) . ']';
633 $userinfo .= ' [DB Error: ' . DB::errorMessage($code) . ']';
636 $tmp = PEAR::raiseError(
652 * Sets run-time configuration options for PEAR DB
654 * Options, their data types, default values and description:
657 * <var>autofree</var> <kbd>boolean</kbd> = <samp>false</samp>
658 * <br />should results be freed automatically when there are no
661 * <var>result_buffering</var> <kbd>integer</kbd> = <samp>500</samp>
662 * <br />how many rows of the result set should be buffered?
663 * <br />In mysql: mysql_unbuffered_query() is used instead of
664 * mysql_query() if this value is 0. (Release 1.7.0)
665 * <br />In oci8: this value is passed to ocisetprefetch().
668 * <var>debug</var> <kbd>integer</kbd> = <samp>0</samp>
671 * <var>persistent</var> <kbd>boolean</kbd> = <samp>false</samp>
672 * <br />should the connection be persistent?
674 * <var>portability</var> <kbd>integer</kbd> = <samp>DB_PORTABILITY_NONE</samp>
675 * <br />portability mode constant (see below)
677 * <var>seqname_format</var> <kbd>string</kbd> = <samp>%s_seq</samp>
678 * <br />the sprintf() format string used on sequence names. This
679 * format is applied to sequence names passed to
680 * createSequence(), nextID() and dropSequence().
682 * <var>ssl</var> <kbd>boolean</kbd> = <samp>false</samp>
683 * <br />use ssl to connect?
687 * -----------------------------------------
691 * These modes are bitwised, so they can be combined using <kbd>|</kbd>
692 * and removed using <kbd>^</kbd>. See the examples section below on how
695 * <samp>DB_PORTABILITY_NONE</samp>
696 * turn off all portability features
698 * This mode gets automatically turned on if the deprecated
699 * <var>optimize</var> option gets set to <samp>performance</samp>.
702 * <samp>DB_PORTABILITY_LOWERCASE</samp>
703 * convert names of tables and fields to lower case when using
704 * <kbd>get*()</kbd>, <kbd>fetch*()</kbd> and <kbd>tableInfo()</kbd>
706 * This mode gets automatically turned on in the following databases
707 * if the deprecated option <var>optimize</var> gets set to
708 * <samp>portability</samp>:
712 * <samp>DB_PORTABILITY_RTRIM</samp>
713 * right trim the data output by <kbd>get*()</kbd> <kbd>fetch*()</kbd>
716 * <samp>DB_PORTABILITY_DELETE_COUNT</samp>
717 * force reporting the number of rows deleted
719 * Some DBMS's don't count the number of rows deleted when performing
720 * simple <kbd>DELETE FROM tablename</kbd> queries. This portability
721 * mode tricks such DBMS's into telling the count by adding
722 * <samp>WHERE 1=1</samp> to the end of <kbd>DELETE</kbd> queries.
724 * This mode gets automatically turned on in the following databases
725 * if the deprecated option <var>optimize</var> gets set to
726 * <samp>portability</samp>:
733 * <samp>DB_PORTABILITY_NUMROWS</samp>
734 * enable hack that makes <kbd>numRows()</kbd> work in Oracle
736 * This mode gets automatically turned on in the following databases
737 * if the deprecated option <var>optimize</var> gets set to
738 * <samp>portability</samp>:
742 * <samp>DB_PORTABILITY_ERRORS</samp>
743 * makes certain error messages in certain drivers compatible
744 * with those from other DBMS's
746 * + mysql, mysqli: change unique/primary key constraints
747 * DB_ERROR_ALREADY_EXISTS -> DB_ERROR_CONSTRAINT
749 * + odbc(access): MS's ODBC driver reports 'no such field' as code
750 * 07001, which means 'too few parameters.' When this option is on
751 * that code gets mapped to DB_ERROR_NOSUCHFIELD.
752 * DB_ERROR_MISMATCH -> DB_ERROR_NOSUCHFIELD
754 * <samp>DB_PORTABILITY_NULL_TO_EMPTY</samp>
755 * convert null values to empty strings in data output by get*() and
756 * fetch*(). Needed because Oracle considers empty strings to be null,
757 * while most other DBMS's know the difference between empty and null.
760 * <samp>DB_PORTABILITY_ALL</samp>
761 * turn on all portability features
763 * -----------------------------------------
765 * Example 1. Simple setOption() example
767 * $db->setOption('autofree', true);
770 * Example 2. Portability for lowercasing and trimming
772 * $db->setOption('portability',
773 * DB_PORTABILITY_LOWERCASE | DB_PORTABILITY_RTRIM);
776 * Example 3. All portability options except trimming
778 * $db->setOption('portability',
779 * DB_PORTABILITY_ALL ^ DB_PORTABILITY_RTRIM);
782 * @param string $option option name
783 * @param mixed $value value for the option
787 * @see DB_common::$options
789 public function setOption($option, $value)
791 if (isset($this->options[$option])) {
792 $this->options[$option] = $value;
795 * Backwards compatibility check for the deprecated 'optimize'
796 * option. Done here in case settings change after connecting.
798 if ($option == 'optimize') {
799 if ($value == 'portability') {
800 switch ($this->phptype) {
802 $this->options['portability'] =
803 DB_PORTABILITY_LOWERCASE |
804 DB_PORTABILITY_NUMROWS;
810 $this->options['portability'] =
811 DB_PORTABILITY_DELETE_COUNT;
815 $this->options['portability'] = DB_PORTABILITY_NONE;
821 return $this->raiseError("unknown option $option");
828 * Automaticaly generates an insert or update query and call prepare()
829 * and execute() with it
831 * @param string $table the table name
832 * @param array $fields_values the associative array where $key is a
833 * field name and $value its value
834 * @param int $mode a type of query to make:
835 * DB_AUTOQUERY_INSERT or DB_AUTOQUERY_UPDATE
836 * @param bool $where for update queries: the WHERE clause to
837 * append to the SQL statement. Don't
838 * include the "WHERE" keyword.
840 * @return mixed a new DB_result object for successful SELECT queries
841 * or DB_OK for successul data manipulation queries.
842 * A DB_Error object on failure.
844 * @uses DB_common::autoPrepare(), DB_common::execute()
846 public function autoExecute(
849 $mode = DB_AUTOQUERY_INSERT,
853 $sth = $this->autoPrepare(
855 array_keys($fields_values),
859 if (DB::isError($sth)) {
862 $ret = $this->execute($sth, array_values($fields_values));
863 $this->freePrepared($sth);
871 * Automaticaly generates an insert or update query and pass it to prepare()
873 * @param string $table the table name
874 * @param array $table_fields the array of field names
875 * @param int $mode a type of query to make:
876 * DB_AUTOQUERY_INSERT or DB_AUTOQUERY_UPDATE
877 * @param bool $where for update queries: the WHERE clause to
878 * append to the SQL statement. Don't
879 * include the "WHERE" keyword.
881 * @return resource|string
883 * @uses DB_common::prepare(), DB_common::buildManipSQL()
885 public function autoPrepare(
888 $mode = DB_AUTOQUERY_INSERT,
892 $query = $this->buildManipSQL($table, $table_fields, $mode, $where);
893 if (DB::isError($query)) {
896 return $this->prepare($query);
903 * Produces an SQL query string for autoPrepare()
907 * buildManipSQL('table_sql', array('field1', 'field2', 'field3'),
908 * DB_AUTOQUERY_INSERT);
913 * INSERT INTO table_sql (field1,field2,field3) VALUES (?,?,?)
917 * - This belongs more to a SQL Builder class, but this is a simple
919 * - Be carefull! If you don't give a $where param with an UPDATE
920 * query, all the records of the table will be updated!
922 * @param string $table the table name
923 * @param array $table_fields the array of field names
924 * @param int $mode a type of query to make:
925 * DB_AUTOQUERY_INSERT or DB_AUTOQUERY_UPDATE
926 * @param bool $where for update queries: the WHERE clause to
927 * append to the SQL statement. Don't
928 * include the "WHERE" keyword.
930 * @return string the sql query for autoPrepare()
932 public function buildManipSQL($table, $table_fields, $mode, $where = false)
934 if (count($table_fields) == 0) {
935 return $this->raiseError(DB_ERROR_NEED_MORE_DATA);
939 case DB_AUTOQUERY_INSERT:
942 foreach ($table_fields as $value) {
952 return "INSERT INTO $table ($names) VALUES ($values)";
953 case DB_AUTOQUERY_UPDATE:
955 foreach ($table_fields as $value) {
961 $set .= "$value = ?";
963 $sql = "UPDATE $table SET $set";
965 $sql .= " WHERE $where";
969 return $this->raiseError(DB_ERROR_SYNTAX);
974 // {{{ buildManipSQL()
977 * Prepares a query for multiple execution with execute()
979 * Creates a query that can be run multiple times. Each time it is run,
980 * the placeholders, if any, will be replaced by the contents of
981 * execute()'s $data argument.
983 * Three types of placeholders can be used:
984 * + <kbd>?</kbd> scalar value (i.e. strings, integers). The system
985 * will automatically quote and escape the data.
986 * + <kbd>!</kbd> value is inserted 'as is'
987 * + <kbd>&</kbd> requires a file name. The file's contents get
988 * inserted into the query (i.e. saving binary
993 * $sth = $db->prepare('INSERT INTO tbl (a, b, c) VALUES (?, !, &)');
999 * $res = $db->execute($sth, $data);
1002 * Use backslashes to escape placeholder characters if you don't want
1003 * them to be interpreted as placeholders:
1005 * "UPDATE foo SET col=? WHERE col='over \& under'"
1008 * With some database backends, this is emulated.
1010 * {@internal ibase and oci8 have their own prepare() methods.}}
1012 * @param string $query the query to be prepared
1014 * @return mixed DB statement resource on success. A DB_Error object
1017 * @see DB_common::execute()
1019 public function prepare($query)
1021 $tokens = preg_split(
1022 '/((?<!\\\)[&?!])/',
1025 PREG_SPLIT_DELIM_CAPTURE
1029 $newtokens = array();
1031 foreach ($tokens as $val) {
1034 $types[$token++] = DB_PARAM_SCALAR;
1037 $types[$token++] = DB_PARAM_OPAQUE;
1040 $types[$token++] = DB_PARAM_MISC;
1043 $newtokens[] = preg_replace('/\\\([&?!])/', "\\1", $val);
1047 $this->prepare_tokens[] = &$newtokens;
1048 end($this->prepare_tokens);
1050 $k = key($this->prepare_tokens);
1051 $this->prepare_types[$k] = $types;
1052 $this->prepared_queries[$k] = implode(' ', $newtokens);
1061 * Executes a DB statement prepared with prepare()
1065 * $sth = $db->prepare('INSERT INTO tbl (a, b, c) VALUES (?, !, &)');
1071 * $res = $db->execute($sth, $data);
1074 * @param resource $stmt a DB statement resource returned from prepare()
1075 * @param mixed $data array, string or numeric data to be used in
1076 * execution of the statement. Quantity of items
1077 * passed must match quantity of placeholders in
1078 * query: meaning 1 placeholder for non-array
1079 * parameters or 1 placeholder per array element.
1081 * @return mixed a new DB_result object for successful SELECT queries
1082 * or DB_OK for successul data manipulation queries.
1083 * A DB_Error object on failure.
1085 * {@internal ibase and oci8 have their own execute() methods.}}
1087 * @see DB_common::prepare()
1089 public function &execute($stmt, $data = array())
1091 $realquery = $this->executeEmulateQuery($stmt, $data);
1092 if (DB::isError($realquery)) {
1095 $result = $this->simpleQuery($realquery);
1097 if ($result === DB_OK || DB::isError($result)) {
1100 $tmp = new DB_result($this, $result);
1106 // {{{ executeEmulateQuery()
1109 * Emulates executing prepared statements if the DBMS not support them
1111 * @param resource $stmt a DB statement resource returned from execute()
1112 * @param mixed $data array, string or numeric data to be used in
1113 * execution of the statement. Quantity of items
1114 * passed must match quantity of placeholders in
1115 * query: meaning 1 placeholder for non-array
1116 * parameters or 1 placeholder per array element.
1118 * @return mixed a string containing the real query run when emulating
1119 * prepare/execute. A DB_Error object on failure.
1122 * @see DB_common::execute()
1124 public function executeEmulateQuery($stmt, $data = array())
1127 $data = (array)$data;
1128 $this->last_parameters = $data;
1130 if (count($this->prepare_types[$stmt]) != count($data)) {
1131 $this->last_query = $this->prepared_queries[$stmt];
1132 return $this->raiseError(DB_ERROR_MISMATCH);
1135 $realquery = $this->prepare_tokens[$stmt][0];
1138 foreach ($data as $value) {
1139 if ($this->prepare_types[$stmt][$i] == DB_PARAM_SCALAR) {
1140 $realquery .= $this->quoteSmart($value);
1141 } elseif ($this->prepare_types[$stmt][$i] == DB_PARAM_OPAQUE) {
1142 $fp = @fopen($value, 'rb');
1144 return $this->raiseError(DB_ERROR_ACCESS_VIOLATION);
1146 $realquery .= $this->quoteSmart(fread($fp, filesize($value)));
1149 $realquery .= $value;
1152 $realquery .= $this->prepare_tokens[$stmt][++$i];
1159 // {{{ executeMultiple()
1162 * Frees the internal resources associated with a prepared query
1164 * @param resource $stmt the prepared statement's PHP resource
1165 * @param bool $free_resource should the PHP resource be freed too?
1166 * Use false if you need to get data
1167 * from the result set later.
1169 * @return bool TRUE on success, FALSE if $result is invalid
1171 * @see DB_common::prepare()
1173 public function freePrepared($stmt, $free_resource = true)
1176 if (isset($this->prepare_tokens[$stmt])) {
1177 unset($this->prepare_tokens[$stmt]);
1178 unset($this->prepare_types[$stmt]);
1179 unset($this->prepared_queries[$stmt]);
1186 // {{{ freePrepared()
1189 * Performs several execute() calls on the same statement handle
1191 * $data must be an array indexed numerically
1192 * from 0, one execute call is done for every "row" in the array.
1194 * If an error occurs during execute(), executeMultiple() does not
1195 * execute the unfinished rows, but rather returns that error.
1197 * @param resource $stmt query handle from prepare()
1198 * @param array $data numeric array containing the
1199 * data to insert into the query
1201 * @return int DB_OK on success. A DB_Error object on failure.
1203 * @see DB_common::prepare(), DB_common::execute()
1205 public function executeMultiple($stmt, $data)
1207 foreach ($data as $value) {
1208 $res = $this->execute($stmt, $value);
1209 if (DB::isError($res)) {
1217 // {{{ modifyQuery()
1220 * Changes a query string for various DBMS specific reasons
1222 * It is defined here to ensure all drivers have this method available.
1224 * @param string $query the query string to modify
1226 * @return string the modified query string
1229 * @see DB_mysql::modifyQuery(), DB_oci8::modifyQuery(),
1230 * DB_sqlite::modifyQuery()
1232 public function modifyQuery($query)
1238 // {{{ modifyLimitQuery()
1241 * Generates and executes a LIMIT query
1243 * @param string $query the query
1244 * @param intr $from the row to start to fetching (0 = the first row)
1245 * @param int $count the numbers of rows to fetch
1246 * @param mixed $params array, string or numeric data to be used in
1247 * execution of the statement. Quantity of items
1248 * passed must match quantity of placeholders in
1249 * query: meaning 1 placeholder for non-array
1250 * parameters or 1 placeholder per array element.
1252 * @return mixed a new DB_result object for successful SELECT queries
1253 * or DB_OK for successul data manipulation queries.
1254 * A DB_Error object on failure.
1256 public function &limitQuery($query, $from, $count, $params = array())
1258 $query = $this->modifyLimitQuery($query, $from, $count, $params);
1259 if (DB::isError($query)) {
1262 $result = $this->query($query, $params);
1263 if (is_object($result) && is_a($result, 'DB_result')) {
1264 $result->setOption('limit_from', $from);
1265 $result->setOption('limit_count', $count);
1274 * Adds LIMIT clauses to a query string according to current DBMS standards
1276 * It is defined here to assure that all implementations
1277 * have this method defined.
1279 * @param string $query the query to modify
1280 * @param int $from the row to start to fetching (0 = the first row)
1281 * @param int $count the numbers of rows to fetch
1282 * @param mixed $params array, string or numeric data to be used in
1283 * execution of the statement. Quantity of items
1284 * passed must match quantity of placeholders in
1285 * query: meaning 1 placeholder for non-array
1286 * parameters or 1 placeholder per array element.
1288 * @return string the query string with LIMIT clauses added
1292 public function modifyLimitQuery($query, $from, $count, $params = array())
1301 * Sends a query to the database server
1303 * The query string can be either a normal statement to be sent directly
1304 * to the server OR if <var>$params</var> are passed the query can have
1305 * placeholders and it will be passed through prepare() and execute().
1307 * @param string $query the SQL query or the statement to prepare
1308 * @param mixed $params array, string or numeric data to be used in
1309 * execution of the statement. Quantity of items
1310 * passed must match quantity of placeholders in
1311 * query: meaning 1 placeholder for non-array
1312 * parameters or 1 placeholder per array element.
1314 * @return mixed a new DB_result object for successful SELECT queries
1315 * or DB_OK for successul data manipulation queries.
1316 * A DB_Error object on failure.
1318 * @see DB_result, DB_common::prepare(), DB_common::execute()
1320 public function &query($query, $params = array())
1322 if (sizeof($params) > 0) {
1323 $sth = $this->prepare($query);
1324 if (DB::isError($sth)) {
1327 $ret = $this->execute($sth, $params);
1328 $this->freePrepared($sth, false);
1331 $this->last_parameters = array();
1332 $result = $this->simpleQuery($query);
1333 if ($result === DB_OK || DB::isError($result)) {
1336 $tmp = new DB_result($this, $result);
1346 * Fetches the first column of the first row from a query result
1348 * Takes care of doing the query and freeing the results when finished.
1350 * @param string $query the SQL query
1351 * @param mixed $params array, string or numeric data to be used in
1352 * execution of the statement. Quantity of items
1353 * passed must match quantity of placeholders in
1354 * query: meaning 1 placeholder for non-array
1355 * parameters or 1 placeholder per array element.
1357 * @return mixed the returned value of the query.
1358 * A DB_Error object on failure.
1360 public function &getOne($query, $params = array())
1362 $params = (array)$params;
1363 // modifyLimitQuery() would be nice here, but it causes BC issues
1364 if (sizeof($params) > 0) {
1365 $sth = $this->prepare($query);
1366 if (DB::isError($sth)) {
1369 $res = $this->execute($sth, $params);
1370 $this->freePrepared($sth);
1372 $res = $this->query($query);
1375 if (DB::isError($res)) {
1379 $err = $res->fetchInto($row, DB_FETCHMODE_ORDERED);
1382 if ($err !== DB_OK) {
1393 * Fetches the first row of data returned from a query result
1395 * Takes care of doing the query and freeing the results when finished.
1397 * @param string $query the SQL query
1398 * @param mixed $params array, string or numeric data to be used in
1399 * execution of the statement. Quantity of items
1400 * passed must match quantity of placeholders in
1401 * query: meaning 1 placeholder for non-array
1402 * parameters or 1 placeholder per array element.
1403 * @param int $fetchmode the fetch mode to use
1405 * @return array the first row of results as an array.
1406 * A DB_Error object on failure.
1408 public function &getRow(
1411 $fetchmode = DB_FETCHMODE_DEFAULT
1414 // compat check, the params and fetchmode parameters used to
1415 // have the opposite order
1416 if (!is_array($params)) {
1417 if (is_array($fetchmode)) {
1418 if ($params === null) {
1419 $tmp = DB_FETCHMODE_DEFAULT;
1423 $params = $fetchmode;
1425 } elseif ($params !== null) {
1426 $fetchmode = $params;
1430 // modifyLimitQuery() would be nice here, but it causes BC issues
1431 if (sizeof($params) > 0) {
1432 $sth = $this->prepare($query);
1433 if (DB::isError($sth)) {
1436 $res = $this->execute($sth, $params);
1437 $this->freePrepared($sth);
1439 $res = $this->query($query);
1442 if (DB::isError($res)) {
1446 $err = $res->fetchInto($row, $fetchmode);
1450 if ($err !== DB_OK) {
1461 * Fetches an entire query result and returns it as an
1462 * associative array using the first column as the key
1464 * If the result set contains more than two columns, the value
1465 * will be an array of the values from column 2-n. If the result
1466 * set contains only two columns, the returned value will be a
1467 * scalar with the value of the second column (unless forced to an
1468 * array with the $force_array parameter). A DB error code is
1469 * returned on errors. If the result set contains fewer than two
1470 * columns, a DB_ERROR_TRUNCATED error is returned.
1472 * For example, if the table "mytable" contains:
1476 * --------------------------------
1479 * 3 'three' 944679408
1482 * Then the call getAssoc('SELECT id,text FROM mytable') returns:
1491 * ...while the call getAssoc('SELECT id,text,date FROM mytable') returns:
1494 * '1' => array('one', '944679408'),
1495 * '2' => array('two', '944679408'),
1496 * '3' => array('three', '944679408')
1500 * If the more than one row occurs with the same value in the
1501 * first column, the last row overwrites all previous ones by
1502 * default. Use the $group parameter if you don't want to
1503 * overwrite like this. Example:
1506 * getAssoc('SELECT category,id,name FROM mytable', false, null,
1507 * DB_FETCHMODE_ASSOC, true) returns:
1510 * '1' => array(array('id' => '4', 'name' => 'number four'),
1511 * array('id' => '6', 'name' => 'number six')
1513 * '9' => array(array('id' => '4', 'name' => 'number four'),
1514 * array('id' => '6', 'name' => 'number six')
1519 * Keep in mind that database functions in PHP usually return string
1520 * values for results regardless of the database's internal type.
1522 * @param string $query the SQL query
1523 * @param bool $force_array used only when the query returns
1524 * exactly two columns. If true, the values
1525 * of the returned array will be one-element
1526 * arrays instead of scalars.
1527 * @param mixed $params array, string or numeric data to be used in
1528 * execution of the statement. Quantity of
1529 * items passed must match quantity of
1530 * placeholders in query: meaning 1
1531 * placeholder for non-array parameters or
1532 * 1 placeholder per array element.
1533 * @param int $fetchmode the fetch mode to use
1534 * @param bool $group if true, the values of the returned array
1535 * is wrapped in another array. If the same
1536 * key value (in the first column) repeats
1537 * itself, the values will be appended to
1538 * this array instead of overwriting the
1541 * @return array|object
1542 * A DB_Error object on failure.
1544 public function &getAssoc(
1546 $force_array = false,
1548 $fetchmode = DB_FETCHMODE_DEFAULT,
1552 $params = (array)$params;
1553 if (sizeof($params) > 0) {
1554 $sth = $this->prepare($query);
1556 if (DB::isError($sth)) {
1560 $res = $this->execute($sth, $params);
1561 $this->freePrepared($sth);
1563 $res = $this->query($query);
1566 if (DB::isError($res)) {
1569 if ($fetchmode == DB_FETCHMODE_DEFAULT) {
1570 $fetchmode = $this->fetchmode;
1572 $cols = $res->numCols();
1575 $tmp = $this->raiseError(DB_ERROR_TRUNCATED);
1581 if ($cols > 2 || $force_array) {
1582 // return array values
1583 // XXX this part can be optimized
1584 if ($fetchmode == DB_FETCHMODE_ASSOC) {
1585 while (is_array($row = $res->fetchRow(DB_FETCHMODE_ASSOC))) {
1587 $key = current($row);
1588 unset($row[key($row)]);
1590 $results[$key][] = $row;
1592 $results[$key] = $row;
1595 } elseif ($fetchmode == DB_FETCHMODE_OBJECT) {
1596 while ($row = $res->fetchRow(DB_FETCHMODE_OBJECT)) {
1597 $arr = get_object_vars($row);
1598 $key = current($arr);
1600 $results[$key][] = $row;
1602 $results[$key] = $row;
1606 while (is_array($row = $res->fetchRow(DB_FETCHMODE_ORDERED))) {
1607 // we shift away the first element to get
1608 // indices running from 0 again
1609 $key = array_shift($row);
1611 $results[$key][] = $row;
1613 $results[$key] = $row;
1617 if (DB::isError($row)) {
1621 // return scalar values
1622 while (is_array($row = $res->fetchRow(DB_FETCHMODE_ORDERED))) {
1624 $results[$row[0]][] = $row[1];
1626 $results[$row[0]] = $row[1];
1629 if (DB::isError($row)) {
1643 * Fetches all of the rows from a query result
1645 * @param string $query the SQL query
1646 * @param mixed $params array, string or numeric data to be used in
1647 * execution of the statement. Quantity of
1648 * items passed must match quantity of
1649 * placeholders in query: meaning 1
1650 * placeholder for non-array parameters or
1651 * 1 placeholder per array element.
1652 * @param int $fetchmode the fetch mode to use:
1653 * + DB_FETCHMODE_ORDERED
1654 * + DB_FETCHMODE_ASSOC
1655 * + DB_FETCHMODE_ORDERED | DB_FETCHMODE_FLIPPED
1656 * + DB_FETCHMODE_ASSOC | DB_FETCHMODE_FLIPPED
1658 * @return array|object
1660 public function &getAll(
1663 $fetchmode = DB_FETCHMODE_DEFAULT
1666 // compat check, the params and fetchmode parameters used to
1667 // have the opposite order
1668 if (!is_array($params)) {
1669 if (is_array($fetchmode)) {
1670 if ($params === null) {
1671 $tmp = DB_FETCHMODE_DEFAULT;
1675 $params = $fetchmode;
1677 } elseif ($params !== null) {
1678 $fetchmode = $params;
1683 if (sizeof($params) > 0) {
1684 $sth = $this->prepare($query);
1686 if (DB::isError($sth)) {
1690 $res = $this->execute($sth, $params);
1691 $this->freePrepared($sth);
1693 $res = $this->query($query);
1696 if ($res === DB_OK || DB::isError($res)) {
1701 while (DB_OK === $res->fetchInto($row, $fetchmode)) {
1702 if ($fetchmode & DB_FETCHMODE_FLIPPED) {
1703 foreach ($row as $key => $val) {
1704 $results[$key][] = $val;
1713 if (DB::isError($row)) {
1714 $tmp = $this->raiseError($row);
1724 * Enables or disables automatic commits
1726 * @param bool $onoff true turns it on, false turns it off
1728 * @return int|object
1729 * doesn't support auto-committing transactions.
1731 public function autoCommit($onoff = false)
1733 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
1740 * Commits the current transaction
1742 * @return int|object
1744 public function commit()
1746 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
1753 * Reverts the current transaction
1755 * @return int|object
1757 public function rollback()
1759 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
1766 * Determines the number of rows in a query result
1768 * @param resource $result the query result idenifier produced by PHP
1770 * @return int|object
1772 public function numRows($result)
1774 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
1781 * Determines the number of rows affected by a data maniuplation query
1783 * 0 is returned for queries that don't manipulate data.
1785 * @return int|object
1787 public function affectedRows()
1789 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
1793 // {{{ affectedRows()
1796 * Generates the name used inside the database for a sequence
1798 * The createSequence() docblock contains notes about storing sequence
1801 * @param string $sqn the sequence's public name
1803 * @return string the sequence's name in the backend
1806 * @see DB_common::createSequence(), DB_common::dropSequence(),
1807 * DB_common::nextID(), DB_common::setOption()
1809 public function getSequenceName($sqn)
1812 $this->getOption('seqname_format'),
1813 preg_replace('/[^a-z0-9_.]/i', '_', $sqn)
1818 // {{{ getSequenceName()
1821 * Returns the value of an option
1823 * @param string $option the option name you're curious about
1825 * @return mixed the option's value
1827 public function getOption($option)
1829 if (isset($this->options[$option])) {
1830 return $this->options[$option];
1832 return $this->raiseError("unknown option $option");
1839 * Returns the next free id in a sequence
1841 * @param string $seq_name name of the sequence
1842 * @param boolean $ondemand when true, the seqence is automatically
1843 * created if it does not exist
1845 * @return int|object
1846 * A DB_Error object on failure.
1848 * @see DB_common::createSequence(), DB_common::dropSequence(),
1849 * DB_common::getSequenceName()
1851 public function nextId($seq_name, $ondemand = true)
1853 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
1857 // {{{ createSequence()
1860 * Creates a new sequence
1862 * The name of a given sequence is determined by passing the string
1863 * provided in the <var>$seq_name</var> argument through PHP's sprintf()
1864 * function using the value from the <var>seqname_format</var> option as
1865 * the sprintf()'s format argument.
1867 * <var>seqname_format</var> is set via setOption().
1869 * @param string $seq_name name of the new sequence
1871 * @return int|object
1873 * @see DB_common::dropSequence(), DB_common::getSequenceName(),
1874 * DB_common::nextID()
1876 public function createSequence($seq_name)
1878 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
1882 // {{{ dropSequence()
1885 * Deletes a sequence
1887 * @param string $seq_name name of the sequence to be deleted
1889 * @return int|object
1891 * @see DB_common::createSequence(), DB_common::getSequenceName(),
1892 * DB_common::nextID()
1894 public function dropSequence($seq_name)
1896 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
1903 * Gets the DBMS' native error code produced by the last query
1905 * @return mixed the DBMS' error code. A DB_Error object on failure.
1907 public function errorNative()
1909 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
1913 // {{{ errorNative()
1916 * Maps native error codes to DB's portable ones
1918 * Uses the <var>$errorcode_map</var> property defined in each driver.
1920 * @param string|int $nativecode the error code returned by the DBMS
1922 * @return int the portable DB error code. Return DB_ERROR if the
1923 * current driver doesn't have a mapping for the
1924 * $nativecode submitted.
1926 public function errorCode($nativecode)
1928 if (isset($this->errorcode_map[$nativecode])) {
1929 return $this->errorcode_map[$nativecode];
1931 // Fall back to DB_ERROR if there was no mapping.
1939 * Maps a DB error code to a textual message
1941 * @param integer $dbcode the DB error code
1943 * @return string the error message corresponding to the error code
1944 * submitted. FALSE if the error code is unknown.
1946 * @see DB::errorMessage()
1948 public function errorMessage($dbcode)
1950 return DB::errorMessage($this->errorcode_map[$dbcode]);
1954 // {{{ errorMessage()
1957 * Returns information about a table or a result set
1959 * The format of the resulting array depends on which <var>$mode</var>
1960 * you select. The sample output below is based on this query:
1962 * SELECT tblFoo.fldID, tblFoo.fldPhone, tblBar.fldId
1964 * JOIN tblBar ON tblFoo.fldId = tblBar.fldId
1970 * <kbd>null</kbd> (default)
1977 * [flags] => primary_key not_null
1981 * [name] => fldPhone
1991 * [flags] => primary_key not_null
1997 * <kbd>DB_TABLEINFO_ORDER</kbd>
1999 * <p>In addition to the information found in the default output,
2000 * a notation of the number of columns is provided by the
2001 * <samp>num_fields</samp> element while the <samp>order</samp>
2002 * element provides an array with the column names as the keys and
2003 * their location index number (corresponding to the keys in the
2004 * the default output) as the values.</p>
2006 * <p>If a result set has identical field names, the last one is
2011 * [order] => Array (
2019 * <kbd>DB_TABLEINFO_ORDERTABLE</kbd>
2021 * <p>Similar to <kbd>DB_TABLEINFO_ORDER</kbd> but adds more
2022 * dimensions to the array in which the table names are keys and
2023 * the field names are sub-keys. This is helpful for queries that
2024 * join tables which have identical field names.</p>
2028 * [ordertable] => Array (
2029 * [tblFoo] => Array (
2033 * [tblBar] => Array (
2042 * The <samp>flags</samp> element contains a space separated list
2043 * of extra information about the field. This data is inconsistent
2044 * between DBMS's due to the way each DBMS works.
2045 * + <samp>primary_key</samp>
2046 * + <samp>unique_key</samp>
2047 * + <samp>multiple_key</samp>
2048 * + <samp>not_null</samp>
2050 * Most DBMS's only provide the <samp>table</samp> and <samp>flags</samp>
2051 * elements if <var>$result</var> is a table name. The following DBMS's
2052 * provide full information from queries:
2056 * If the 'portability' option has <samp>DB_PORTABILITY_LOWERCASE</samp>
2057 * turned on, the names of tables and fields will be lowercased.
2059 * @param object|string $result DB_result object from a query or a
2060 * string containing the name of a table.
2061 * While this also accepts a query result
2062 * resource identifier, this behavior is
2064 * @param int $mode either unused or one of the tableInfo modes:
2065 * <kbd>DB_TABLEINFO_ORDERTABLE</kbd>,
2066 * <kbd>DB_TABLEINFO_ORDER</kbd> or
2067 * <kbd>DB_TABLEINFO_FULL</kbd> (which does both).
2068 * These are bitwise, so the first two can be
2069 * combined using <kbd>|</kbd>.
2071 * @return array|object
2072 * A DB_Error object on failure.
2074 * @see DB_common::setOption()
2076 public function tableInfo($result, $mode = null)
2079 * If the DB_<driver> class has a tableInfo() method, that one
2080 * overrides this one. But, if the driver doesn't have one,
2081 * this method runs and tells users about that fact.
2083 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
2090 * Lists the tables in the current database
2092 * @return array the list of tables. A DB_Error object on failure.
2094 * @deprecated Method deprecated some time before Release 1.2
2096 public function getTables()
2098 return $this->getListOf('tables');
2105 * Lists internal database information
2107 * @param string $type type of information being sought.
2108 * Common items being sought are:
2109 * tables, databases, users, views, functions
2110 * Each DBMS's has its own capabilities.
2112 * @return array|object
2113 * A DB DB_Error object on failure.
2115 public function getListOf($type)
2117 $sql = $this->getSpecialQuery($type);
2118 if ($sql === null) {
2119 $this->last_query = '';
2120 return $this->raiseError(DB_ERROR_UNSUPPORTED);
2121 } elseif (is_int($sql) || DB::isError($sql)) {
2123 return $this->raiseError($sql);
2124 } elseif (is_array($sql)) {
2125 // Already the result
2128 // Launch this query
2129 return $this->getCol($sql);
2136 * Obtains the query string needed for listing a given type of objects
2138 * @param string $type the kind of objects you want to retrieve
2140 * @return string the SQL query string or null if the driver doesn't
2141 * support the object type requested
2144 * @see DB_common::getListOf()
2146 public function getSpecialQuery($type)
2148 return $this->raiseError(DB_ERROR_UNSUPPORTED);
2152 // {{{ getSpecialQuery()
2155 * Fetches a single column from a query result and returns it as an
2158 * @param string $query the SQL query
2159 * @param mixed $col which column to return (integer [column number,
2160 * starting at 0] or string [column name])
2161 * @param mixed $params array, string or numeric data to be used in
2162 * execution of the statement. Quantity of items
2163 * passed must match quantity of placeholders in
2164 * query: meaning 1 placeholder for non-array
2165 * parameters or 1 placeholder per array element.
2167 * @return array the results as an array. A DB_Error object on failure.
2169 * @see DB_common::query()
2171 public function &getCol($query, $col = 0, $params = array())
2173 $params = (array)$params;
2174 if (sizeof($params) > 0) {
2175 $sth = $this->prepare($query);
2177 if (DB::isError($sth)) {
2181 $res = $this->execute($sth, $params);
2182 $this->freePrepared($sth);
2184 $res = $this->query($query);
2187 if (DB::isError($res)) {
2191 $fetchmode = is_int($col) ? DB_FETCHMODE_ORDERED : DB_FETCHMODE_ASSOC;
2193 if (!is_array($row = $res->fetchRow($fetchmode))) {
2196 if (!array_key_exists($col, $row)) {
2197 $ret = $this->raiseError(DB_ERROR_NOSUCHFIELD);
2199 $ret = array($row[$col]);
2200 while (is_array($row = $res->fetchRow($fetchmode))) {
2201 $ret[] = $row[$col];
2208 if (DB::isError($row)) {
2216 // {{{ nextQueryIsManip()
2219 * Sets (or unsets) a flag indicating that the next query will be a
2220 * manipulation query, regardless of the usual DB::isManip() heuristics.
2222 * @param boolean true to set the flag overriding the isManip() behaviour,
2223 * false to clear it and fall back onto isManip()
2229 public function nextQueryIsManip($manip)
2231 $this->_next_query_manip = $manip;
2235 // {{{ _checkManip()
2238 * Checks if the given query is a manipulation query. This also takes into
2239 * account the _next_query_manip flag and sets the _last_query_manip flag
2240 * (and resets _next_query_manip) according to the result.
2242 * @param string The query to check.
2244 * @return boolean true if the query is a manipulation query, false
2249 public function _checkManip($query)
2251 if ($this->_next_query_manip || DB::isManip($query)) {
2252 $this->_last_query_manip = true;
2254 $this->_last_query_manip = false;
2256 $this->_next_query_manip = false;
2257 return $this->_last_query_manip;
2261 // {{{ _rtrimArrayValues()
2264 * Right-trims all strings in an array
2266 * @param array $array the array to be trimmed (passed by reference)
2272 public function _rtrimArrayValues(&$array)
2274 foreach ($array as $key => $value) {
2275 if (is_string($value)) {
2276 $array[$key] = rtrim($value);
2282 // {{{ _convertNullArrayValuesToEmpty()
2285 * Converts all null values in an array to empty strings
2287 * @param array $array the array to be de-nullified (passed by reference)
2293 public function _convertNullArrayValuesToEmpty(&$array)
2295 foreach ($array as $key => $value) {
2296 if (is_null($value)) {