3 * @version V4.22 15 Apr 2004 (c) 2000-2004 John Lim (jlim@natsoft.com.my). All rights reserved.
4 * Released under both BSD license and Lesser GPL library license.
5 * Whenever there is any discrepancy between the two licenses,
6 * the BSD license will take precedence.
8 * Set tabs to 4 for best viewing.
10 * PEAR DB Emulation Layer for ADODB.
12 * The following code is modelled on PEAR DB code by Stig Bakken <ssb@fast.no> |
13 * and Tomas V.V.Cox <cox@idecnet.com>. Portions (c)1997-2002 The PHP Group.
21 query - returns PEAR_Error on error
22 limitQuery - return PEAR_Error on error
23 prepare - does not return PEAR_Error on error
24 execute - does not return PEAR_Error on error
25 setFetchMode - supports ASSOC and ORDERED
33 numRows - returns -1 if not supported
35 fetchInto - does not support passing of fetchmode
36 fetchRows - does not support passing of fetchmode
40 define('ADODB_PEAR',dirname(__FILE__));
41 include_once "PEAR.php";
42 include_once ADODB_PEAR."/adodb-errorpear.inc.php";
43 include_once ADODB_PEAR."/adodb.inc.php";
45 if (!defined('DB_OK')) {
47 define("DB_ERROR",-1);
49 * This is a special constant that tells DB the user hasn't specified
50 * any particular get mode, so the default should be used.
53 define('DB_FETCHMODE_DEFAULT', 0);
56 * Column data indexed by numbers, ordered from 0 and up
59 define('DB_FETCHMODE_ORDERED', 1);
62 * Column data indexed by column names
65 define('DB_FETCHMODE_ASSOC', 2);
67 /* for compatibility */
69 define('DB_GETMODE_ORDERED', DB_FETCHMODE_ORDERED);
70 define('DB_GETMODE_ASSOC', DB_FETCHMODE_ASSOC);
73 * these are constants for the tableInfo-function
74 * they are bitwised or'ed. so if there are more constants to be defined
75 * in the future, adjust DB_TABLEINFO_FULL accordingly
78 define('DB_TABLEINFO_ORDER', 1);
79 define('DB_TABLEINFO_ORDERTABLE', 2);
80 define('DB_TABLEINFO_FULL', 3);
84 * The main "DB" class is simply a container class with some static
85 * methods for creating DB objects as well as some utility functions
86 * common to all parts of DB.
93 * Create a new DB object for the specified database type
95 * @param $type string database type, for example "mysql"
97 * @return object a newly created DB object, or a DB error code on
101 function &factory($type)
103 include_once(ADODB_DIR."/drivers/adodb-$type.inc.php");
104 $obj = &NewADOConnection($type);
105 if (!is_object($obj)) $obj =& new PEAR_Error('Unknown Database Driver: '.$dsninfo['phptype'],-1);
110 * Create a new DB object and connect to the specified database
112 * @param $dsn mixed "data source name", see the DB::parseDSN
113 * method for a description of the dsn format. Can also be
114 * specified as an array of the format returned by DB::parseDSN.
116 * @param $options mixed if boolean (or scalar), tells whether
117 * this connection should be persistent (for backends that support
118 * this). This parameter can also be an array of options, see
119 * DB_common::setOption for more information on connection
122 * @return object a newly created DB connection object, or a DB
123 * error object on error
128 function &connect($dsn, $options = false)
130 if (is_array($dsn)) {
133 $dsninfo = DB::parseDSN($dsn);
135 switch ($dsninfo["phptype"]) {
136 case 'pgsql': $type = 'postgres7'; break;
137 case 'ifx': $type = 'informix9'; break;
138 default: $type = $dsninfo["phptype"]; break;
141 if (is_array($options) && isset($options["debug"]) &&
142 $options["debug"] >= 2) {
143 // expose php errors with sufficient debug level
144 @include_once("adodb-$type.inc.php");
146 @include_once("adodb-$type.inc.php");
149 @$obj =& NewADOConnection($type);
150 if (!is_object($obj)) {
151 $obj =& new PEAR_Error('Unknown Database Driver: '.$dsninfo['phptype'],-1);
154 if (is_array($options)) {
155 foreach($options as $k => $v) {
156 switch(strtolower($k)) {
157 case 'persistent': $persist = $v; break;
159 case 'dialect': $obj->dialect = $v; break;
160 case 'charset': $obj->charset = $v; break;
161 case 'buffers': $obj->buffers = $v; break;
163 case 'charpage': $obj->charPage = $v; break;
165 case 'clientflags': $obj->clientFlags = $v; break;
172 if (isset($dsninfo['socket'])) $dsninfo['hostspec'] .= ':'.$dsninfo['socket'];
173 else if (isset($dsninfo['port'])) $dsninfo['hostspec'] .= ':'.$dsninfo['port'];
175 if($persist) $ok = $obj->PConnect($dsninfo['hostspec'], $dsninfo['username'],$dsninfo['password'],$dsninfo['database']);
176 else $ok = $obj->Connect($dsninfo['hostspec'], $dsninfo['username'],$dsninfo['password'],$dsninfo['database']);
178 if (!$ok) $obj = ADODB_PEAR_Error();
183 * Return the DB API version
185 * @return int the DB API version number
187 function apiVersion()
193 * Tell whether a result code from a DB method is an error
195 * @param $value int result code
197 * @return bool whether $value is an error
199 function isError($value)
201 return (is_object($value) &&
202 (strtolower(get_class($value)) == 'db_error' ||
203 is_subclass_of($value, 'db_error')));
207 * Tell whether a result code from a DB method is a warning.
208 * Warnings differ from errors in that they are generated by DB,
211 * @param $value mixed result value
213 * @return bool whether $value is a warning
215 function isWarning($value)
217 return is_object($value) &&
218 (strtolower(get_class( $value )) == "db_warning" ||
219 is_subclass_of($value, "db_warning"));
223 * Parse a data source name
225 * @param $dsn string Data Source Name to be parsed
227 * @return array an associative array with the following keys:
229 * phptype: Database backend used in PHP (mysql, odbc etc.)
230 * dbsyntax: Database used with regards to SQL syntax etc.
231 * protocol: Communication protocol to use (tcp, unix etc.)
232 * hostspec: Host specification (hostname[:port])
233 * database: Database to use on the DBMS server
234 * username: User name for login
235 * password: Password for login
237 * The format of the supplied DSN is in its fullest form:
239 * phptype(dbsyntax)://username:password@protocol+hostspec/database
241 * Most variations are allowed:
243 * phptype://username:password@protocol+hostspec:110//usr/db_file.db
244 * phptype://username:password@hostspec/database_name
245 * phptype://username:password@hostspec
246 * phptype://username@hostspec
247 * phptype://hostspec/database
252 * @author Tomas V.V.Cox <cox@idecnet.com>
254 function parseDSN($dsn)
256 if (is_array($dsn)) {
270 // Find phptype and dbsyntax
271 if (($pos = strpos($dsn, '://')) !== false) {
272 $str = substr($dsn, 0, $pos);
273 $dsn = substr($dsn, $pos + 3);
279 // Get phptype and dbsyntax
280 // $str => phptype(dbsyntax)
281 if (preg_match('|^(.+?)\((.*?)\)$|', $str, $arr)) {
282 $parsed['phptype'] = $arr[1];
283 $parsed['dbsyntax'] = (empty($arr[2])) ? $arr[1] : $arr[2];
285 $parsed['phptype'] = $str;
286 $parsed['dbsyntax'] = $str;
293 // Get (if found): username and password
294 // $dsn => username:password@protocol+hostspec/database
295 if (($at = strpos($dsn,'@')) !== false) {
296 $str = substr($dsn, 0, $at);
297 $dsn = substr($dsn, $at + 1);
298 if (($pos = strpos($str, ':')) !== false) {
299 $parsed['username'] = urldecode(substr($str, 0, $pos));
300 $parsed['password'] = urldecode(substr($str, $pos + 1));
302 $parsed['username'] = urldecode($str);
306 // Find protocol and hostspec
307 // $dsn => protocol+hostspec/database
308 if (($pos=strpos($dsn, '/')) !== false) {
309 $str = substr($dsn, 0, $pos);
310 $dsn = substr($dsn, $pos + 1);
316 // Get protocol + hostspec
317 // $str => protocol+hostspec
318 if (($pos=strpos($str, '+')) !== false) {
319 $parsed['protocol'] = substr($str, 0, $pos);
320 $parsed['hostspec'] = urldecode(substr($str, $pos + 1));
322 $parsed['hostspec'] = urldecode($str);
328 $parsed['database'] = $dsn;
335 * Load a PHP database extension if it is not loaded already.
339 * @param $name the base name of the extension (without the .so or
342 * @return bool true if the extension was already or successfully
343 * loaded, false if it could not be loaded
345 function assertExtension($name)
347 if (!extension_loaded($name)) {
348 $dlext = (strncmp(PHP_OS,'WIN',3) === 0) ? '.dll' : '.so';
351 if (!extension_loaded($name)) {