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.8.2
46 * @link http://pear.php.net/package/DB
48 class DB_common extends PEAR
53 * The current default fetch mode
56 var $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 var $fetchmode_object_class = 'stdClass';
67 * Was a connection present when the object was serialized()?
69 * @see DB_common::__sleep(), DB_common::__wake()
71 var $was_connected = null;
74 * The most recently executed query
80 * Run-time configuration options
82 * The 'optimize' option has been deprecated. Use the 'portability'
86 * @see DB_common::setOption()
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 var $last_parameters = array();
107 * The elements from each prepared statement
110 var $prepare_tokens = array();
113 * The data types of the various elements in each prepared statement
116 var $prepare_types = array();
119 * The prepared queries
122 var $prepared_queries = array();
125 * Flag indicating that the last query was a manipulation query.
129 var $_last_query_manip = false;
132 * Flag indicating that the next query <em>must</em> be a manipulation
137 var $_next_query_manip = false;
144 * This constructor calls <kbd>$this->PEAR('DB_Error')</kbd>
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
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.
206 if ($this->was_connected) {
207 $this->connect($this->dsn, $this->options['persistent']);
215 * Automatic string conversion for PHP 5
217 * @return string a string describing the current PEAR DB object
219 * @since Method available since Release 1.7.0
221 function __toString()
223 $info = strtolower(get_class($this));
224 $info .= ': (phptype=' . $this->phptype .
225 ', dbsyntax=' . $this->dbsyntax .
227 if ($this->connection) {
228 $info .= ' [connected]';
237 * DEPRECATED: String conversion method
239 * @return string a string describing the current PEAR DB object
241 * @deprecated Method deprecated in Release 1.7.0
245 return $this->__toString();
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 function quoteString($string)
264 $string = $this->quoteSmart($string);
265 if ($string{0} == "'") {
266 return substr($string, 1, -1);
275 * DEPRECATED: Quotes a string so it can be safely used in a query
277 * @param string $string the string to quote
279 * @return string the quoted string or the string <samp>NULL</samp>
280 * if the value submitted is <kbd>null</kbd>.
282 * @see DB_common::quoteSmart(), DB_common::escapeSimple()
283 * @deprecated Deprecated in release 1.6.0
285 function quote($string = null)
287 return $this->quoteSmart($string);
291 // {{{ quoteIdentifier()
294 * Quotes a string so it can be safely used as a table or column name
296 * Delimiting style depends on which database driver is being used.
298 * NOTE: just because you CAN use delimited identifiers doesn't mean
299 * you SHOULD use them. In general, they end up causing way more
300 * problems than they solve.
302 * Portability is broken by using the following characters inside
303 * delimited identifiers:
304 * + backtick (<kbd>`</kbd>) -- due to MySQL
305 * + double quote (<kbd>"</kbd>) -- due to Oracle
306 * + brackets (<kbd>[</kbd> or <kbd>]</kbd>) -- due to Access
308 * Delimited identifiers are known to generally work correctly under
309 * the following drivers:
318 * + sybase (must execute <kbd>set quoted_identifier on</kbd> sometime
321 * InterBase doesn't seem to be able to use delimited identifiers
322 * via PHP 4. They work fine under PHP 5.
324 * @param string $str the identifier name to be quoted
326 * @return string the quoted identifier
328 * @since Method available since Release 1.6.0
330 function quoteIdentifier($str)
332 return '"' . str_replace('"', '""', $str) . '"';
339 * Formats input so it can be safely used in a query
341 * The output depends on the PHP data type of input and the database
344 * @param mixed $in the data to be formatted
346 * @return mixed the formatted data. The format depends on the input's
350 * <kbd>input</kbd> -> <samp>returns</samp>
353 * <kbd>null</kbd> -> the string <samp>NULL</samp>
356 * <kbd>integer</kbd> or <kbd>double</kbd> -> the unquoted number
359 * <kbd>bool</kbd> -> output depends on the driver in use
360 * Most drivers return integers: <samp>1</samp> if
361 * <kbd>true</kbd> or <samp>0</samp> if
363 * Some return strings: <samp>TRUE</samp> if
364 * <kbd>true</kbd> or <samp>FALSE</samp> if
366 * Finally one returns strings: <samp>T</samp> if
367 * <kbd>true</kbd> or <samp>F</samp> if
368 * <kbd>false</kbd>. Here is a list of each DBMS,
369 * the values returned and the suggested column type:
372 * <kbd>dbase</kbd> -> <samp>T/F</samp>
373 * (<kbd>Logical</kbd>)
376 * <kbd>fbase</kbd> -> <samp>TRUE/FALSE</samp>
377 * (<kbd>BOOLEAN</kbd>)
380 * <kbd>ibase</kbd> -> <samp>1/0</samp>
381 * (<kbd>SMALLINT</kbd>) [1]
384 * <kbd>ifx</kbd> -> <samp>1/0</samp>
385 * (<kbd>SMALLINT</kbd>) [1]
388 * <kbd>msql</kbd> -> <samp>1/0</samp>
389 * (<kbd>INTEGER</kbd>)
392 * <kbd>mssql</kbd> -> <samp>1/0</samp>
396 * <kbd>mysql</kbd> -> <samp>1/0</samp>
397 * (<kbd>TINYINT(1)</kbd>)
400 * <kbd>mysqli</kbd> -> <samp>1/0</samp>
401 * (<kbd>TINYINT(1)</kbd>)
404 * <kbd>oci8</kbd> -> <samp>1/0</samp>
405 * (<kbd>NUMBER(1)</kbd>)
408 * <kbd>odbc</kbd> -> <samp>1/0</samp>
409 * (<kbd>SMALLINT</kbd>) [1]
412 * <kbd>pgsql</kbd> -> <samp>TRUE/FALSE</samp>
413 * (<kbd>BOOLEAN</kbd>)
416 * <kbd>sqlite</kbd> -> <samp>1/0</samp>
417 * (<kbd>INTEGER</kbd>)
420 * <kbd>sybase</kbd> -> <samp>1/0</samp>
421 * (<kbd>TINYINT(1)</kbd>)
424 * [1] Accommodate the lowest common denominator because not all
425 * versions of have <kbd>BOOLEAN</kbd>.
428 * other (including strings and numeric strings) ->
429 * the data with single quotes escaped by preceeding
430 * single quotes, backslashes are escaped by preceeding
431 * backslashes, then the whole string is encapsulated
432 * between single quotes
436 * @see DB_common::escapeSimple()
437 * @since Method available since Release 1.6.0
439 function quoteSmart($in)
443 } elseif (is_float($in)) {
444 return $this->quoteFloat($in);
445 } elseif (is_bool($in)) {
446 return $this->quoteBoolean($in);
447 } elseif (is_null($in)) {
450 if ($this->dbsyntax == 'access'
451 && preg_match('/^#.+#$/', $in))
453 return $this->escapeSimple($in);
455 return "'" . $this->escapeSimple($in) . "'";
460 // {{{ quoteBoolean()
463 * Formats a boolean value for use within a query in a locale-independent
466 * @param boolean the boolean value to be quoted.
467 * @return string the quoted string.
468 * @see DB_common::quoteSmart()
469 * @since Method available since release 1.7.8.
471 function quoteBoolean($boolean) {
472 return $boolean ? '1' : '0';
479 * Formats a float value for use within a query in a locale-independent
482 * @param float the float value to be quoted.
483 * @return string the quoted string.
484 * @see DB_common::quoteSmart()
485 * @since Method available since release 1.7.8.
487 function quoteFloat($float) {
488 return "'".$this->escapeSimple(str_replace(',', '.', strval(floatval($float))))."'";
492 // {{{ escapeSimple()
495 * Escapes a string according to the current DBMS's standards
497 * In SQLite, this makes things safe for inserts/updates, but may
498 * cause problems when performing text comparisons against columns
499 * containing binary data. See the
500 * {@link http://php.net/sqlite_escape_string PHP manual} for more info.
502 * @param string $str the string to be escaped
504 * @return string the escaped string
506 * @see DB_common::quoteSmart()
507 * @since Method available since Release 1.6.0
509 function escapeSimple($str)
511 return str_replace("'", "''", $str);
518 * Tells whether the present driver supports a given feature
520 * @param string $feature the feature you're curious about
522 * @return bool whether this driver supports $feature
524 function provides($feature)
526 return $this->features[$feature];
530 // {{{ setFetchMode()
533 * Sets the fetch mode that should be used by default for query results
535 * @param integer $fetchmode DB_FETCHMODE_ORDERED, DB_FETCHMODE_ASSOC
536 * or DB_FETCHMODE_OBJECT
537 * @param string $object_class the class name of the object to be returned
538 * by the fetch methods when the
539 * DB_FETCHMODE_OBJECT mode is selected.
540 * If no class is specified by default a cast
541 * to object from the assoc array row will be
542 * done. There is also the posibility to use
543 * and extend the 'DB_row' class.
545 * @see DB_FETCHMODE_ORDERED, DB_FETCHMODE_ASSOC, DB_FETCHMODE_OBJECT
547 function setFetchMode($fetchmode, $object_class = 'stdClass')
549 switch ($fetchmode) {
550 case DB_FETCHMODE_OBJECT:
551 $this->fetchmode_object_class = $object_class;
552 case DB_FETCHMODE_ORDERED:
553 case DB_FETCHMODE_ASSOC:
554 $this->fetchmode = $fetchmode;
557 return $this->raiseError('invalid fetchmode mode');
565 * Sets run-time configuration options for PEAR DB
567 * Options, their data types, default values and description:
570 * <var>autofree</var> <kbd>boolean</kbd> = <samp>false</samp>
571 * <br />should results be freed automatically when there are no
574 * <var>result_buffering</var> <kbd>integer</kbd> = <samp>500</samp>
575 * <br />how many rows of the result set should be buffered?
576 * <br />In mysql: mysql_unbuffered_query() is used instead of
577 * mysql_query() if this value is 0. (Release 1.7.0)
578 * <br />In oci8: this value is passed to ocisetprefetch().
581 * <var>debug</var> <kbd>integer</kbd> = <samp>0</samp>
584 * <var>persistent</var> <kbd>boolean</kbd> = <samp>false</samp>
585 * <br />should the connection be persistent?
587 * <var>portability</var> <kbd>integer</kbd> = <samp>DB_PORTABILITY_NONE</samp>
588 * <br />portability mode constant (see below)
590 * <var>seqname_format</var> <kbd>string</kbd> = <samp>%s_seq</samp>
591 * <br />the sprintf() format string used on sequence names. This
592 * format is applied to sequence names passed to
593 * createSequence(), nextID() and dropSequence().
595 * <var>ssl</var> <kbd>boolean</kbd> = <samp>false</samp>
596 * <br />use ssl to connect?
600 * -----------------------------------------
604 * These modes are bitwised, so they can be combined using <kbd>|</kbd>
605 * and removed using <kbd>^</kbd>. See the examples section below on how
608 * <samp>DB_PORTABILITY_NONE</samp>
609 * turn off all portability features
611 * This mode gets automatically turned on if the deprecated
612 * <var>optimize</var> option gets set to <samp>performance</samp>.
615 * <samp>DB_PORTABILITY_LOWERCASE</samp>
616 * convert names of tables and fields to lower case when using
617 * <kbd>get*()</kbd>, <kbd>fetch*()</kbd> and <kbd>tableInfo()</kbd>
619 * This mode gets automatically turned on in the following databases
620 * if the deprecated option <var>optimize</var> gets set to
621 * <samp>portability</samp>:
625 * <samp>DB_PORTABILITY_RTRIM</samp>
626 * right trim the data output by <kbd>get*()</kbd> <kbd>fetch*()</kbd>
629 * <samp>DB_PORTABILITY_DELETE_COUNT</samp>
630 * force reporting the number of rows deleted
632 * Some DBMS's don't count the number of rows deleted when performing
633 * simple <kbd>DELETE FROM tablename</kbd> queries. This portability
634 * mode tricks such DBMS's into telling the count by adding
635 * <samp>WHERE 1=1</samp> to the end of <kbd>DELETE</kbd> queries.
637 * This mode gets automatically turned on in the following databases
638 * if the deprecated option <var>optimize</var> gets set to
639 * <samp>portability</samp>:
646 * <samp>DB_PORTABILITY_NUMROWS</samp>
647 * enable hack that makes <kbd>numRows()</kbd> work in Oracle
649 * This mode gets automatically turned on in the following databases
650 * if the deprecated option <var>optimize</var> gets set to
651 * <samp>portability</samp>:
655 * <samp>DB_PORTABILITY_ERRORS</samp>
656 * makes certain error messages in certain drivers compatible
657 * with those from other DBMS's
659 * + mysql, mysqli: change unique/primary key constraints
660 * DB_ERROR_ALREADY_EXISTS -> DB_ERROR_CONSTRAINT
662 * + odbc(access): MS's ODBC driver reports 'no such field' as code
663 * 07001, which means 'too few parameters.' When this option is on
664 * that code gets mapped to DB_ERROR_NOSUCHFIELD.
665 * DB_ERROR_MISMATCH -> DB_ERROR_NOSUCHFIELD
667 * <samp>DB_PORTABILITY_NULL_TO_EMPTY</samp>
668 * convert null values to empty strings in data output by get*() and
669 * fetch*(). Needed because Oracle considers empty strings to be null,
670 * while most other DBMS's know the difference between empty and null.
673 * <samp>DB_PORTABILITY_ALL</samp>
674 * turn on all portability features
676 * -----------------------------------------
678 * Example 1. Simple setOption() example
680 * $db->setOption('autofree', true);
683 * Example 2. Portability for lowercasing and trimming
685 * $db->setOption('portability',
686 * DB_PORTABILITY_LOWERCASE | DB_PORTABILITY_RTRIM);
689 * Example 3. All portability options except trimming
691 * $db->setOption('portability',
692 * DB_PORTABILITY_ALL ^ DB_PORTABILITY_RTRIM);
695 * @param string $option option name
696 * @param mixed $value value for the option
698 * @return int DB_OK on success. A DB_Error object on failure.
700 * @see DB_common::$options
702 function setOption($option, $value)
704 if (isset($this->options[$option])) {
705 $this->options[$option] = $value;
708 * Backwards compatibility check for the deprecated 'optimize'
709 * option. Done here in case settings change after connecting.
711 if ($option == 'optimize') {
712 if ($value == 'portability') {
713 switch ($this->phptype) {
715 $this->options['portability'] =
716 DB_PORTABILITY_LOWERCASE |
717 DB_PORTABILITY_NUMROWS;
723 $this->options['portability'] =
724 DB_PORTABILITY_DELETE_COUNT;
728 $this->options['portability'] = DB_PORTABILITY_NONE;
734 return $this->raiseError("unknown option $option");
741 * Returns the value of an option
743 * @param string $option the option name you're curious about
745 * @return mixed the option's value
747 function getOption($option)
749 if (isset($this->options[$option])) {
750 return $this->options[$option];
752 return $this->raiseError("unknown option $option");
759 * Prepares a query for multiple execution with execute()
761 * Creates a query that can be run multiple times. Each time it is run,
762 * the placeholders, if any, will be replaced by the contents of
763 * execute()'s $data argument.
765 * Three types of placeholders can be used:
766 * + <kbd>?</kbd> scalar value (i.e. strings, integers). The system
767 * will automatically quote and escape the data.
768 * + <kbd>!</kbd> value is inserted 'as is'
769 * + <kbd>&</kbd> requires a file name. The file's contents get
770 * inserted into the query (i.e. saving binary
775 * $sth = $db->prepare('INSERT INTO tbl (a, b, c) VALUES (?, !, &)');
781 * $res = $db->execute($sth, $data);
784 * Use backslashes to escape placeholder characters if you don't want
785 * them to be interpreted as placeholders:
787 * "UPDATE foo SET col=? WHERE col='over \& under'"
790 * With some database backends, this is emulated.
792 * {@internal ibase and oci8 have their own prepare() methods.}}
794 * @param string $query the query to be prepared
796 * @return mixed DB statement resource on success. A DB_Error object
799 * @see DB_common::execute()
801 function prepare($query)
803 $tokens = preg_split('/((?<!\\\)[&?!])/', $query, -1,
804 PREG_SPLIT_DELIM_CAPTURE);
807 $newtokens = array();
809 foreach ($tokens as $val) {
812 $types[$token++] = DB_PARAM_SCALAR;
815 $types[$token++] = DB_PARAM_OPAQUE;
818 $types[$token++] = DB_PARAM_MISC;
821 $newtokens[] = preg_replace('/\\\([&?!])/', "\\1", $val);
825 $this->prepare_tokens[] = &$newtokens;
826 end($this->prepare_tokens);
828 $k = key($this->prepare_tokens);
829 $this->prepare_types[$k] = $types;
830 $this->prepared_queries[$k] = implode(' ', $newtokens);
839 * Automaticaly generates an insert or update query and pass it to prepare()
841 * @param string $table the table name
842 * @param array $table_fields the array of field names
843 * @param int $mode a type of query to make:
844 * DB_AUTOQUERY_INSERT or DB_AUTOQUERY_UPDATE
845 * @param string $where for update queries: the WHERE clause to
846 * append to the SQL statement. Don't
847 * include the "WHERE" keyword.
849 * @return resource the query handle
851 * @uses DB_common::prepare(), DB_common::buildManipSQL()
853 function autoPrepare($table, $table_fields, $mode = DB_AUTOQUERY_INSERT,
856 $query = $this->buildManipSQL($table, $table_fields, $mode, $where);
857 if (DB::isError($query)) {
860 return $this->prepare($query);
867 * Automaticaly generates an insert or update query and call prepare()
868 * and execute() with it
870 * @param string $table the table name
871 * @param array $fields_values the associative array where $key is a
872 * field name and $value its value
873 * @param int $mode a type of query to make:
874 * DB_AUTOQUERY_INSERT or DB_AUTOQUERY_UPDATE
875 * @param string $where for update queries: the WHERE clause to
876 * append to the SQL statement. Don't
877 * include the "WHERE" keyword.
879 * @return mixed a new DB_result object for successful SELECT queries
880 * or DB_OK for successul data manipulation queries.
881 * A DB_Error object on failure.
883 * @uses DB_common::autoPrepare(), DB_common::execute()
885 function autoExecute($table, $fields_values, $mode = DB_AUTOQUERY_INSERT,
888 $sth = $this->autoPrepare($table, array_keys($fields_values), $mode,
890 if (DB::isError($sth)) {
893 $ret = $this->execute($sth, array_values($fields_values));
894 $this->freePrepared($sth);
900 // {{{ buildManipSQL()
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 string $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 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);
977 * Executes a DB statement prepared with prepare()
981 * $sth = $db->prepare('INSERT INTO tbl (a, b, c) VALUES (?, !, &)');
987 * $res = $db->execute($sth, $data);
990 * @param resource $stmt a DB statement resource returned from prepare()
991 * @param mixed $data array, string or numeric data to be used in
992 * execution of the statement. Quantity of items
993 * passed must match quantity of placeholders in
994 * query: meaning 1 placeholder for non-array
995 * parameters or 1 placeholder per array element.
997 * @return mixed a new DB_result object for successful SELECT queries
998 * or DB_OK for successul data manipulation queries.
999 * A DB_Error object on failure.
1001 * {@internal ibase and oci8 have their own execute() methods.}}
1003 * @see DB_common::prepare()
1005 function &execute($stmt, $data = array())
1007 $realquery = $this->executeEmulateQuery($stmt, $data);
1008 if (DB::isError($realquery)) {
1011 $result = $this->simpleQuery($realquery);
1013 if ($result === DB_OK || DB::isError($result)) {
1016 $tmp = new DB_result($this, $result);
1022 // {{{ executeEmulateQuery()
1025 * Emulates executing prepared statements if the DBMS not support them
1027 * @param resource $stmt a DB statement resource returned from execute()
1028 * @param mixed $data array, string or numeric data to be used in
1029 * execution of the statement. Quantity of items
1030 * passed must match quantity of placeholders in
1031 * query: meaning 1 placeholder for non-array
1032 * parameters or 1 placeholder per array element.
1034 * @return mixed a string containing the real query run when emulating
1035 * prepare/execute. A DB_Error object on failure.
1038 * @see DB_common::execute()
1040 function executeEmulateQuery($stmt, $data = array())
1043 $data = (array)$data;
1044 $this->last_parameters = $data;
1046 if (count($this->prepare_types[$stmt]) != count($data)) {
1047 $this->last_query = $this->prepared_queries[$stmt];
1048 return $this->raiseError(DB_ERROR_MISMATCH);
1051 $realquery = $this->prepare_tokens[$stmt][0];
1054 foreach ($data as $value) {
1055 if ($this->prepare_types[$stmt][$i] == DB_PARAM_SCALAR) {
1056 $realquery .= $this->quoteSmart($value);
1057 } elseif ($this->prepare_types[$stmt][$i] == DB_PARAM_OPAQUE) {
1058 $fp = @fopen($value, 'rb');
1060 return $this->raiseError(DB_ERROR_ACCESS_VIOLATION);
1062 $realquery .= $this->quoteSmart(fread($fp, filesize($value)));
1065 $realquery .= $value;
1068 $realquery .= $this->prepare_tokens[$stmt][++$i];
1075 // {{{ executeMultiple()
1078 * Performs several execute() calls on the same statement handle
1080 * $data must be an array indexed numerically
1081 * from 0, one execute call is done for every "row" in the array.
1083 * If an error occurs during execute(), executeMultiple() does not
1084 * execute the unfinished rows, but rather returns that error.
1086 * @param resource $stmt query handle from prepare()
1087 * @param array $data numeric array containing the
1088 * data to insert into the query
1090 * @return int DB_OK on success. A DB_Error object on failure.
1092 * @see DB_common::prepare(), DB_common::execute()
1094 function executeMultiple($stmt, $data)
1096 foreach ($data as $value) {
1097 $res = $this->execute($stmt, $value);
1098 if (DB::isError($res)) {
1106 // {{{ freePrepared()
1109 * Frees the internal resources associated with a prepared query
1111 * @param resource $stmt the prepared statement's PHP resource
1112 * @param bool $free_resource should the PHP resource be freed too?
1113 * Use false if you need to get data
1114 * from the result set later.
1116 * @return bool TRUE on success, FALSE if $result is invalid
1118 * @see DB_common::prepare()
1120 function freePrepared($stmt, $free_resource = true)
1123 if (isset($this->prepare_tokens[$stmt])) {
1124 unset($this->prepare_tokens[$stmt]);
1125 unset($this->prepare_types[$stmt]);
1126 unset($this->prepared_queries[$stmt]);
1133 // {{{ modifyQuery()
1136 * Changes a query string for various DBMS specific reasons
1138 * It is defined here to ensure all drivers have this method available.
1140 * @param string $query the query string to modify
1142 * @return string the modified query string
1145 * @see DB_mysql::modifyQuery(), DB_oci8::modifyQuery(),
1146 * DB_sqlite::modifyQuery()
1148 function modifyQuery($query)
1154 // {{{ modifyLimitQuery()
1157 * Adds LIMIT clauses to a query string according to current DBMS standards
1159 * It is defined here to assure that all implementations
1160 * have this method defined.
1162 * @param string $query the query to modify
1163 * @param int $from the row to start to fetching (0 = the first row)
1164 * @param int $count the numbers of rows to fetch
1165 * @param mixed $params array, string or numeric data to be used in
1166 * execution of the statement. Quantity of items
1167 * passed must match quantity of placeholders in
1168 * query: meaning 1 placeholder for non-array
1169 * parameters or 1 placeholder per array element.
1171 * @return string the query string with LIMIT clauses added
1175 function modifyLimitQuery($query, $from, $count, $params = array())
1184 * Sends a query to the database server
1186 * The query string can be either a normal statement to be sent directly
1187 * to the server OR if <var>$params</var> are passed the query can have
1188 * placeholders and it will be passed through prepare() and execute().
1190 * @param string $query the SQL query or the statement to prepare
1191 * @param mixed $params array, string or numeric data to be used in
1192 * execution of the statement. Quantity of items
1193 * passed must match quantity of placeholders in
1194 * query: meaning 1 placeholder for non-array
1195 * parameters or 1 placeholder per array element.
1197 * @return mixed a new DB_result object for successful SELECT queries
1198 * or DB_OK for successul data manipulation queries.
1199 * A DB_Error object on failure.
1201 * @see DB_result, DB_common::prepare(), DB_common::execute()
1203 function &query($query, $params = array())
1205 if (sizeof($params) > 0) {
1206 $sth = $this->prepare($query);
1207 if (DB::isError($sth)) {
1210 $ret = $this->execute($sth, $params);
1211 $this->freePrepared($sth, false);
1214 $this->last_parameters = array();
1215 $result = $this->simpleQuery($query);
1216 if ($result === DB_OK || DB::isError($result)) {
1219 $tmp = new DB_result($this, $result);
1229 * Generates and executes a LIMIT query
1231 * @param string $query the query
1232 * @param intr $from the row to start to fetching (0 = the first row)
1233 * @param int $count the numbers of rows to fetch
1234 * @param mixed $params array, string or numeric data to be used in
1235 * execution of the statement. Quantity of items
1236 * passed must match quantity of placeholders in
1237 * query: meaning 1 placeholder for non-array
1238 * parameters or 1 placeholder per array element.
1240 * @return mixed a new DB_result object for successful SELECT queries
1241 * or DB_OK for successul data manipulation queries.
1242 * A DB_Error object on failure.
1244 function &limitQuery($query, $from, $count, $params = array())
1246 $query = $this->modifyLimitQuery($query, $from, $count, $params);
1247 if (DB::isError($query)){
1250 $result = $this->query($query, $params);
1251 if (is_object($result) && is_a($result, 'DB_result')) {
1252 $result->setOption('limit_from', $from);
1253 $result->setOption('limit_count', $count);
1262 * Fetches the first column of the first row from a query result
1264 * Takes care of doing the query and freeing the results when finished.
1266 * @param string $query the SQL query
1267 * @param mixed $params array, string or numeric data to be used in
1268 * execution of the statement. Quantity of items
1269 * passed must match quantity of placeholders in
1270 * query: meaning 1 placeholder for non-array
1271 * parameters or 1 placeholder per array element.
1273 * @return mixed the returned value of the query.
1274 * A DB_Error object on failure.
1276 function &getOne($query, $params = array())
1278 $params = (array)$params;
1279 // modifyLimitQuery() would be nice here, but it causes BC issues
1280 if (sizeof($params) > 0) {
1281 $sth = $this->prepare($query);
1282 if (DB::isError($sth)) {
1285 $res = $this->execute($sth, $params);
1286 $this->freePrepared($sth);
1288 $res = $this->query($query);
1291 if (DB::isError($res)) {
1295 $err = $res->fetchInto($row, DB_FETCHMODE_ORDERED);
1298 if ($err !== DB_OK) {
1309 * Fetches the first row of data returned from a query result
1311 * Takes care of doing the query and freeing the results when finished.
1313 * @param string $query the SQL query
1314 * @param mixed $params array, string or numeric data to be used in
1315 * execution of the statement. Quantity of items
1316 * passed must match quantity of placeholders in
1317 * query: meaning 1 placeholder for non-array
1318 * parameters or 1 placeholder per array element.
1319 * @param int $fetchmode the fetch mode to use
1321 * @return array the first row of results as an array.
1322 * A DB_Error object on failure.
1324 function &getRow($query, $params = array(),
1325 $fetchmode = DB_FETCHMODE_DEFAULT)
1327 // compat check, the params and fetchmode parameters used to
1328 // have the opposite order
1329 if (!is_array($params)) {
1330 if (is_array($fetchmode)) {
1331 if ($params === null) {
1332 $tmp = DB_FETCHMODE_DEFAULT;
1336 $params = $fetchmode;
1338 } elseif ($params !== null) {
1339 $fetchmode = $params;
1343 // modifyLimitQuery() would be nice here, but it causes BC issues
1344 if (sizeof($params) > 0) {
1345 $sth = $this->prepare($query);
1346 if (DB::isError($sth)) {
1349 $res = $this->execute($sth, $params);
1350 $this->freePrepared($sth);
1352 $res = $this->query($query);
1355 if (DB::isError($res)) {
1359 $err = $res->fetchInto($row, $fetchmode);
1363 if ($err !== DB_OK) {
1374 * Fetches a single column from a query result and returns it as an
1377 * @param string $query the SQL query
1378 * @param mixed $col which column to return (integer [column number,
1379 * starting at 0] or string [column name])
1380 * @param mixed $params array, string or numeric data to be used in
1381 * execution of the statement. Quantity of items
1382 * passed must match quantity of placeholders in
1383 * query: meaning 1 placeholder for non-array
1384 * parameters or 1 placeholder per array element.
1386 * @return array the results as an array. A DB_Error object on failure.
1388 * @see DB_common::query()
1390 function &getCol($query, $col = 0, $params = array())
1392 $params = (array)$params;
1393 if (sizeof($params) > 0) {
1394 $sth = $this->prepare($query);
1396 if (DB::isError($sth)) {
1400 $res = $this->execute($sth, $params);
1401 $this->freePrepared($sth);
1403 $res = $this->query($query);
1406 if (DB::isError($res)) {
1410 $fetchmode = is_int($col) ? DB_FETCHMODE_ORDERED : DB_FETCHMODE_ASSOC;
1412 if (!is_array($row = $res->fetchRow($fetchmode))) {
1415 if (!array_key_exists($col, $row)) {
1416 $ret = $this->raiseError(DB_ERROR_NOSUCHFIELD);
1418 $ret = array($row[$col]);
1419 while (is_array($row = $res->fetchRow($fetchmode))) {
1420 $ret[] = $row[$col];
1427 if (DB::isError($row)) {
1438 * Fetches an entire query result and returns it as an
1439 * associative array using the first column as the key
1441 * If the result set contains more than two columns, the value
1442 * will be an array of the values from column 2-n. If the result
1443 * set contains only two columns, the returned value will be a
1444 * scalar with the value of the second column (unless forced to an
1445 * array with the $force_array parameter). A DB error code is
1446 * returned on errors. If the result set contains fewer than two
1447 * columns, a DB_ERROR_TRUNCATED error is returned.
1449 * For example, if the table "mytable" contains:
1453 * --------------------------------
1456 * 3 'three' 944679408
1459 * Then the call getAssoc('SELECT id,text FROM mytable') returns:
1468 * ...while the call getAssoc('SELECT id,text,date FROM mytable') returns:
1471 * '1' => array('one', '944679408'),
1472 * '2' => array('two', '944679408'),
1473 * '3' => array('three', '944679408')
1477 * If the more than one row occurs with the same value in the
1478 * first column, the last row overwrites all previous ones by
1479 * default. Use the $group parameter if you don't want to
1480 * overwrite like this. Example:
1483 * getAssoc('SELECT category,id,name FROM mytable', false, null,
1484 * DB_FETCHMODE_ASSOC, true) returns:
1487 * '1' => array(array('id' => '4', 'name' => 'number four'),
1488 * array('id' => '6', 'name' => 'number six')
1490 * '9' => array(array('id' => '4', 'name' => 'number four'),
1491 * array('id' => '6', 'name' => 'number six')
1496 * Keep in mind that database functions in PHP usually return string
1497 * values for results regardless of the database's internal type.
1499 * @param string $query the SQL query
1500 * @param bool $force_array used only when the query returns
1501 * exactly two columns. If true, the values
1502 * of the returned array will be one-element
1503 * arrays instead of scalars.
1504 * @param mixed $params array, string or numeric data to be used in
1505 * execution of the statement. Quantity of
1506 * items passed must match quantity of
1507 * placeholders in query: meaning 1
1508 * placeholder for non-array parameters or
1509 * 1 placeholder per array element.
1510 * @param int $fetchmode the fetch mode to use
1511 * @param bool $group if true, the values of the returned array
1512 * is wrapped in another array. If the same
1513 * key value (in the first column) repeats
1514 * itself, the values will be appended to
1515 * this array instead of overwriting the
1518 * @return array the associative array containing the query results.
1519 * A DB_Error object on failure.
1521 function &getAssoc($query, $force_array = false, $params = array(),
1522 $fetchmode = DB_FETCHMODE_DEFAULT, $group = false)
1524 $params = (array)$params;
1525 if (sizeof($params) > 0) {
1526 $sth = $this->prepare($query);
1528 if (DB::isError($sth)) {
1532 $res = $this->execute($sth, $params);
1533 $this->freePrepared($sth);
1535 $res = $this->query($query);
1538 if (DB::isError($res)) {
1541 if ($fetchmode == DB_FETCHMODE_DEFAULT) {
1542 $fetchmode = $this->fetchmode;
1544 $cols = $res->numCols();
1547 $tmp = $this->raiseError(DB_ERROR_TRUNCATED);
1553 if ($cols > 2 || $force_array) {
1554 // return array values
1555 // XXX this part can be optimized
1556 if ($fetchmode == DB_FETCHMODE_ASSOC) {
1557 while (is_array($row = $res->fetchRow(DB_FETCHMODE_ASSOC))) {
1559 $key = current($row);
1560 unset($row[key($row)]);
1562 $results[$key][] = $row;
1564 $results[$key] = $row;
1567 } elseif ($fetchmode == DB_FETCHMODE_OBJECT) {
1568 while ($row = $res->fetchRow(DB_FETCHMODE_OBJECT)) {
1569 $arr = get_object_vars($row);
1570 $key = current($arr);
1572 $results[$key][] = $row;
1574 $results[$key] = $row;
1578 while (is_array($row = $res->fetchRow(DB_FETCHMODE_ORDERED))) {
1579 // we shift away the first element to get
1580 // indices running from 0 again
1581 $key = array_shift($row);
1583 $results[$key][] = $row;
1585 $results[$key] = $row;
1589 if (DB::isError($row)) {
1593 // return scalar values
1594 while (is_array($row = $res->fetchRow(DB_FETCHMODE_ORDERED))) {
1596 $results[$row[0]][] = $row[1];
1598 $results[$row[0]] = $row[1];
1601 if (DB::isError($row)) {
1615 * Fetches all of the rows from a query result
1617 * @param string $query the SQL query
1618 * @param mixed $params array, string or numeric data to be used in
1619 * execution of the statement. Quantity of
1620 * items passed must match quantity of
1621 * placeholders in query: meaning 1
1622 * placeholder for non-array parameters or
1623 * 1 placeholder per array element.
1624 * @param int $fetchmode the fetch mode to use:
1625 * + DB_FETCHMODE_ORDERED
1626 * + DB_FETCHMODE_ASSOC
1627 * + DB_FETCHMODE_ORDERED | DB_FETCHMODE_FLIPPED
1628 * + DB_FETCHMODE_ASSOC | DB_FETCHMODE_FLIPPED
1630 * @return array the nested array. A DB_Error object on failure.
1632 function &getAll($query, $params = array(),
1633 $fetchmode = DB_FETCHMODE_DEFAULT)
1635 // compat check, the params and fetchmode parameters used to
1636 // have the opposite order
1637 if (!is_array($params)) {
1638 if (is_array($fetchmode)) {
1639 if ($params === null) {
1640 $tmp = DB_FETCHMODE_DEFAULT;
1644 $params = $fetchmode;
1646 } elseif ($params !== null) {
1647 $fetchmode = $params;
1652 if (sizeof($params) > 0) {
1653 $sth = $this->prepare($query);
1655 if (DB::isError($sth)) {
1659 $res = $this->execute($sth, $params);
1660 $this->freePrepared($sth);
1662 $res = $this->query($query);
1665 if ($res === DB_OK || DB::isError($res)) {
1670 while (DB_OK === $res->fetchInto($row, $fetchmode)) {
1671 if ($fetchmode & DB_FETCHMODE_FLIPPED) {
1672 foreach ($row as $key => $val) {
1673 $results[$key][] = $val;
1682 if (DB::isError($row)) {
1683 $tmp = $this->raiseError($row);
1693 * Enables or disables automatic commits
1695 * @param bool $onoff true turns it on, false turns it off
1697 * @return int DB_OK on success. A DB_Error object if the driver
1698 * doesn't support auto-committing transactions.
1700 function autoCommit($onoff = false)
1702 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
1709 * Commits the current transaction
1711 * @return int DB_OK on success. A DB_Error object on failure.
1715 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
1722 * Reverts the current transaction
1724 * @return int DB_OK on success. A DB_Error object on failure.
1728 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
1735 * Determines the number of rows in a query result
1737 * @param resource $result the query result idenifier produced by PHP
1739 * @return int the number of rows. A DB_Error object on failure.
1741 function numRows($result)
1743 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
1747 // {{{ affectedRows()
1750 * Determines the number of rows affected by a data maniuplation query
1752 * 0 is returned for queries that don't manipulate data.
1754 * @return int the number of rows. A DB_Error object on failure.
1756 function affectedRows()
1758 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
1762 // {{{ getSequenceName()
1765 * Generates the name used inside the database for a sequence
1767 * The createSequence() docblock contains notes about storing sequence
1770 * @param string $sqn the sequence's public name
1772 * @return string the sequence's name in the backend
1775 * @see DB_common::createSequence(), DB_common::dropSequence(),
1776 * DB_common::nextID(), DB_common::setOption()
1778 function getSequenceName($sqn)
1780 return sprintf($this->getOption('seqname_format'),
1781 preg_replace('/[^a-z0-9_.]/i', '_', $sqn));
1788 * Returns the next free id in a sequence
1790 * @param string $seq_name name of the sequence
1791 * @param boolean $ondemand when true, the seqence is automatically
1792 * created if it does not exist
1794 * @return int the next id number in the sequence.
1795 * A DB_Error object on failure.
1797 * @see DB_common::createSequence(), DB_common::dropSequence(),
1798 * DB_common::getSequenceName()
1800 function nextId($seq_name, $ondemand = true)
1802 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
1806 // {{{ createSequence()
1809 * Creates a new sequence
1811 * The name of a given sequence is determined by passing the string
1812 * provided in the <var>$seq_name</var> argument through PHP's sprintf()
1813 * function using the value from the <var>seqname_format</var> option as
1814 * the sprintf()'s format argument.
1816 * <var>seqname_format</var> is set via setOption().
1818 * @param string $seq_name name of the new sequence
1820 * @return int DB_OK on success. A DB_Error object on failure.
1822 * @see DB_common::dropSequence(), DB_common::getSequenceName(),
1823 * DB_common::nextID()
1825 function createSequence($seq_name)
1827 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
1831 // {{{ dropSequence()
1834 * Deletes a sequence
1836 * @param string $seq_name name of the sequence to be deleted
1838 * @return int DB_OK on success. A DB_Error object on failure.
1840 * @see DB_common::createSequence(), DB_common::getSequenceName(),
1841 * DB_common::nextID()
1843 function dropSequence($seq_name)
1845 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
1852 * Communicates an error and invoke error callbacks, etc
1854 * Basically a wrapper for PEAR::raiseError without the message string.
1856 * @param mixed integer error code, or a PEAR error object (all
1857 * other parameters are ignored if this parameter is
1859 * @param int error mode, see PEAR_Error docs
1860 * @param mixed if error mode is PEAR_ERROR_TRIGGER, this is the
1861 * error level (E_USER_NOTICE etc). If error mode is
1862 * PEAR_ERROR_CALLBACK, this is the callback function,
1863 * either as a function name, or as an array of an
1864 * object and method name. For other error modes this
1865 * parameter is ignored.
1866 * @param string extra debug information. Defaults to the last
1867 * query and native error code.
1868 * @param mixed native error code, integer or string depending the
1870 * @param mixed dummy parameter for E_STRICT compatibility with
1872 * @param mixed dummy parameter for E_STRICT compatibility with
1875 * @return object the PEAR_Error object
1879 function &raiseError($code = DB_ERROR, $mode = null, $options = null,
1880 $userinfo = null, $nativecode = null, $dummy1 = null,
1883 // The error is yet a DB error object
1884 if (is_object($code)) {
1885 // because we the static PEAR::raiseError, our global
1886 // handler should be used if it is set
1887 if ($mode === null && !empty($this->_default_error_mode)) {
1888 $mode = $this->_default_error_mode;
1889 $options = $this->_default_error_options;
1891 $tmp = PEAR::raiseError($code, null, $mode, $options,
1896 if ($userinfo === null) {
1897 $userinfo = $this->last_query;
1901 $userinfo .= ' [nativecode=' . trim($nativecode) . ']';
1903 $userinfo .= ' [DB Error: ' . DB::errorMessage($code) . ']';
1906 $tmp = PEAR::raiseError(null, $code, $mode, $options, $userinfo,
1912 // {{{ errorNative()
1915 * Gets the DBMS' native error code produced by the last query
1917 * @return mixed the DBMS' error code. A DB_Error object on failure.
1919 function errorNative()
1921 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
1928 * Maps native error codes to DB's portable ones
1930 * Uses the <var>$errorcode_map</var> property defined in each driver.
1932 * @param string|int $nativecode the error code returned by the DBMS
1934 * @return int the portable DB error code. Return DB_ERROR if the
1935 * current driver doesn't have a mapping for the
1936 * $nativecode submitted.
1938 function errorCode($nativecode)
1940 if (isset($this->errorcode_map[$nativecode])) {
1941 return $this->errorcode_map[$nativecode];
1943 // Fall back to DB_ERROR if there was no mapping.
1948 // {{{ errorMessage()
1951 * Maps a DB error code to a textual message
1953 * @param integer $dbcode the DB error code
1955 * @return string the error message corresponding to the error code
1956 * submitted. FALSE if the error code is unknown.
1958 * @see DB::errorMessage()
1960 function errorMessage($dbcode)
1962 return DB::errorMessage($this->errorcode_map[$dbcode]);
1969 * Returns information about a table or a result set
1971 * The format of the resulting array depends on which <var>$mode</var>
1972 * you select. The sample output below is based on this query:
1974 * SELECT tblFoo.fldID, tblFoo.fldPhone, tblBar.fldId
1976 * JOIN tblBar ON tblFoo.fldId = tblBar.fldId
1982 * <kbd>null</kbd> (default)
1989 * [flags] => primary_key not_null
1993 * [name] => fldPhone
2003 * [flags] => primary_key not_null
2009 * <kbd>DB_TABLEINFO_ORDER</kbd>
2011 * <p>In addition to the information found in the default output,
2012 * a notation of the number of columns is provided by the
2013 * <samp>num_fields</samp> element while the <samp>order</samp>
2014 * element provides an array with the column names as the keys and
2015 * their location index number (corresponding to the keys in the
2016 * the default output) as the values.</p>
2018 * <p>If a result set has identical field names, the last one is
2023 * [order] => Array (
2031 * <kbd>DB_TABLEINFO_ORDERTABLE</kbd>
2033 * <p>Similar to <kbd>DB_TABLEINFO_ORDER</kbd> but adds more
2034 * dimensions to the array in which the table names are keys and
2035 * the field names are sub-keys. This is helpful for queries that
2036 * join tables which have identical field names.</p>
2040 * [ordertable] => Array (
2041 * [tblFoo] => Array (
2045 * [tblBar] => Array (
2054 * The <samp>flags</samp> element contains a space separated list
2055 * of extra information about the field. This data is inconsistent
2056 * between DBMS's due to the way each DBMS works.
2057 * + <samp>primary_key</samp>
2058 * + <samp>unique_key</samp>
2059 * + <samp>multiple_key</samp>
2060 * + <samp>not_null</samp>
2062 * Most DBMS's only provide the <samp>table</samp> and <samp>flags</samp>
2063 * elements if <var>$result</var> is a table name. The following DBMS's
2064 * provide full information from queries:
2068 * If the 'portability' option has <samp>DB_PORTABILITY_LOWERCASE</samp>
2069 * turned on, the names of tables and fields will be lowercased.
2071 * @param object|string $result DB_result object from a query or a
2072 * string containing the name of a table.
2073 * While this also accepts a query result
2074 * resource identifier, this behavior is
2076 * @param int $mode either unused or one of the tableInfo modes:
2077 * <kbd>DB_TABLEINFO_ORDERTABLE</kbd>,
2078 * <kbd>DB_TABLEINFO_ORDER</kbd> or
2079 * <kbd>DB_TABLEINFO_FULL</kbd> (which does both).
2080 * These are bitwise, so the first two can be
2081 * combined using <kbd>|</kbd>.
2083 * @return array an associative array with the information requested.
2084 * A DB_Error object on failure.
2086 * @see DB_common::setOption()
2088 function tableInfo($result, $mode = null)
2091 * If the DB_<driver> class has a tableInfo() method, that one
2092 * overrides this one. But, if the driver doesn't have one,
2093 * this method runs and tells users about that fact.
2095 return $this->raiseError(DB_ERROR_NOT_CAPABLE);
2102 * Lists the tables in the current database
2104 * @return array the list of tables. A DB_Error object on failure.
2106 * @deprecated Method deprecated some time before Release 1.2
2108 function getTables()
2110 return $this->getListOf('tables');
2117 * Lists internal database information
2119 * @param string $type type of information being sought.
2120 * Common items being sought are:
2121 * tables, databases, users, views, functions
2122 * Each DBMS's has its own capabilities.
2124 * @return array an array listing the items sought.
2125 * A DB DB_Error object on failure.
2127 function getListOf($type)
2129 $sql = $this->getSpecialQuery($type);
2130 if ($sql === null) {
2131 $this->last_query = '';
2132 return $this->raiseError(DB_ERROR_UNSUPPORTED);
2133 } elseif (is_int($sql) || DB::isError($sql)) {
2135 return $this->raiseError($sql);
2136 } elseif (is_array($sql)) {
2137 // Already the result
2140 // Launch this query
2141 return $this->getCol($sql);
2145 // {{{ getSpecialQuery()
2148 * Obtains the query string needed for listing a given type of objects
2150 * @param string $type the kind of objects you want to retrieve
2152 * @return string the SQL query string or null if the driver doesn't
2153 * support the object type requested
2156 * @see DB_common::getListOf()
2158 function getSpecialQuery($type)
2160 return $this->raiseError(DB_ERROR_UNSUPPORTED);
2164 // {{{ nextQueryIsManip()
2167 * Sets (or unsets) a flag indicating that the next query will be a
2168 * manipulation query, regardless of the usual DB::isManip() heuristics.
2170 * @param boolean true to set the flag overriding the isManip() behaviour,
2171 * false to clear it and fall back onto isManip()
2177 function nextQueryIsManip($manip)
2179 $this->_next_query_manip = $manip;
2183 // {{{ _checkManip()
2186 * Checks if the given query is a manipulation query. This also takes into
2187 * account the _next_query_manip flag and sets the _last_query_manip flag
2188 * (and resets _next_query_manip) according to the result.
2190 * @param string The query to check.
2192 * @return boolean true if the query is a manipulation query, false
2197 function _checkManip($query)
2199 if ($this->_next_query_manip || DB::isManip($query)) {
2200 $this->_last_query_manip = true;
2202 $this->_last_query_manip = false;
2204 $this->_next_query_manip = false;
2205 return $this->_last_query_manip;
2206 $manip = $this->_next_query_manip;
2210 // {{{ _rtrimArrayValues()
2213 * Right-trims all strings in an array
2215 * @param array $array the array to be trimmed (passed by reference)
2221 function _rtrimArrayValues(&$array)
2223 foreach ($array as $key => $value) {
2224 if (is_string($value)) {
2225 $array[$key] = rtrim($value);
2231 // {{{ _convertNullArrayValuesToEmpty()
2234 * Converts all null values in an array to empty strings
2236 * @param array $array the array to be de-nullified (passed by reference)
2242 function _convertNullArrayValuesToEmpty(&$array)
2244 foreach ($array as $key => $value) {
2245 if (is_null($value)) {