3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
6 * Database independent query interface
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';
37 * One of PEAR DB's portable error codes.
38 * @see DB_common::errorCode(), DB::errorMessage()
40 * {@internal If you add an error code here, make sure you also add a textual
41 * version of it in DB::errorMessage().}}
45 * The code returned by many methods upon success
52 define('DB_ERROR', -1);
57 define('DB_ERROR_SYNTAX', -2);
60 * Tried to insert a duplicate value into a primary or unique index
62 define('DB_ERROR_CONSTRAINT', -3);
65 * An identifier in the query refers to a non-existant object
67 define('DB_ERROR_NOT_FOUND', -4);
70 * Tried to create a duplicate object
72 define('DB_ERROR_ALREADY_EXISTS', -5);
75 * The current driver does not support the action you attempted
77 define('DB_ERROR_UNSUPPORTED', -6);
80 * The number of parameters does not match the number of placeholders
82 define('DB_ERROR_MISMATCH', -7);
85 * A literal submitted did not match the data type expected
87 define('DB_ERROR_INVALID', -8);
90 * The current DBMS does not support the action you attempted
92 define('DB_ERROR_NOT_CAPABLE', -9);
95 * A literal submitted was too long so the end of it was removed
97 define('DB_ERROR_TRUNCATED', -10);
100 * A literal number submitted did not match the data type expected
102 define('DB_ERROR_INVALID_NUMBER', -11);
105 * A literal date submitted did not match the data type expected
107 define('DB_ERROR_INVALID_DATE', -12);
110 * Attempt to divide something by zero
112 define('DB_ERROR_DIVZERO', -13);
115 * A database needs to be selected
117 define('DB_ERROR_NODBSELECTED', -14);
120 * Could not create the object requested
122 define('DB_ERROR_CANNOT_CREATE', -15);
125 * Could not drop the database requested because it does not exist
127 define('DB_ERROR_CANNOT_DROP', -17);
130 * An identifier in the query refers to a non-existant table
132 define('DB_ERROR_NOSUCHTABLE', -18);
135 * An identifier in the query refers to a non-existant column
137 define('DB_ERROR_NOSUCHFIELD', -19);
140 * The data submitted to the method was inappropriate
142 define('DB_ERROR_NEED_MORE_DATA', -20);
145 * The attempt to lock the table failed
147 define('DB_ERROR_NOT_LOCKED', -21);
150 * The number of columns doesn't match the number of values
152 define('DB_ERROR_VALUE_COUNT_ON_ROW', -22);
155 * The DSN submitted has problems
157 define('DB_ERROR_INVALID_DSN', -23);
160 * Could not connect to the database
162 define('DB_ERROR_CONNECT_FAILED', -24);
165 * The PHP extension needed for this DBMS could not be found
167 define('DB_ERROR_EXTENSION_NOT_FOUND', -25);
170 * The present user has inadequate permissions to perform the task requestd
172 define('DB_ERROR_ACCESS_VIOLATION', -26);
175 * The database requested does not exist
177 define('DB_ERROR_NOSUCHDB', -27);
180 * Tried to insert a null value into a column that doesn't allow nulls
182 define('DB_ERROR_CONSTRAINT_NOT_NULL', -29);
187 // {{{ prepared statement-related
191 * Identifiers for the placeholders used in prepared statements.
192 * @see DB_common::prepare()
196 * Indicates a scalar (<kbd>?</kbd>) placeholder was used
198 * Quote and escape the value as necessary.
200 define('DB_PARAM_SCALAR', 1);
203 * Indicates an opaque (<kbd>&</kbd>) placeholder was used
205 * The value presented is a file name. Extract the contents of that file
206 * and place them in this column.
208 define('DB_PARAM_OPAQUE', 2);
211 * Indicates a misc (<kbd>!</kbd>) placeholder was used
213 * The value should not be quoted or escaped.
215 define('DB_PARAM_MISC', 3);
220 // {{{ binary data-related
224 * The different ways of returning binary data from queries.
228 * Sends the fetched data straight through to output
230 define('DB_BINMODE_PASSTHRU', 1);
233 * Lets you return data as usual
235 define('DB_BINMODE_RETURN', 2);
238 * Converts the data to hex format before returning it
240 * For example the string "123" would become "313233".
242 define('DB_BINMODE_CONVERT', 3);
252 * @see DB_common::setFetchMode()
256 * Indicates the current default fetch mode should be used
257 * @see DB_common::$fetchmode
259 define('DB_FETCHMODE_DEFAULT', 0);
262 * Column data indexed by numbers, ordered from 0 and up
264 define('DB_FETCHMODE_ORDERED', 1);
267 * Column data indexed by column names
269 define('DB_FETCHMODE_ASSOC', 2);
272 * Column data as object properties
274 define('DB_FETCHMODE_OBJECT', 3);
277 * For multi-dimensional results, make the column name the first level
278 * of the array and put the row number in the second level of the array
280 * This is flipped from the normal behavior, which puts the row numbers
281 * in the first level of the array and the column names in the second level.
283 define('DB_FETCHMODE_FLIPPED', 4);
287 * Old fetch modes. Left here for compatibility.
289 define('DB_GETMODE_ORDERED', DB_FETCHMODE_ORDERED);
290 define('DB_GETMODE_ASSOC', DB_FETCHMODE_ASSOC);
291 define('DB_GETMODE_FLIPPED', DB_FETCHMODE_FLIPPED);
296 // {{{ tableInfo() && autoPrepare()-related
300 * The type of information to return from the tableInfo() method.
302 * Bitwised constants, so they can be combined using <kbd>|</kbd>
303 * and removed using <kbd>^</kbd>.
305 * @see DB_common::tableInfo()
307 * {@internal Since the TABLEINFO constants are bitwised, if more of them are
308 * added in the future, make sure to adjust DB_TABLEINFO_FULL accordingly.}}
310 define('DB_TABLEINFO_ORDER', 1);
311 define('DB_TABLEINFO_ORDERTABLE', 2);
312 define('DB_TABLEINFO_FULL', 3);
317 * The type of query to create with the automatic query building methods.
318 * @see DB_common::autoPrepare(), DB_common::autoExecute()
320 define('DB_AUTOQUERY_INSERT', 1);
321 define('DB_AUTOQUERY_UPDATE', 2);
326 // {{{ portability modes
332 * Bitwised constants, so they can be combined using <kbd>|</kbd>
333 * and removed using <kbd>^</kbd>.
335 * @see DB_common::setOption()
337 * {@internal Since the PORTABILITY constants are bitwised, if more of them are
338 * added in the future, make sure to adjust DB_PORTABILITY_ALL accordingly.}}
342 * Turn off all portability features
344 define('DB_PORTABILITY_NONE', 0);
347 * Convert names of tables and fields to lower case
348 * when using the get*(), fetch*() and tableInfo() methods
350 define('DB_PORTABILITY_LOWERCASE', 1);
353 * Right trim the data output by get*() and fetch*()
355 define('DB_PORTABILITY_RTRIM', 2);
358 * Force reporting the number of rows deleted
360 define('DB_PORTABILITY_DELETE_COUNT', 4);
363 * Enable hack that makes numRows() work in Oracle
365 define('DB_PORTABILITY_NUMROWS', 8);
368 * Makes certain error messages in certain drivers compatible
369 * with those from other DBMS's
371 * + mysql, mysqli: change unique/primary key constraints
372 * DB_ERROR_ALREADY_EXISTS -> DB_ERROR_CONSTRAINT
374 * + odbc(access): MS's ODBC driver reports 'no such field' as code
375 * 07001, which means 'too few parameters.' When this option is on
376 * that code gets mapped to DB_ERROR_NOSUCHFIELD.
378 define('DB_PORTABILITY_ERRORS', 16);
381 * Convert null values to empty strings in data output by
382 * get*() and fetch*()
384 define('DB_PORTABILITY_NULL_TO_EMPTY', 32);
387 * Turn on all portability features
389 define('DB_PORTABILITY_ALL', 63);
399 * Database independent query interface
401 * The main "DB" class is simply a container class with some static
402 * methods for creating DB objects as well as some utility functions
403 * common to all parts of DB.
405 * The object model of DB is as follows (indentation means inheritance):
407 * DB The main DB class. This is simply a utility class
408 * with some "static" methods for creating DB objects as
409 * well as common utility functions for other DB classes.
411 * DB_common The base for each DB implementation. Provides default
412 * | implementations (in OO lingo virtual methods) for
413 * | the actual DB implementations as well as a bunch of
414 * | query utility functions.
416 * +-DB_mysql The DB implementation for MySQL. Inherits DB_common.
417 * When calling DB::factory or DB::connect for MySQL
418 * connections, the object returned is an instance of this
424 * @author Stig Bakken <ssb@php.net>
425 * @author Tomas V.V.Cox <cox@idecnet.com>
426 * @author Daniel Convissor <danielc@php.net>
427 * @copyright 1997-2007 The PHP Group
428 * @license http://www.php.net/license/3_0.txt PHP License 3.0
429 * @version Release: 1.9.2
430 * @link http://pear.php.net/package/DB
437 * Create a new DB object for the specified database type but don't
438 * connect to the database
440 * @param string $type the database type (eg "mysql")
441 * @param array $options an associative array of option names and values
443 * @return object a new DB object. A DB_Error object on failure.
445 * @see DB_common::setOption()
447 public static function factory($type, $options = [])
449 if (!is_array($options)) {
450 $options = array('persistent' => $options);
453 if (isset($options['debug']) && $options['debug'] >= 2) {
454 // expose php errors with sufficient debug level
455 include_once "DB/{$type}.php";
457 @include_once "DB/{$type}.php";
460 $classname = "DB_${type}";
462 if (!class_exists($classname)) {
463 $tmp = PEAR::raiseError(null, DB_ERROR_NOT_FOUND, null, null,
464 "Unable to include the DB/{$type}.php"
465 . " file for '$dsn'",
470 @$obj = new $classname;
472 foreach ($options as $option => $value) {
473 $test = $obj->setOption($option, $value);
474 if (DB::isError($test)) {
486 * Determines if a variable is a DB_Error object
488 * @param mixed $value the variable to check
490 * @return bool whether $value is DB_Error object
492 public static function isError($value)
494 return is_object($value) && is_a($value, 'DB_Error');
501 * Create a new DB object including a connection to the specified database
505 * require_once 'DB.php';
507 * $dsn = 'pgsql://user:password@host/database';
510 * 'portability' => DB_PORTABILITY_ALL,
513 * $db = DB::connect($dsn, $options);
514 * if (PEAR::isError($db)) {
515 * die($db->getMessage());
519 * @param mixed $dsn the string "data source name" or array in the
520 * format returned by DB::parseDSN()
521 * @param array $options an associative array of option names and values
523 * @return object a new DB object. A DB_Error object on failure.
525 * @uses DB_dbase::connect(), DB_fbsql::connect(), DB_ibase::connect(),
526 * DB_ifx::connect(), DB_msql::connect(), DB_mssql::connect(),
527 * DB_mysql::connect(), DB_mysqli::connect(), DB_oci8::connect(),
528 * DB_odbc::connect(), DB_pgsql::connect(), DB_sqlite::connect(),
529 * DB_sybase::connect()
531 * @uses DB::parseDSN(), DB_common::setOption(), PEAR::isError()
533 public static function connect($dsn, $options = array())
535 $dsninfo = DB::parseDSN($dsn);
536 $type = $dsninfo['phptype'];
538 if (!is_array($options)) {
540 * For backwards compatibility. $options used to be boolean,
541 * indicating whether the connection should be persistent.
543 $options = array('persistent' => $options);
546 if (isset($options['debug']) && $options['debug'] >= 2) {
547 // expose php errors with sufficient debug level
548 include_once "DB/${type}.php";
550 @include_once "DB/${type}.php";
553 $classname = "DB_${type}";
554 if (!class_exists($classname)) {
555 $tmp = PEAR::raiseError(null, DB_ERROR_NOT_FOUND, null, null,
556 "Unable to include the DB/{$type}.php"
558 . DB::getDSNString($dsn, true) . "'",
563 @$obj = new $classname;
565 foreach ($options as $option => $value) {
566 $test = $obj->setOption($option, $value);
567 if (DB::isError($test)) {
572 $err = $obj->connect($dsninfo, $obj->getOption('persistent'));
573 if (DB::isError($err)) {
574 if (is_array($dsn)) {
575 $err->addUserInfo(DB::getDSNString($dsn, true));
577 $err->addUserInfo($dsn);
589 * Parse a data source name
591 * Additional keys can be added by appending a URI query string to the
594 * The format of the supplied DSN is in its fullest form:
596 * phptype(dbsyntax)://username:password@protocol+hostspec/database?option=8&another=true
599 * Most variations are allowed:
601 * phptype://username:password@protocol+hostspec:110//usr/db_file.db?mode=0644
602 * phptype://username:password@hostspec/database_name
603 * phptype://username:password@hostspec
604 * phptype://username@hostspec
605 * phptype://hostspec/database
611 * @param string $dsn Data Source Name to be parsed
613 * @return array an associative array with the following keys:
614 * + phptype: Database backend used in PHP (mysql, odbc etc.)
615 * + dbsyntax: Database used with regards to SQL syntax etc.
616 * + protocol: Communication protocol to use (tcp, unix etc.)
617 * + hostspec: Host specification (hostname[:port])
618 * + database: Database to use on the DBMS server
619 * + username: User name for login
620 * + password: Password for login
622 public static function parseDSN($dsn)
636 if (is_array($dsn)) {
637 $dsn = array_merge($parsed, $dsn);
638 if (!$dsn['dbsyntax']) {
639 $dsn['dbsyntax'] = $dsn['phptype'];
644 // Find phptype and dbsyntax
645 if (($pos = strpos($dsn, '://')) !== false) {
646 $str = substr($dsn, 0, $pos);
647 $dsn = substr($dsn, $pos + 3);
653 // Get phptype and dbsyntax
654 // $str => phptype(dbsyntax)
655 if (preg_match('|^(.+?)\((.*?)\)$|', $str, $arr)) {
656 $parsed['phptype'] = $arr[1];
657 $parsed['dbsyntax'] = !$arr[2] ? $arr[1] : $arr[2];
659 $parsed['phptype'] = $str;
660 $parsed['dbsyntax'] = $str;
667 // Get (if found): username and password
668 // $dsn => username:password@protocol+hostspec/database
669 if (($at = strrpos($dsn, '@')) !== false) {
670 $str = substr($dsn, 0, $at);
671 $dsn = substr($dsn, $at + 1);
672 if (($pos = strpos($str, ':')) !== false) {
673 $parsed['username'] = rawurldecode(substr($str, 0, $pos));
674 $parsed['password'] = rawurldecode(substr($str, $pos + 1));
676 $parsed['username'] = rawurldecode($str);
680 // Find protocol and hostspec
682 if (preg_match('|^([^(]+)\((.*?)\)/?(.*?)$|', $dsn, $match)) {
683 // $dsn => proto(proto_opts)/database
685 $proto_opts = $match[2] ? $match[2] : false;
689 // $dsn => protocol+hostspec/database (old format)
690 if (strpos($dsn, '+') !== false) {
691 list($proto, $dsn) = explode('+', $dsn, 2);
693 if (strpos($dsn, '/') !== false) {
694 list($proto_opts, $dsn) = explode('/', $dsn, 2);
701 // process the different protocol options
702 $parsed['protocol'] = (!empty($proto)) ? $proto : 'tcp';
703 $proto_opts = rawurldecode($proto_opts);
704 if (strpos($proto_opts, ':') !== false) {
705 list($proto_opts, $parsed['port']) = explode(':', $proto_opts);
707 if ($parsed['protocol'] == 'tcp') {
708 $parsed['hostspec'] = $proto_opts;
709 } elseif ($parsed['protocol'] == 'unix') {
710 $parsed['socket'] = $proto_opts;
716 if (($pos = strpos($dsn, '?')) === false) {
718 $parsed['database'] = rawurldecode($dsn);
720 // /database?param1=value1¶m2=value2
721 $parsed['database'] = rawurldecode(substr($dsn, 0, $pos));
722 $dsn = substr($dsn, $pos + 1);
723 if (strpos($dsn, '&') !== false) {
724 $opts = explode('&', $dsn);
725 } else { // database?param1=value1
728 foreach ($opts as $opt) {
729 list($key, $value) = explode('=', $opt);
730 if (!isset($parsed[$key])) {
731 // don't allow params overwrite
732 $parsed[$key] = rawurldecode($value);
742 // {{{ isConnection()
745 * Returns the given DSN in a string format suitable for output.
747 * @param array|string the DSN to parse and format
748 * @param boolean true to hide the password, false to include it
751 public static function getDSNString($dsn, $hidePassword)
753 /* Calling parseDSN will ensure that we have all the array elements
754 * defined, and means that we deal with strings and array in the same
756 $dsnArray = DB::parseDSN($dsn);
759 $dsnArray['password'] = 'PASSWORD';
762 /* Protocol is special-cased, as using the default "tcp" along with an
763 * Oracle TNS connection string fails. */
764 if (is_string($dsn) && strpos($dsn, 'tcp') === false && $dsnArray['protocol'] == 'tcp') {
765 $dsnArray['protocol'] = false;
768 // Now we just have to construct the actual string. This is ugly.
769 $dsnString = $dsnArray['phptype'];
770 if ($dsnArray['dbsyntax']) {
771 $dsnString .= '(' . $dsnArray['dbsyntax'] . ')';
774 . $dsnArray['username']
776 . $dsnArray['password']
778 . $dsnArray['protocol'];
779 if ($dsnArray['socket']) {
780 $dsnString .= '(' . $dsnArray['socket'] . ')';
782 if ($dsnArray['protocol'] && $dsnArray['hostspec']) {
785 $dsnString .= $dsnArray['hostspec'];
786 if ($dsnArray['port']) {
787 $dsnString .= ':' . $dsnArray['port'];
789 $dsnString .= '/' . $dsnArray['database'];
791 /* Option handling. Unfortunately, parseDSN simply places options into
792 * the top-level array, so we'll first get rid of the fields defined by
793 * DB and see what's left. */
794 unset($dsnArray['phptype'],
795 $dsnArray['dbsyntax'],
796 $dsnArray['username'],
797 $dsnArray['password'],
798 $dsnArray['protocol'],
800 $dsnArray['hostspec'],
802 $dsnArray['database']
804 if (count($dsnArray) > 0) {
807 foreach ($dsnArray as $key => $value) {
811 $dsnString .= $key . '=' . $value;
822 * Determines if a value is a DB_<driver> object
824 * @param mixed $value the value to test
826 * @return bool whether $value is a DB_<driver> object
828 public static function isConnection($value)
830 return (is_object($value) &&
831 is_subclass_of($value, 'db_common') &&
832 method_exists($value, 'simpleQuery'));
836 // {{{ errorMessage()
839 * Tell whether a query is a data manipulation or data definition query
841 * Examples of data manipulation queries are INSERT, UPDATE and DELETE.
842 * Examples of data definition queries are CREATE, DROP, ALTER, GRANT,
845 * @param string $query the query
847 * @return boolean whether $query is a data manipulation query
849 public static function isManip($query)
851 $manips = 'INSERT|UPDATE|DELETE|REPLACE|'
853 . 'LOAD DATA|SELECT .* INTO .* FROM|COPY|'
854 . 'ALTER|GRANT|REVOKE|'
856 if (preg_match('/^\s*"?(' . $manips . ')\s+/i', $query)) {
866 * Return a textual error message for a DB error code
868 * @param integer $value the DB error code
870 * @return string the error message or false if the error code was
873 public static function errorMessage($value)
875 static $errorMessages;
876 if (!isset($errorMessages)) {
877 $errorMessages = array(
878 DB_ERROR => 'unknown error',
879 DB_ERROR_ACCESS_VIOLATION => 'insufficient permissions',
880 DB_ERROR_ALREADY_EXISTS => 'already exists',
881 DB_ERROR_CANNOT_CREATE => 'can not create',
882 DB_ERROR_CANNOT_DROP => 'can not drop',
883 DB_ERROR_CONNECT_FAILED => 'connect failed',
884 DB_ERROR_CONSTRAINT => 'constraint violation',
885 DB_ERROR_CONSTRAINT_NOT_NULL => 'null value violates not-null constraint',
886 DB_ERROR_DIVZERO => 'division by zero',
887 DB_ERROR_EXTENSION_NOT_FOUND => 'extension not found',
888 DB_ERROR_INVALID => 'invalid',
889 DB_ERROR_INVALID_DATE => 'invalid date or time',
890 DB_ERROR_INVALID_DSN => 'invalid DSN',
891 DB_ERROR_INVALID_NUMBER => 'invalid number',
892 DB_ERROR_MISMATCH => 'mismatch',
893 DB_ERROR_NEED_MORE_DATA => 'insufficient data supplied',
894 DB_ERROR_NODBSELECTED => 'no database selected',
895 DB_ERROR_NOSUCHDB => 'no such database',
896 DB_ERROR_NOSUCHFIELD => 'no such field',
897 DB_ERROR_NOSUCHTABLE => 'no such table',
898 DB_ERROR_NOT_CAPABLE => 'DB backend not capable',
899 DB_ERROR_NOT_FOUND => 'not found',
900 DB_ERROR_NOT_LOCKED => 'not locked',
901 DB_ERROR_SYNTAX => 'syntax error',
902 DB_ERROR_UNSUPPORTED => 'not supported',
903 DB_ERROR_TRUNCATED => 'truncated',
904 DB_ERROR_VALUE_COUNT_ON_ROW => 'value count on row',
909 if (DB::isError($value)) {
910 $value = $value->getCode();
913 return isset($errorMessages[$value]) ? $errorMessages[$value]
914 : $errorMessages[DB_ERROR];
918 // {{{ getDSNString()
921 * Return the DB API version
923 * @return string the DB API version number
925 function apiVersion()
934 // {{{ class DB_Error
937 * DB_Error implements a class for reporting portable database error
942 * @author Stig Bakken <ssb@php.net>
943 * @copyright 1997-2007 The PHP Group
944 * @license http://www.php.net/license/3_0.txt PHP License 3.0
945 * @version Release: 1.9.2
946 * @link http://pear.php.net/package/DB
948 class DB_Error extends PEAR_Error
953 * DB_Error constructor
955 * @param mixed $code DB error code, or string with error message
956 * @param int $mode what "error mode" to operate in
957 * @param int $level what error level to use for $mode &
959 * @param mixed $debuginfo additional debug info, such as the last query
963 function __construct($code = DB_ERROR, $mode = PEAR_ERROR_RETURN,
964 $level = E_USER_NOTICE, $debuginfo = null)
967 parent::__construct('DB Error: ' . DB::errorMessage($code), $code,
968 $mode, $level, $debuginfo);
970 parent::__construct("DB Error: $code", DB_ERROR,
971 $mode, $level, $debuginfo);
976 * Workaround to both avoid the "Redefining already defined constructor"
977 * PHP error and provide backward compatibility in case someone is calling
978 * DB_Error() dynamically
983 public function __call($method, $arguments)
985 if ($method == 'DB_Error') {
986 return call_user_func_array(array($this, '__construct'), $arguments);
989 'Call to undefined method DB_Error::' . $method . '()', E_USER_ERROR
997 // {{{ class DB_result
1000 * This class implements a wrapper for a DB result set
1002 * A new instance of this class will be returned by the DB implementation
1003 * after processing a query that returns data.
1005 * @category Database
1007 * @author Stig Bakken <ssb@php.net>
1008 * @copyright 1997-2007 The PHP Group
1009 * @license http://www.php.net/license/3_0.txt PHP License 3.0
1010 * @version Release: 1.9.2
1011 * @link http://pear.php.net/package/DB
1018 * Should results be freed automatically when there are no more rows?
1020 * @see DB_common::$options
1025 * A reference to the DB_<driver> object
1031 * The current default fetch mode
1033 * @see DB_common::$fetchmode
1038 * The name of the class into which results should be fetched when
1039 * DB_FETCHMODE_OBJECT is in effect
1042 * @see DB_common::$fetchmode_object_class
1044 var $fetchmode_object_class;
1047 * The number of rows to fetch from a limit query
1050 var $limit_count = null;
1053 * The row to start fetching from in limit queries
1056 var $limit_from = null;
1059 * The execute parameters that created this result
1061 * @since Property available since Release 1.7.0
1066 * The query string that created this result
1068 * Copied here incase it changes in $dbh, which is referenced
1071 * @since Property available since Release 1.7.0
1076 * The query result resource id created by PHP
1082 * The present row being dealt with
1085 var $row_counter = null;
1088 * The prepared statement resource id created by PHP in $dbh
1090 * This resource is only available when the result set was created using
1091 * a driver's native execute() method, not PEAR DB's emulated one.
1093 * Copied here incase it changes in $dbh, which is referenced
1095 * {@internal Mainly here because the InterBase/Firebird API is only
1096 * able to retrieve data from result sets if the statemnt handle is
1100 * @since Property available since Release 1.7.0
1109 * This constructor sets the object's properties
1111 * @param object &$dbh the DB object reference
1112 * @param resource $result the result resource id
1113 * @param array $options an associative array with result options
1117 function __construct(&$dbh, $result, $options = array())
1119 $this->autofree = $dbh->options['autofree'];
1121 $this->fetchmode = $dbh->fetchmode;
1122 $this->fetchmode_object_class = $dbh->fetchmode_object_class;
1123 $this->parameters = $dbh->last_parameters;
1124 $this->query = $dbh->last_query;
1125 $this->result = $result;
1126 $this->statement = empty($dbh->last_stmt) ? null : $dbh->last_stmt;
1127 foreach ($options as $key => $value) {
1128 $this->setOption($key, $value);
1133 * Set options for the DB_result object
1135 * @param string $key the option to set
1136 * @param mixed $value the value to set the option to
1140 function setOption($key, $value = null)
1144 $this->limit_from = $value;
1147 $this->limit_count = $value;
1155 * Fetch a row of data and return it by reference into an array
1157 * The type of array returned can be controlled either by setting this
1158 * method's <var>$fetchmode</var> parameter or by changing the default
1159 * fetch mode setFetchMode() before calling this method.
1161 * There are two options for standardizing the information returned
1162 * from databases, ensuring their values are consistent when changing
1163 * DBMS's. These portability options can be turned on when creating a
1164 * new DB object or by using setOption().
1166 * + <var>DB_PORTABILITY_LOWERCASE</var>
1167 * convert names of fields to lower case
1169 * + <var>DB_PORTABILITY_RTRIM</var>
1170 * right trim the data
1172 * @param int $fetchmode the constant indicating how to format the data
1173 * @param int $rownum the row number to fetch (index starts at 0)
1175 * @return mixed an array or object containing the row's data,
1176 * NULL when the end of the result set is reached
1177 * or a DB_Error object on failure.
1179 * @see DB_common::setOption(), DB_common::setFetchMode()
1181 function &fetchRow($fetchmode = DB_FETCHMODE_DEFAULT, $rownum = null)
1183 if ($fetchmode === DB_FETCHMODE_DEFAULT) {
1184 $fetchmode = $this->fetchmode;
1186 if ($fetchmode === DB_FETCHMODE_OBJECT) {
1187 $fetchmode = DB_FETCHMODE_ASSOC;
1188 $object_class = $this->fetchmode_object_class;
1190 if (is_null($rownum) && $this->limit_from !== null) {
1191 if ($this->row_counter === null) {
1192 $this->row_counter = $this->limit_from;
1194 if ($this->dbh->features['limit'] === false) {
1196 while ($i++ < $this->limit_from) {
1197 $this->dbh->fetchInto($this->result, $arr, $fetchmode);
1201 if ($this->row_counter >= ($this->limit_from + $this->limit_count)) {
1202 if ($this->autofree) {
1208 if ($this->dbh->features['limit'] === 'emulate') {
1209 $rownum = $this->row_counter;
1211 $this->row_counter++;
1213 $res = $this->dbh->fetchInto($this->result, $arr, $fetchmode, $rownum);
1214 if ($res === DB_OK) {
1215 if (isset($object_class)) {
1216 // The default mode is specified in the
1217 // DB_common::fetchmode_object_class property
1218 if ($object_class == 'stdClass') {
1219 $arr = (object)$arr;
1221 $arr = new $object_class($arr);
1226 if ($res == null && $this->autofree) {
1236 * Frees the resources allocated for this result set
1238 * @return bool true on success. A DB_Error object on failure.
1242 $err = $this->dbh->freeResult($this->result);
1243 if (DB::isError($err)) {
1246 $this->result = false;
1247 $this->statement = false;
1255 * Fetch a row of data into an array which is passed by reference
1257 * The type of array returned can be controlled either by setting this
1258 * method's <var>$fetchmode</var> parameter or by changing the default
1259 * fetch mode setFetchMode() before calling this method.
1261 * There are two options for standardizing the information returned
1262 * from databases, ensuring their values are consistent when changing
1263 * DBMS's. These portability options can be turned on when creating a
1264 * new DB object or by using setOption().
1266 * + <var>DB_PORTABILITY_LOWERCASE</var>
1267 * convert names of fields to lower case
1269 * + <var>DB_PORTABILITY_RTRIM</var>
1270 * right trim the data
1272 * @param array &$arr the variable where the data should be placed
1273 * @param int $fetchmode the constant indicating how to format the data
1274 * @param int $rownum the row number to fetch (index starts at 0)
1276 * @return mixed DB_OK if a row is processed, NULL when the end of the
1277 * result set is reached or a DB_Error object on failure
1279 * @see DB_common::setOption(), DB_common::setFetchMode()
1281 function fetchInto(&$arr, $fetchmode = DB_FETCHMODE_DEFAULT, $rownum = null)
1283 if ($fetchmode === DB_FETCHMODE_DEFAULT) {
1284 $fetchmode = $this->fetchmode;
1286 if ($fetchmode === DB_FETCHMODE_OBJECT) {
1287 $fetchmode = DB_FETCHMODE_ASSOC;
1288 $object_class = $this->fetchmode_object_class;
1290 if (is_null($rownum) && $this->limit_from !== null) {
1291 if ($this->row_counter === null) {
1292 $this->row_counter = $this->limit_from;
1294 if ($this->dbh->features['limit'] === false) {
1296 while ($i++ < $this->limit_from) {
1297 $this->dbh->fetchInto($this->result, $arr, $fetchmode);
1301 if ($this->row_counter >= (
1302 $this->limit_from + $this->limit_count)) {
1303 if ($this->autofree) {
1308 if ($this->dbh->features['limit'] === 'emulate') {
1309 $rownum = $this->row_counter;
1312 $this->row_counter++;
1314 $res = $this->dbh->fetchInto($this->result, $arr, $fetchmode, $rownum);
1315 if ($res === DB_OK) {
1316 if (isset($object_class)) {
1317 // default mode specified in the
1318 // DB_common::fetchmode_object_class property
1319 if ($object_class == 'stdClass') {
1320 $arr = (object)$arr;
1322 $arr = new $object_class($arr);
1327 if ($res == null && $this->autofree) {
1337 * Get the the number of columns in a result set
1339 * @return int the number of columns. A DB_Error object on failure.
1343 return $this->dbh->numCols($this->result);
1350 * Get the number of rows in a result set
1352 * @return int the number of rows. A DB_Error object on failure.
1356 if ($this->dbh->features['numrows'] === 'emulate'
1357 && $this->dbh->options['portability'] & DB_PORTABILITY_NUMROWS) {
1358 if ($this->dbh->features['prepare']) {
1359 $res = $this->dbh->query($this->query, $this->parameters);
1361 $res = $this->dbh->query($this->query);
1363 if (DB::isError($res)) {
1367 while ($res->fetchInto($tmp, DB_FETCHMODE_ORDERED)) {
1372 $count = $this->dbh->numRows($this->result);
1375 /* fbsql is checked for here because limit queries are implemented
1376 * using a TOP() function, which results in fbsql_num_rows still
1377 * returning the total number of rows that would have been returned,
1378 * rather than the real number. As a result, we'll just do the limit
1379 * calculations for fbsql in the same way as a database with emulated
1380 * limits. Unfortunately, we can't just do this in DB_fbsql::numRows()
1381 * because that only gets the result resource, rather than the full
1382 * DB_Result object. */
1383 if (($this->dbh->features['limit'] === 'emulate'
1384 && $this->limit_from !== null)
1385 || $this->dbh->phptype == 'fbsql') {
1386 $limit_count = is_null($this->limit_count) ? $count : $this->limit_count;
1387 if ($count < $this->limit_from) {
1389 } elseif ($count < ($this->limit_from + $limit_count)) {
1390 $count -= $this->limit_from;
1392 $count = $limit_count;
1403 * Get the next result if a batch of queries was executed
1405 * @return bool true if a new result is available or false if not
1407 function nextResult()
1409 return $this->dbh->nextResult($this->result);
1418 * @see DB_common::tableInfo()
1419 * @deprecated Method deprecated some time before Release 1.2
1421 function tableInfo($mode = null)
1423 if (is_string($mode)) {
1424 return $this->dbh->raiseError(DB_ERROR_NEED_MORE_DATA);
1426 return $this->dbh->tableInfo($this, $mode);
1433 * Determine the query string that created this result
1435 * @return string the query string
1437 * @since Method available since Release 1.7.0
1441 return $this->query;
1445 // {{{ getRowCounter()
1448 * Tells which row number is currently being processed
1450 * @return integer the current row being looked at. Starts at 1.
1452 function getRowCounter()
1454 return $this->row_counter;
1464 * PEAR DB Row Object
1466 * The object contains a row of data from a result set. Each column's data
1467 * is placed in a property named for the column.
1469 * @category Database
1471 * @author Stig Bakken <ssb@php.net>
1472 * @copyright 1997-2007 The PHP Group
1473 * @license http://www.php.net/license/3_0.txt PHP License 3.0
1474 * @version Release: 1.9.2
1475 * @link http://pear.php.net/package/DB
1476 * @see DB_common::setFetchMode()
1483 * The constructor places a row's data into properties of this object
1485 * @param array the array containing the row's data
1489 function __construct(&$arr)
1491 foreach ($arr as $key => $value) {
1492 $this->$key = &$arr[$key];