Context Navigation

source: branches/dev/data/module/MDB2.php @ 15946

Visit:

Revision 15946, 137.2 KB checked in by kakinaka, 19 years ago (diff)

Line
1	<?php
2	// vim: set et ts=4 sw=4 fdm=marker:
3	// +----------------------------------------------------------------------+
4	// \| PHP versions 4 and 5 \|
5	// +----------------------------------------------------------------------+
6	// \| Copyright (c) 1998-2007 Manuel Lemos, Tomas V.V.Cox, \|
7	// \| Stig. S. Bakken, Lukas Smith \|
8	// \| All rights reserved. \|
9	// +----------------------------------------------------------------------+
10	// \| MDB2 is a merge of PEAR DB and Metabases that provides a unified DB \|
11	// \| API as well as database abstraction for PHP applications. \|
12	// \| This LICENSE is in the BSD license style. \|
13	// \| \|
14	// \| Redistribution and use in source and binary forms, with or without \|
15	// \| modification, are permitted provided that the following conditions \|
16	// \| are met: \|
17	// \| \|
18	// \| Redistributions of source code must retain the above copyright \|
19	// \| notice, this list of conditions and the following disclaimer. \|
20	// \| \|
21	// \| Redistributions in binary form must reproduce the above copyright \|
22	// \| notice, this list of conditions and the following disclaimer in the \|
23	// \| documentation and/or other materials provided with the distribution. \|
24	// \| \|
25	// \| Neither the name of Manuel Lemos, Tomas V.V.Cox, Stig. S. Bakken, \|
26	// \| Lukas Smith nor the names of his contributors may be used to endorse \|
27	// \| or promote products derived from this software without specific prior\|
28	// \| written permission. \|
29	// \| \|
30	// \| THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \|
31	// \| "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT \|
32	// \| LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS \|
33	// \| FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE \|
34	// \| REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, \|
35	// \| INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, \|
36	// \| BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS\|
37	// \| OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED \|
38	// \| AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT \|
39	// \| LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY\|
40	// \| WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE \|
41	// \| POSSIBILITY OF SUCH DAMAGE. \|
42	// +----------------------------------------------------------------------+
43	// \| Author: Lukas Smith <[email protected]> \|
44	// +----------------------------------------------------------------------+
45	//
46	// $Id: MDB2.php,v 1.292 2007/04/25 09:31:01 quipo Exp $
47	//
48
49	/**
50	* @package MDB2
51	* @category Database
52	* @author Lukas Smith <[email protected]>
53	*/
54
55	if(!defined('MDB2_PHP_DIR')) {
56	$MDB2_PHP_DIR = realpath(dirname( __FILE__));
57	define("MDB2_PHP_DIR", $MDB2_PHP_DIR);
58	}
59
60	require_once MDB2_PHP_DIR . '/PEAR.php';
61
62	// {{{ Error constants
63
64	/**
65	* The method mapErrorCode in each MDB2_dbtype implementation maps
66	* native error codes to one of these.
67	*
68	* If you add an error code here, make sure you also add a textual
69	* version of it in MDB2::errorMessage().
70	*/
71
72	define('MDB2_OK', true);
73	define('MDB2_ERROR', -1);
74	define('MDB2_ERROR_SYNTAX', -2);
75	define('MDB2_ERROR_CONSTRAINT', -3);
76	define('MDB2_ERROR_NOT_FOUND', -4);
77	define('MDB2_ERROR_ALREADY_EXISTS', -5);
78	define('MDB2_ERROR_UNSUPPORTED', -6);
79	define('MDB2_ERROR_MISMATCH', -7);
80	define('MDB2_ERROR_INVALID', -8);
81	define('MDB2_ERROR_NOT_CAPABLE', -9);
82	define('MDB2_ERROR_TRUNCATED', -10);
83	define('MDB2_ERROR_INVALID_NUMBER', -11);
84	define('MDB2_ERROR_INVALID_DATE', -12);
85	define('MDB2_ERROR_DIVZERO', -13);
86	define('MDB2_ERROR_NODBSELECTED', -14);
87	define('MDB2_ERROR_CANNOT_CREATE', -15);
88	define('MDB2_ERROR_CANNOT_DELETE', -16);
89	define('MDB2_ERROR_CANNOT_DROP', -17);
90	define('MDB2_ERROR_NOSUCHTABLE', -18);
91	define('MDB2_ERROR_NOSUCHFIELD', -19);
92	define('MDB2_ERROR_NEED_MORE_DATA', -20);
93	define('MDB2_ERROR_NOT_LOCKED', -21);
94	define('MDB2_ERROR_VALUE_COUNT_ON_ROW', -22);
95	define('MDB2_ERROR_INVALID_DSN', -23);
96	define('MDB2_ERROR_CONNECT_FAILED', -24);
97	define('MDB2_ERROR_EXTENSION_NOT_FOUND',-25);
98	define('MDB2_ERROR_NOSUCHDB', -26);
99	define('MDB2_ERROR_ACCESS_VIOLATION', -27);
100	define('MDB2_ERROR_CANNOT_REPLACE', -28);
101	define('MDB2_ERROR_CONSTRAINT_NOT_NULL',-29);
102	define('MDB2_ERROR_DEADLOCK', -30);
103	define('MDB2_ERROR_CANNOT_ALTER', -31);
104	define('MDB2_ERROR_MANAGER', -32);
105	define('MDB2_ERROR_MANAGER_PARSE', -33);
106	define('MDB2_ERROR_LOADMODULE', -34);
107	define('MDB2_ERROR_INSUFFICIENT_DATA', -35);
108	// }}}
109	// {{{ Verbose constants
110	/**
111	* These are just helper constants to more verbosely express parameters to prepare()
112	*/
113
114	define('MDB2_PREPARE_MANIP', false);
115	define('MDB2_PREPARE_RESULT', null);
116
117	// }}}
118	// {{{ Fetchmode constants
119
120	/**
121	* This is a special constant that tells MDB2 the user hasn't specified
122	* any particular get mode, so the default should be used.
123	*/
124	define('MDB2_FETCHMODE_DEFAULT', 0);
125
126	/**
127	* Column data indexed by numbers, ordered from 0 and up
128	*/
129	define('MDB2_FETCHMODE_ORDERED', 1);
130
131	/**
132	* Column data indexed by column names
133	*/
134	define('MDB2_FETCHMODE_ASSOC', 2);
135
136	/**
137	* Column data as object properties
138	*/
139	define('MDB2_FETCHMODE_OBJECT', 3);
140
141	/**
142	* For multi-dimensional results: normally the first level of arrays
143	* is the row number, and the second level indexed by column number or name.
144	* MDB2_FETCHMODE_FLIPPED switches this order, so the first level of arrays
145	* is the column name, and the second level the row number.
146	*/
147	define('MDB2_FETCHMODE_FLIPPED', 4);
148
149	// }}}
150	// {{{ Portability mode constants
151
152	/**
153	* Portability: turn off all portability features.
154	* @see MDB2_Driver_Common::setOption()
155	*/
156	define('MDB2_PORTABILITY_NONE', 0);
157
158	/**
159	* Portability: convert names of tables and fields to case defined in the
160	* "field_case" option when using the query(), fetch() and tableInfo() methods.
161	* @see MDB2_Driver_Common::setOption()
162	*/
163	define('MDB2_PORTABILITY_FIX_CASE', 1);
164
165	/**
166	* Portability: right trim the data output by query() and fetch().
167	* @see MDB2_Driver_Common::setOption()
168	*/
169	define('MDB2_PORTABILITY_RTRIM', 2);
170
171	/**
172	* Portability: force reporting the number of rows deleted.
173	* @see MDB2_Driver_Common::setOption()
174	*/
175	define('MDB2_PORTABILITY_DELETE_COUNT', 4);
176
177	/**
178	* Portability: not needed in MDB2 (just left here for compatibility to DB)
179	* @see MDB2_Driver_Common::setOption()
180	*/
181	define('MDB2_PORTABILITY_NUMROWS', 8);
182
183	/**
184	* Portability: makes certain error messages in certain drivers compatible
185	* with those from other DBMS's.
186	*
187	* + mysql, mysqli: change unique/primary key constraints
188	* MDB2_ERROR_ALREADY_EXISTS -> MDB2_ERROR_CONSTRAINT
189	*
190	* + odbc(access): MS's ODBC driver reports 'no such field' as code
191	* 07001, which means 'too few parameters.' When this option is on
192	* that code gets mapped to MDB2_ERROR_NOSUCHFIELD.
193	*
194	* @see MDB2_Driver_Common::setOption()
195	*/
196	define('MDB2_PORTABILITY_ERRORS', 16);
197
198	/**
199	* Portability: convert empty values to null strings in data output by
200	* query() and fetch().
201	* @see MDB2_Driver_Common::setOption()
202	*/
203	define('MDB2_PORTABILITY_EMPTY_TO_NULL', 32);
204
205	/**
206	* Portability: removes database/table qualifiers from associative indexes
207	* @see MDB2_Driver_Common::setOption()
208	*/
209	define('MDB2_PORTABILITY_FIX_ASSOC_FIELD_NAMES', 64);
210
211	/**
212	* Portability: turn on all portability features.
213	* @see MDB2_Driver_Common::setOption()
214	*/
215	define('MDB2_PORTABILITY_ALL', 127);
216
217	// }}}
218	// {{{ Globals for class instance tracking
219
220	/**
221	* These are global variables that are used to track the various class instances
222	*/
223
224	$GLOBALS['_MDB2_databases'] = array();
225	$GLOBALS['_MDB2_dsninfo_default'] = array(
226	'phptype' => false,
227	'dbsyntax' => false,
228	'username' => false,
229	'password' => false,
230	'protocol' => false,
231	'hostspec' => false,
232	'port' => false,
233	'socket' => false,
234	'database' => false,
235	'mode' => false,
236	);
237
238	// }}}
239	// {{{ class MDB2
240
241	/**
242	* The main 'MDB2' class is simply a container class with some static
243	* methods for creating DB objects as well as some utility functions
244	* common to all parts of DB.
245	*
246	* The object model of MDB2 is as follows (indentation means inheritance):
247	*
248	* MDB2 The main MDB2 class. This is simply a utility class
249	* with some 'static' methods for creating MDB2 objects as
250	* well as common utility functions for other MDB2 classes.
251	*
252	* MDB2_Driver_Common The base for each MDB2 implementation. Provides default
253	* \| implementations (in OO lingo virtual methods) for
254	* \| the actual DB implementations as well as a bunch of
255	* \| query utility functions.
256	* \|
257	* +-MDB2_Driver_mysql The MDB2 implementation for MySQL. Inherits MDB2_Driver_Common.
258	* When calling MDB2::factory or MDB2::connect for MySQL
259	* connections, the object returned is an instance of this
260	* class.
261	* +-MDB2_Driver_pgsql The MDB2 implementation for PostGreSQL. Inherits MDB2_Driver_Common.
262	* When calling MDB2::factory or MDB2::connect for PostGreSQL
263	* connections, the object returned is an instance of this
264	* class.
265	*
266	* @package MDB2
267	* @category Database
268	* @author Lukas Smith <[email protected]>
269	*/
270	class MDB2
271	{
272	// {{{ function setOptions(&$db, $options)
273
274	/**
275	* set option array in an exiting database object
276	*
277	* @param MDB2_Driver_Common MDB2 object
278	* @param array An associative array of option names and their values.
279	*
280	* @return mixed MDB2_OK or a PEAR Error object
281	*
282	* @access public
283	*/
284	function setOptions(&$db, $options)
285	{
286	if (is_array($options)) {
287	foreach ($options as $option => $value) {
288	$test = $db->setOption($option, $value);
289	if (PEAR::isError($test)) {
290	return $test;
291	}
292	}
293	}
294	return MDB2_OK;
295	}
296
297	// }}}
298	// {{{ function classExists($classname)
299
300	/**
301	* Checks if a class exists without triggering __autoload
302	*
303	* @param string classname
304	*
305	* @return bool true success and false on error
306	* @static
307	* @access public
308	*/
309	function classExists($classname)
310	{
311	if (version_compare(phpversion(), "5.0", ">=")) {
312	return class_exists($classname, false);
313	}
314	return class_exists($classname);
315	}
316
317	// }}}
318	// {{{ function loadClass($class_name, $debug)
319
320	/**
321	* Loads a PEAR class.
322	*
323	* @param string classname to load
324	* @param bool if errors should be suppressed
325	*
326	* @return mixed true success or PEAR_Error on failure
327	*
328	* @access public
329	*/
330	function loadClass($class_name, $debug)
331	{
332	if (!MDB2::classExists($class_name)) {
333	$file_name = str_replace('_', DIRECTORY_SEPARATOR, $class_name).'.php';
334	if ($debug) {
335	$include = include_once($file_name);
336	} else {
337	$include = @include_once($file_name);
338	}
339	if (!$include) {
340	if (!MDB2::fileExists($file_name)) {
341	$msg = "unable to find package '$class_name' file '$file_name'";
342	} else {
343	$msg = "unable to load class '$class_name' from file '$file_name'";
344	}
345	$err =& MDB2::raiseError(MDB2_ERROR_NOT_FOUND, null, null, $msg);
346	return $err;
347	}
348	}
349	return MDB2_OK;
350	}
351
352	// }}}
353	// {{{ function &factory($dsn, $options = false)
354
355	/**
356	* Create a new MDB2 object for the specified database type
357	*
358	* IMPORTANT: In order for MDB2 to work properly it is necessary that
359	* you make sure that you work with a reference of the original
360	* object instead of a copy (this is a PHP4 quirk).
361	*
362	* For example:
363	* $db =& MDB2::factory($dsn);
364	* ^^
365	* And not:
366	* $db = MDB2::factory($dsn);
367	*
368	* @param mixed 'data source name', see the MDB2::parseDSN
369	* method for a description of the dsn format.
370	* Can also be specified as an array of the
371	* format returned by MDB2::parseDSN.
372	* @param array An associative array of option names and
373	* their values.
374	*
375	* @return mixed a newly created MDB2 object, or false on error
376	*
377	* @access public
378	*/
379	function &factory($dsn, $options = false)
380	{
381	$dsninfo = MDB2::parseDSN($dsn);
382	if (empty($dsninfo['phptype'])) {
383	$err =& MDB2::raiseError(MDB2_ERROR_NOT_FOUND,
384	null, null, 'no RDBMS driver specified');
385	return $err;
386	}
387	$class_name = 'MDB2_Driver_'.$dsninfo['phptype'];
388
389	$debug = (!empty($options['debug']));
390	$err = MDB2::loadClass($class_name, $debug);
391	if (PEAR::isError($err)) {
392	return $err;
393	}
394
395	$db =& new $class_name();
396	$db->setDSN($dsninfo);
397	$err = MDB2::setOptions($db, $options);
398	if (PEAR::isError($err)) {
399	return $err;
400	}
401
402	return $db;
403	}
404
405	// }}}
406	// {{{ function &connect($dsn, $options = false)
407
408	/**
409	* Create a new MDB2 connection object and connect to the specified
410	* database
411	*
412	* IMPORTANT: In order for MDB2 to work properly it is necessary that
413	* you make sure that you work with a reference of the original
414	* object instead of a copy (this is a PHP4 quirk).
415	*
416	* For example:
417	* $db =& MDB2::connect($dsn);
418	* ^^
419	* And not:
420	* $db = MDB2::connect($dsn);
421	* ^^
422	*
423	* @param mixed 'data source name', see the MDB2::parseDSN
424	* method for a description of the dsn format.
425	* Can also be specified as an array of the
426	* format returned by MDB2::parseDSN.
427	* @param array An associative array of option names and
428	* their values.
429	*
430	* @return mixed a newly created MDB2 connection object, or a MDB2
431	* error object on error
432	*
433	* @access public
434	* @see MDB2::parseDSN
435	*/
436	function &connect($dsn, $options = false)
437	{
438	$db =& MDB2::factory($dsn, $options);
439	if (PEAR::isError($db)) {
440	return $db;
441	}
442
443	$err = $db->connect();
444	if (PEAR::isError($err)) {
445	$dsn = $db->getDSN('string', 'xxx');
446	$db->disconnect();
447	$err->addUserInfo($dsn);
448	return $err;
449	}
450
451	return $db;
452	}
453
454	// }}}
455	// {{{ function &singleton($dsn = null, $options = false)
456
457	/**
458	* Returns a MDB2 connection with the requested DSN.
459	* A new MDB2 connection object is only created if no object with the
460	* requested DSN exists yet.
461	*
462	* IMPORTANT: In order for MDB2 to work properly it is necessary that
463	* you make sure that you work with a reference of the original
464	* object instead of a copy (this is a PHP4 quirk).
465	*
466	* For example:
467	* $db =& MDB2::singleton($dsn);
468	* ^^
469	* And not:
470	* $db = MDB2::singleton($dsn);
471	* ^^
472	*
473	* @param mixed 'data source name', see the MDB2::parseDSN
474	* method for a description of the dsn format.
475	* Can also be specified as an array of the
476	* format returned by MDB2::parseDSN.
477	* @param array An associative array of option names and
478	* their values.
479	*
480	* @return mixed a newly created MDB2 connection object, or a MDB2
481	* error object on error
482	*
483	* @access public
484	* @see MDB2::parseDSN
485	*/
486	function &singleton($dsn = null, $options = false)
487	{
488	if ($dsn) {
489	$dsninfo = MDB2::parseDSN($dsn);
490	$dsninfo = array_merge($GLOBALS['_MDB2_dsninfo_default'], $dsninfo);
491	$keys = array_keys($GLOBALS['_MDB2_databases']);
492	for ($i=0, $j=count($keys); $i<$j; ++$i) {
493	if (isset($GLOBALS['_MDB2_databases'][$keys[$i]])) {
494	$tmp_dsn = $GLOBALS['_MDB2_databases'][$keys[$i]]->getDSN('array');
495	if (count(array_diff_assoc($tmp_dsn, $dsninfo)) == 0) {
496	MDB2::setOptions($GLOBALS['_MDB2_databases'][$keys[$i]], $options);
497	return $GLOBALS['_MDB2_databases'][$keys[$i]];
498	}
499	}
500	}
501	} elseif (is_array($GLOBALS['_MDB2_databases']) && reset($GLOBALS['_MDB2_databases'])) {
502	$db =& $GLOBALS['_MDB2_databases'][key($GLOBALS['_MDB2_databases'])];
503	return $db;
504	}
505	$db =& MDB2::factory($dsn, $options);
506	return $db;
507	}
508
509	// }}}
510	// {{{ function loadFile($file)
511
512	/**
513	* load a file (like 'Date')
514	*
515	* @param string name of the file in the MDB2 directory (without '.php')
516	*
517	* @return string name of the file that was included
518	*
519	* @access public
520	*/
521	function loadFile($file)
522	{
523	$file_name = 'MDB2'.DIRECTORY_SEPARATOR.$file.'.php';
524	if (!MDB2::fileExists($file_name)) {
525	return MDB2::raiseError(MDB2_ERROR_NOT_FOUND, null, null,
526	'unable to find: '.$file_name);
527	}
528	if (!include_once($file_name)) {
529	return MDB2::raiseError(MDB2_ERROR_NOT_FOUND, null, null,
530	'unable to load driver class: '.$file_name);
531	}
532	return $file_name;
533	}
534
535	// }}}
536	// {{{ function apiVersion()
537
538	/**
539	* Return the MDB2 API version
540	*
541	* @return string the MDB2 API version number
542	*
543	* @access public
544	*/
545	function apiVersion()
546	{
547	return '2.4.1';
548	}
549
550	// }}}
551	// {{{ function &raiseError($code = null, $mode = null, $options = null, $userinfo = null)
552
553	/**
554	* This method is used to communicate an error and invoke error
555	* callbacks etc. Basically a wrapper for PEAR::raiseError
556	* without the message string.
557	*
558	* @param mixed int error code
559	*
560	* @param int error mode, see PEAR_Error docs
561	*
562	* @param mixed If error mode is PEAR_ERROR_TRIGGER, this is the
563	* error level (E_USER_NOTICE etc). If error mode is
564	* PEAR_ERROR_CALLBACK, this is the callback function,
565	* either as a function name, or as an array of an
566	* object and method name. For other error modes this
567	* parameter is ignored.
568	*
569	* @param string Extra debug information. Defaults to the last
570	* query and native error code.
571	*
572	* @return PEAR_Error instance of a PEAR Error object
573	*
574	* @access private
575	* @see PEAR_Error
576	*/
577	function &raiseError($code = null, $mode = null, $options = null, $userinfo = null)
578	{
579	$err =& PEAR::raiseError(null, $code, $mode, $options, $userinfo, 'MDB2_Error', true);
580	return $err;
581	}
582
583	// }}}
584	// {{{ function isError($data, $code = null)
585
586	/**
587	* Tell whether a value is a MDB2 error.
588	*
589	* @param mixed the value to test
590	* @param int if is an error object, return true
591	* only if $code is a string and
592	* $db->getMessage() == $code or
593	* $code is an integer and $db->getCode() == $code
594	*
595	* @return bool true if parameter is an error
596	*
597	* @access public
598	*/
599	function isError($data, $code = null)
600	{
601	if (is_a($data, 'MDB2_Error')) {
602	if (is_null($code)) {
603	return true;
604	} elseif (is_string($code)) {
605	return $data->getMessage() === $code;
606	} else {
607	$code = (array)$code;
608	return in_array($data->getCode(), $code);
609	}
610	}
611	return false;
612	}
613
614	// }}}
615	// {{{ function isConnection($value)
616
617	/**
618	* Tell whether a value is a MDB2 connection
619	*
620	* @param mixed value to test
621	*
622	* @return bool whether $value is a MDB2 connection
623	*
624	* @access public
625	*/
626	function isConnection($value)
627	{
628	return is_a($value, 'MDB2_Driver_Common');
629	}
630
631	// }}}
632	// {{{ function isResult($value)
633
634	/**
635	* Tell whether a value is a MDB2 result
636	*
637	* @param mixed value to test
638	*
639	* @return bool whether $value is a MDB2 result
640	*
641	* @access public
642	*/
643	function isResult($value)
644	{
645	return is_a($value, 'MDB2_Result');
646	}
647
648	// }}}
649	// {{{ function isResultCommon($value)
650
651	/**
652	* Tell whether a value is a MDB2 result implementing the common interface
653	*
654	* @param mixed value to test
655	*
656	* @return bool whether $value is a MDB2 result implementing the common interface
657	*
658	* @access public
659	*/
660	function isResultCommon($value)
661	{
662	return is_a($value, 'MDB2_Result_Common');
663	}
664
665	// }}}
666	// {{{ function isStatement($value)
667
668	/**
669	* Tell whether a value is a MDB2 statement interface
670	*
671	* @param mixed value to test
672	*
673	* @return bool whether $value is a MDB2 statement interface
674	*
675	* @access public
676	*/
677	function isStatement($value)
678	{
679	return is_a($value, 'MDB2_Statement');
680	}
681
682	// }}}
683	// {{{ function errorMessage($value = null)
684
685	/**
686	* Return a textual error message for a MDB2 error code
687	*
688	* @param int\|array integer error code,
689	null to get the current error code-message map,
690	or an array with a new error code-message map
691	*
692	* @return string error message, or false if the error code was
693	* not recognized
694	*
695	* @access public
696	*/
697	function errorMessage($value = null)
698	{
699	static $errorMessages;
700
701	if (is_array($value)) {
702	$errorMessages = $value;
703	return MDB2_OK;
704	}
705
706	if (!isset($errorMessages)) {
707	$errorMessages = array(
708	MDB2_OK => 'no error',
709	MDB2_ERROR => 'unknown error',
710	MDB2_ERROR_ALREADY_EXISTS => 'already exists',
711	MDB2_ERROR_CANNOT_CREATE => 'can not create',
712	MDB2_ERROR_CANNOT_ALTER => 'can not alter',
713	MDB2_ERROR_CANNOT_REPLACE => 'can not replace',
714	MDB2_ERROR_CANNOT_DELETE => 'can not delete',
715	MDB2_ERROR_CANNOT_DROP => 'can not drop',
716	MDB2_ERROR_CONSTRAINT => 'constraint violation',
717	MDB2_ERROR_CONSTRAINT_NOT_NULL=> 'null value violates not-null constraint',
718	MDB2_ERROR_DIVZERO => 'division by zero',
719	MDB2_ERROR_INVALID => 'invalid',
720	MDB2_ERROR_INVALID_DATE => 'invalid date or time',
721	MDB2_ERROR_INVALID_NUMBER => 'invalid number',
722	MDB2_ERROR_MISMATCH => 'mismatch',
723	MDB2_ERROR_NODBSELECTED => 'no database selected',
724	MDB2_ERROR_NOSUCHFIELD => 'no such field',
725	MDB2_ERROR_NOSUCHTABLE => 'no such table',
726	MDB2_ERROR_NOT_CAPABLE => 'MDB2 backend not capable',
727	MDB2_ERROR_NOT_FOUND => 'not found',
728	MDB2_ERROR_NOT_LOCKED => 'not locked',
729	MDB2_ERROR_SYNTAX => 'syntax error',
730	MDB2_ERROR_UNSUPPORTED => 'not supported',
731	MDB2_ERROR_VALUE_COUNT_ON_ROW => 'value count on row',
732	MDB2_ERROR_INVALID_DSN => 'invalid DSN',
733	MDB2_ERROR_CONNECT_FAILED => 'connect failed',
734	MDB2_ERROR_NEED_MORE_DATA => 'insufficient data supplied',
735	MDB2_ERROR_EXTENSION_NOT_FOUND=> 'extension not found',
736	MDB2_ERROR_NOSUCHDB => 'no such database',
737	MDB2_ERROR_ACCESS_VIOLATION => 'insufficient permissions',
738	MDB2_ERROR_LOADMODULE => 'error while including on demand module',
739	MDB2_ERROR_TRUNCATED => 'truncated',
740	MDB2_ERROR_DEADLOCK => 'deadlock detected',
741	);
742	}
743
744	if (is_null($value)) {
745	return $errorMessages;
746	}
747
748	if (PEAR::isError($value)) {
749	$value = $value->getCode();
750	}
751
752	return isset($errorMessages[$value]) ?
753	$errorMessages[$value] : $errorMessages[MDB2_ERROR];
754	}
755
756	// }}}
757	// {{{ function parseDSN($dsn)
758
759	/**
760	* Parse a data source name.
761	*
762	* Additional keys can be added by appending a URI query string to the
763	* end of the DSN.
764	*
765	* The format of the supplied DSN is in its fullest form:
766	* <code>
767	* phptype(dbsyntax)://username:password@protocol+hostspec/database?option=8&another=true
768	* </code>
769	*
770	* Most variations are allowed:
771	* <code>
772	* phptype://username:password@protocol+hostspec:110//usr/db_file.db?mode=0644
773	* phptype://username:password@hostspec/database_name
774	* phptype://username:password@hostspec
775	* phptype://username@hostspec
776	* phptype://hostspec/database
777	* phptype://hostspec
778	* phptype(dbsyntax)
779	* phptype
780	* </code>
781	*
782	* @param string Data Source Name to be parsed
783	*
784	* @return array an associative array with the following keys:
785	* + phptype: Database backend used in PHP (mysql, odbc etc.)
786	* + dbsyntax: Database used with regards to SQL syntax etc.
787	* + protocol: Communication protocol to use (tcp, unix etc.)
788	* + hostspec: Host specification (hostname[:port])
789	* + database: Database to use on the DBMS server
790	* + username: User name for login
791	* + password: Password for login
792	*
793	* @access public
794	* @author Tomas V.V.Cox <[email protected]>
795	*/
796	function parseDSN($dsn)
797	{
798	$parsed = $GLOBALS['_MDB2_dsninfo_default'];
799
800	if (is_array($dsn)) {
801	$dsn = array_merge($parsed, $dsn);
802	if (!$dsn['dbsyntax']) {
803	$dsn['dbsyntax'] = $dsn['phptype'];
804	}
805	return $dsn;
806	}
807
808	// Find phptype and dbsyntax
809	if (($pos = strpos($dsn, '://')) !== false) {
810	$str = substr($dsn, 0, $pos);
811	$dsn = substr($dsn, $pos + 3);
812	} else {
813	$str = $dsn;
814	$dsn = null;
815	}
816
817	// Get phptype and dbsyntax
818	// $str => phptype(dbsyntax)
819	if (preg_match('\|^(.+?)\((.*?)\)$\|', $str, $arr)) {
820	$parsed['phptype'] = $arr[1];
821	$parsed['dbsyntax'] = !$arr[2] ? $arr[1] : $arr[2];
822	} else {
823	$parsed['phptype'] = $str;
824	$parsed['dbsyntax'] = $str;
825	}
826
827	if (!count($dsn)) {
828	return $parsed;
829	}
830
831	// Get (if found): username and password
832	// $dsn => username:password@protocol+hostspec/database
833	if (($at = strrpos($dsn,'@')) !== false) {
834	$str = substr($dsn, 0, $at);
835	$dsn = substr($dsn, $at + 1);
836	if (($pos = strpos($str, ':')) !== false) {
837	$parsed['username'] = rawurldecode(substr($str, 0, $pos));
838	$parsed['password'] = rawurldecode(substr($str, $pos + 1));
839	} else {
840	$parsed['username'] = rawurldecode($str);
841	}
842	}
843
844	// Find protocol and hostspec
845
846	// $dsn => proto(proto_opts)/database
847	if (preg_match('\|^([^(]+)\((.?)\)/?(.?)$\|', $dsn, $match)) {
848	$proto = $match[1];
849	$proto_opts = $match[2] ? $match[2] : false;
850	$dsn = $match[3];
851
852	// $dsn => protocol+hostspec/database (old format)
853	} else {
854	if (strpos($dsn, '+') !== false) {
855	list($proto, $dsn) = explode('+', $dsn, 2);
856	}
857	if ( strpos($dsn, '//') === 0
858	&& strpos($dsn, '/', 2) !== false
859	&& $parsed['phptype'] == 'oci8'
860	) {
861	//oracle's "Easy Connect" syntax:
862	//"username/password@[//]host[:port][/service_name]"
863	//e.g. "scott/tiger@//mymachine:1521/oracle"
864	$proto_opts = $dsn;
865	$dsn = null;
866	} elseif (strpos($dsn, '/') !== false) {
867	list($proto_opts, $dsn) = explode('/', $dsn, 2);
868	} else {
869	$proto_opts = $dsn;
870	$dsn = null;
871	}
872	}
873
874	// process the different protocol options
875	$parsed['protocol'] = (!empty($proto)) ? $proto : 'tcp';
876	$proto_opts = rawurldecode($proto_opts);
877	if (strpos($proto_opts, ':') !== false) {
878	list($proto_opts, $parsed['port']) = explode(':', $proto_opts);
879	}
880	if ($parsed['protocol'] == 'tcp') {
881	$parsed['hostspec'] = $proto_opts;
882	} elseif ($parsed['protocol'] == 'unix') {
883	$parsed['socket'] = $proto_opts;
884	}
885
886	// Get dabase if any
887	// $dsn => database
888	if ($dsn) {
889	// /database
890	if (($pos = strpos($dsn, '?')) === false) {
891	$parsed['database'] = $dsn;
892	// /database?param1=value1&param2=value2
893	} else {
894	$parsed['database'] = substr($dsn, 0, $pos);
895	$dsn = substr($dsn, $pos + 1);
896	if (strpos($dsn, '&') !== false) {
897	$opts = explode('&', $dsn);
898	} else { // database?param1=value1
899	$opts = array($dsn);
900	}
901	foreach ($opts as $opt) {
902	list($key, $value) = explode('=', $opt);
903	if (!isset($parsed[$key])) {
904	// don't allow params overwrite
905	$parsed[$key] = rawurldecode($value);
906	}
907	}
908	}
909	}
910
911	return $parsed;
912	}
913
914	// }}}
915	// {{{ function fileExists($file)
916
917	/**
918	* Checks if a file exists in the include path
919	*
920	* @param string filename
921	*
922	* @return bool true success and false on error
923	*
924	* @access public
925	*/
926	function fileExists($file)
927	{
928	// safe_mode does notwork with is_readable()
929	if (!@ini_get('safe_mode')) {
930	$dirs = explode(PATH_SEPARATOR, ini_get('include_path'));
931	foreach ($dirs as $dir) {
932	if (is_readable($dir . DIRECTORY_SEPARATOR . $file)) {
933	return true;
934	}
935	}
936	} else {
937	$fp = @fopen($file, 'r', true);
938	if (is_resource($fp)) {
939	@fclose($fp);
940	return true;
941	}
942	}
943	return false;
944	}
945	// }}}
946	}
947
948	// }}}
949	// {{{ class MDB2_Error extends PEAR_Error
950
951	/**
952	* MDB2_Error implements a class for reporting portable database error
953	* messages.
954	*
955	* @package MDB2
956	* @category Database
957	* @author Stig Bakken <[email protected]>
958	*/
959	class MDB2_Error extends PEAR_Error
960	{
961	// {{{ constructor: function MDB2_Error($code = MDB2_ERROR, $mode = PEAR_ERROR_RETURN, $level = E_USER_NOTICE, $debuginfo = null)
962
963	/**
964	* MDB2_Error constructor.
965	*
966	* @param mixed MDB2 error code, or string with error message.
967	* @param int what 'error mode' to operate in
968	* @param int what error level to use for $mode & PEAR_ERROR_TRIGGER
969	* @param smixed additional debug info, such as the last query
970	*/
971	function MDB2_Error($code = MDB2_ERROR, $mode = PEAR_ERROR_RETURN,
972	$level = E_USER_NOTICE, $debuginfo = null)
973	{
974	if (is_null($code)) {
975	$code = MDB2_ERROR;
976	}
977	$this->PEAR_Error('MDB2 Error: '.MDB2::errorMessage($code), $code,
978	$mode, $level, $debuginfo);
979	}
980
981	// }}}
982	}
983
984	// }}}
985	// {{{ class MDB2_Driver_Common extends PEAR
986
987	/**
988	* MDB2_Driver_Common: Base class that is extended by each MDB2 driver
989	*
990	* @package MDB2
991	* @category Database
992	* @author Lukas Smith <[email protected]>
993	*/
994	class MDB2_Driver_Common extends PEAR
995	{
996	// {{{ Variables (Properties)
997
998	/**
999	* index of the MDB2 object within the $GLOBALS['_MDB2_databases'] array
1000	* @var int
1001	* @access public
1002	*/
1003	var $db_index = 0;
1004
1005	/**
1006	* DSN used for the next query
1007	* @var array
1008	* @access protected
1009	*/
1010	var $dsn = array();
1011
1012	/**
1013	* DSN that was used to create the current connection
1014	* @var array
1015	* @access protected
1016	*/
1017	var $connected_dsn = array();
1018
1019	/**
1020	* connection resource
1021	* @var mixed
1022	* @access protected
1023	*/
1024	var $connection = 0;
1025
1026	/**
1027	* if the current opened connection is a persistent connection
1028	* @var bool
1029	* @access protected
1030	*/
1031	var $opened_persistent;
1032
1033	/**
1034	* the name of the database for the next query
1035	* @var string
1036	* @access protected
1037	*/
1038	var $database_name = '';
1039
1040	/**
1041	* the name of the database currently selected
1042	* @var string
1043	* @access protected
1044	*/
1045	var $connected_database_name = '';
1046
1047	/**
1048	* server version information
1049	* @var string
1050	* @access protected
1051	*/
1052	var $connected_server_info = '';
1053
1054	/**
1055	* list of all supported features of the given driver
1056	* @var array
1057	* @access public
1058	*/
1059	var $supported = array(
1060	'sequences' => false,
1061	'indexes' => false,
1062	'affected_rows' => false,
1063	'summary_functions' => false,
1064	'order_by_text' => false,
1065	'transactions' => false,
1066	'savepoints' => false,
1067	'current_id' => false,
1068	'limit_queries' => false,
1069	'LOBs' => false,
1070	'replace' => false,
1071	'sub_selects' => false,
1072	'auto_increment' => false,
1073	'primary_key' => false,
1074	'result_introspection' => false,
1075	'prepared_statements' => false,
1076	'identifier_quoting' => false,
1077	'pattern_escaping' => false,
1078	'new_link' => false,
1079	);
1080
1081	/**
1082	* Array of supported options that can be passed to the MDB2 instance.
1083	*
1084	* The options can be set during object creation, using
1085	* MDB2::connect(), MDB2::factory() or MDB2::singleton(). The options can
1086	* also be set after the object is created, using MDB2::setOptions() or
1087	* MDB2_Driver_Common::setOption().
1088	* The list of available option includes:
1089	* <ul>
1090	* <li>$options['ssl'] -> boolean: determines if ssl should be used for connections</li>
1091	* <li>$options['field_case'] -> CASE_LOWER\|CASE_UPPER: determines what case to force on field/table names</li>
1092	* <li>$options['disable_query'] -> boolean: determines if queries should be executed</li>
1093	* <li>$options['result_class'] -> string: class used for result sets</li>
1094	* <li>$options['buffered_result_class'] -> string: class used for buffered result sets</li>
1095	* <li>$options['result_wrap_class'] -> string: class used to wrap result sets into</li>
1096	* <li>$options['result_buffering'] -> boolean should results be buffered or not?</li>
1097	* <li>$options['fetch_class'] -> string: class to use when fetch mode object is used</li>
1098	* <li>$options['persistent'] -> boolean: persistent connection?</li>
1099	* <li>$options['debug'] -> integer: numeric debug level</li>
1100	* <li>$options['debug_handler'] -> string: function/method that captures debug messages</li>
1101	* <li>$options['debug_expanded_output'] -> bool: BC option to determine if more context information should be send to the debug handler</li>
1102	* <li>$options['default_text_field_length'] -> integer: default text field length to use</li>
1103	* <li>$options['lob_buffer_length'] -> integer: LOB buffer length</li>
1104	* <li>$options['log_line_break'] -> string: line-break format</li>
1105	* <li>$options['idxname_format'] -> string: pattern for index name</li>
1106	* <li>$options['seqname_format'] -> string: pattern for sequence name</li>
1107	* <li>$options['savepoint_format'] -> string: pattern for auto generated savepoint names</li>
1108	* <li>$options['statement_format'] -> string: pattern for prepared statement names</li>
1109	* <li>$options['seqcol_name'] -> string: sequence column name</li>
1110	* <li>$options['quote_identifier'] -> boolean: if identifier quoting should be done when check_option is used</li>
1111	* <li>$options['use_transactions'] -> boolean: if transaction use should be enabled</li>
1112	* <li>$options['decimal_places'] -> integer: number of decimal places to handle</li>
1113	* <li>$options['portability'] -> integer: portability constant</li>
1114	* <li>$options['modules'] -> array: short to long module name mapping for __call()</li>
1115	* <li>$options['emulate_prepared'] -> boolean: force prepared statements to be emulated</li>
1116	* <li>$options['datatype_map'] -> array: map user defined datatypes to other primitive datatypes</li>
1117	* <li>$options['datatype_map_callback'] -> array: callback function/method that should be called</li>
1118	* </ul>
1119	*
1120	* @var array
1121	* @access public
1122	* @see MDB2::connect()
1123	* @see MDB2::factory()
1124	* @see MDB2::singleton()
1125	* @see MDB2_Driver_Common::setOption()
1126	*/
1127	var $options = array(
1128	'ssl' => false,
1129	'field_case' => CASE_LOWER,
1130	'disable_query' => false,
1131	'result_class' => 'MDB2_Result_%s',
1132	'buffered_result_class' => 'MDB2_BufferedResult_%s',
1133	'result_wrap_class' => false,
1134	'result_buffering' => true,
1135	'fetch_class' => 'stdClass',
1136	'persistent' => false,
1137	'debug' => 0,
1138	'debug_handler' => 'MDB2_defaultDebugOutput',
1139	'debug_expanded_output' => false,
1140	'default_text_field_length' => 4096,
1141	'lob_buffer_length' => 8192,
1142	'log_line_break' => "\n",
1143	'idxname_format' => '%s_idx',
1144	'seqname_format' => '%s_seq',
1145	'savepoint_format' => 'MDB2_SAVEPOINT_%s',
1146	'statement_format' => 'MDB2_STATEMENT_%1$s_%2$s',
1147	'seqcol_name' => 'sequence',
1148	'quote_identifier' => false,
1149	'use_transactions' => true,
1150	'decimal_places' => 2,
1151	'portability' => MDB2_PORTABILITY_ALL,
1152	'modules' => array(
1153	'ex' => 'Extended',
1154	'dt' => 'Datatype',
1155	'mg' => 'Manager',
1156	'rv' => 'Reverse',
1157	'na' => 'Native',
1158	'fc' => 'Function',
1159	),
1160	'emulate_prepared' => false,
1161	'datatype_map' => array(),
1162	'datatype_map_callback' => array(),
1163	'nativetype_map_callback' => array(),
1164	);
1165
1166	/**
1167	* string array
1168	* @var string
1169	* @access protected
1170	*/
1171	var $string_quoting = array('start' => "'", 'end' => "'", 'escape' => false, 'escape_pattern' => false);
1172
1173	/**
1174	* identifier quoting
1175	* @var array
1176	* @access protected
1177	*/
1178	var $identifier_quoting = array('start' => '"', 'end' => '"', 'escape' => '"');
1179
1180	/**
1181	* sql comments
1182	* @var array
1183	* @access protected
1184	*/
1185	var $sql_comments = array(
1186	array('start' => '--', 'end' => "\n", 'escape' => false),
1187	array('start' => '/', 'end' => '/', 'escape' => false),
1188	);
1189
1190	/**
1191	* comparision wildcards
1192	* @var array
1193	* @access protected
1194	*/
1195	var $wildcards = array('%', '_');
1196
1197	/**
1198	* column alias keyword
1199	* @var string
1200	* @access protected
1201	*/
1202	var $as_keyword = ' AS ';
1203
1204	/**
1205	* warnings
1206	* @var array
1207	* @access protected
1208	*/
1209	var $warnings = array();
1210
1211	/**
1212	* string with the debugging information
1213	* @var string
1214	* @access public
1215	*/
1216	var $debug_output = '';
1217
1218	/**
1219	* determine if there is an open transaction
1220	* @var bool
1221	* @access protected
1222	*/
1223	var $in_transaction = false;
1224
1225	/**
1226	* the smart transaction nesting depth
1227	* @var int
1228	* @access protected
1229	*/
1230	var $nested_transaction_counter = null;
1231
1232	/**
1233	* the first error that occured inside a nested transaction
1234	* @var MDB2_Error\|bool
1235	* @access protected
1236	*/
1237	var $has_transaction_error = false;
1238
1239	/**
1240	* result offset used in the next query
1241	* @var int
1242	* @access protected
1243	*/
1244	var $offset = 0;
1245
1246	/**
1247	* result limit used in the next query
1248	* @var int
1249	* @access protected
1250	*/
1251	var $limit = 0;
1252
1253	/**
1254	* Database backend used in PHP (mysql, odbc etc.)
1255	* @var string
1256	* @access public
1257	*/
1258	var $phptype;
1259
1260	/**
1261	* Database used with regards to SQL syntax etc.
1262	* @var string
1263	* @access public
1264	*/
1265	var $dbsyntax;
1266
1267	/**
1268	* the last query sent to the driver
1269	* @var string
1270	* @access public
1271	*/
1272	var $last_query;
1273
1274	/**
1275	* the default fetchmode used
1276	* @var int
1277	* @access protected
1278	*/
1279	var $fetchmode = MDB2_FETCHMODE_ORDERED;
1280
1281	/**
1282	* array of module instances
1283	* @var array
1284	* @access protected
1285	*/
1286	var $modules = array();
1287
1288	/**
1289	* determines of the PHP4 destructor emulation has been enabled yet
1290	* @var array
1291	* @access protected
1292	*/
1293	var $destructor_registered = true;
1294
1295	// }}}
1296	// {{{ constructor: function __construct()
1297
1298	/**
1299	* Constructor
1300	*/
1301	function __construct()
1302	{
1303	end($GLOBALS['_MDB2_databases']);
1304	$db_index = key($GLOBALS['_MDB2_databases']) + 1;
1305	$GLOBALS['_MDB2_databases'][$db_index] = &$this;
1306	$this->db_index = $db_index;
1307	}
1308
1309	// }}}
1310	// {{{ function MDB2_Driver_Common()
1311
1312	/**
1313	* PHP 4 Constructor
1314	*/
1315	function MDB2_Driver_Common()
1316	{
1317	$this->destructor_registered = false;
1318	$this->__construct();
1319	}
1320
1321	// }}}
1322	// {{{ destructor: function __destruct()
1323
1324	/**
1325	* Destructor
1326	*/
1327	function __destruct()
1328	{
1329	$this->disconnect(false);
1330	}
1331
1332	// }}}
1333	// {{{ function free()
1334
1335	/**
1336	* Free the internal references so that the instance can be destroyed
1337	*
1338	* @return bool true on success, false if result is invalid
1339	*
1340	* @access public
1341	*/
1342	function free()
1343	{
1344	unset($GLOBALS['_MDB2_databases'][$this->db_index]);
1345	unset($this->db_index);
1346	return MDB2_OK;
1347	}
1348
1349	// }}}
1350	// {{{ function __toString()
1351
1352	/**
1353	* String conversation
1354	*
1355	* @return string representation of the object
1356	*
1357	* @access public
1358	*/
1359	function __toString()
1360	{
1361	$info = get_class($this);
1362	$info.= ': (phptype = '.$this->phptype.', dbsyntax = '.$this->dbsyntax.')';
1363	if ($this->connection) {
1364	$info.= ' [connected]';
1365	}
1366	return $info;
1367	}
1368
1369	// }}}
1370	// {{{ function errorInfo($error = null)
1371
1372	/**
1373	* This method is used to collect information about an error
1374	*
1375	* @param mixed error code or resource
1376	*
1377	* @return array with MDB2 errorcode, native error code, native message
1378	*
1379	* @access public
1380	*/
1381	function errorInfo($error = null)
1382	{
1383	return array($error, null, null);
1384	}
1385
1386	// }}}
1387	// {{{ function &raiseError($code = null, $mode = null, $options = null, $userinfo = null)
1388
1389	/**
1390	* This method is used to communicate an error and invoke error
1391	* callbacks etc. Basically a wrapper for PEAR::raiseError
1392	* without the message string.
1393	*
1394	* @param mixed integer error code, or a PEAR error object (all other
1395	* parameters are ignored if this parameter is an object
1396	* @param int error mode, see PEAR_Error docs
1397	* @param mixed If error mode is PEAR_ERROR_TRIGGER, this is the
1398	* error level (E_USER_NOTICE etc). If error mode is
1399	* PEAR_ERROR_CALLBACK, this is the callback function,
1400	* either as a function name, or as an array of an
1401	* object and method name. For other error modes this
1402	* parameter is ignored.
1403	* @param string Extra debug information. Defaults to the last
1404	* query and native error code.
1405	* @param string name of the method that triggered the error
1406	*
1407	* @return PEAR_Error instance of a PEAR Error object
1408	*
1409	* @access public
1410	* @see PEAR_Error
1411	*/
1412	function &raiseError($code = null, $mode = null, $options = null, $userinfo = null, $method = null)
1413	{
1414	$userinfo = "[Error message: $userinfo]\n";
1415	// The error is yet a MDB2 error object
1416	if (PEAR::isError($code)) {
1417	// because we use the static PEAR::raiseError, our global
1418	// handler should be used if it is set
1419	if (is_null($mode) && !empty($this->_default_error_mode)) {
1420	$mode = $this->_default_error_mode;
1421	$options = $this->_default_error_options;
1422	}
1423	if (is_null($userinfo)) {
1424	$userinfo = $code->getUserinfo();
1425	}
1426	$code = $code->getCode();
1427	} elseif ($code == MDB2_ERROR_NOT_FOUND) {
1428	// extension not loaded: don't call $this->errorInfo() or the script
1429	// will die
1430	} elseif (isset($this->connection)) {
1431	if (!empty($this->last_query)) {
1432	$userinfo.= "[Last executed query: {$this->last_query}]\n";
1433	}
1434	$native_errno = $native_msg = null;
1435	list($code, $native_errno, $native_msg) = $this->errorInfo($code);
1436	if (!is_null($native_errno) && $native_errno !== '') {
1437	$userinfo.= "[Native code: $native_errno]\n";
1438	}
1439	if (!is_null($native_msg) && $native_msg !== '') {
1440	$userinfo.= "[Native message: ". strip_tags($native_msg) ."]\n";
1441	}
1442	if (!is_null($method)) {
1443	$userinfo = $method.': '.$userinfo;
1444	}
1445	}
1446
1447	$err =& PEAR::raiseError(null, $code, $mode, $options, $userinfo, 'MDB2_Error', true);
1448	if ($err->getMode() !== PEAR_ERROR_RETURN
1449	&& isset($this->nested_transaction_counter) && !$this->has_transaction_error) {
1450	$this->has_transaction_error =& $err;
1451	}
1452	return $err;
1453	}
1454
1455	// }}}
1456	// {{{ function resetWarnings()
1457
1458	/**
1459	* reset the warning array
1460	*
1461	* @return void
1462	*
1463	* @access public
1464	*/
1465	function resetWarnings()
1466	{
1467	$this->warnings = array();
1468	}
1469
1470	// }}}
1471	// {{{ function getWarnings()
1472
1473	/**
1474	* Get all warnings in reverse order.
1475	* This means that the last warning is the first element in the array
1476	*
1477	* @return array with warnings
1478	*
1479	* @access public
1480	* @see resetWarnings()
1481	*/
1482	function getWarnings()
1483	{
1484	return array_reverse($this->warnings);
1485	}
1486
1487	// }}}
1488	// {{{ function setFetchMode($fetchmode, $object_class = 'stdClass')
1489
1490	/**
1491	* Sets which fetch mode should be used by default on queries
1492	* on this connection
1493	*
1494	* @param int MDB2_FETCHMODE_ORDERED, MDB2_FETCHMODE_ASSOC
1495	* or MDB2_FETCHMODE_OBJECT
1496	* @param string the class name of the object to be returned
1497	* by the fetch methods when the
1498	* MDB2_FETCHMODE_OBJECT mode is selected.
1499	* If no class is specified by default a cast
1500	* to object from the assoc array row will be
1501	* done. There is also the possibility to use
1502	* and extend the 'MDB2_row' class.
1503	*
1504	* @return mixed MDB2_OK or MDB2 Error Object
1505	*
1506	* @access public
1507	* @see MDB2_FETCHMODE_ORDERED, MDB2_FETCHMODE_ASSOC, MDB2_FETCHMODE_OBJECT
1508	*/
1509	function setFetchMode($fetchmode, $object_class = 'stdClass')
1510	{
1511	switch ($fetchmode) {
1512	case MDB2_FETCHMODE_OBJECT:
1513	$this->options['fetch_class'] = $object_class;
1514	case MDB2_FETCHMODE_ORDERED:
1515	case MDB2_FETCHMODE_ASSOC:
1516	$this->fetchmode = $fetchmode;
1517	break;
1518	default:
1519	return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
1520	'invalid fetchmode mode', __FUNCTION__);
1521	}
1522
1523	return MDB2_OK;
1524	}
1525
1526	// }}}
1527	// {{{ function setOption($option, $value)
1528
1529	/**
1530	* set the option for the db class
1531	*
1532	* @param string option name
1533	* @param mixed value for the option
1534	*
1535	* @return mixed MDB2_OK or MDB2 Error Object
1536	*
1537	* @access public
1538	*/
1539	function setOption($option, $value)
1540	{
1541	if (array_key_exists($option, $this->options)) {
1542	$this->options[$option] = $value;
1543	return MDB2_OK;
1544	}
1545	return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
1546	"unknown option $option", __FUNCTION__);
1547	}
1548
1549	// }}}
1550	// {{{ function getOption($option)
1551
1552	/**
1553	* Returns the value of an option
1554	*
1555	* @param string option name
1556	*
1557	* @return mixed the option value or error object
1558	*
1559	* @access public
1560	*/
1561	function getOption($option)
1562	{
1563	if (array_key_exists($option, $this->options)) {
1564	return $this->options[$option];
1565	}
1566	return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
1567	"unknown option $option", __FUNCTION__);
1568	}
1569
1570	// }}}
1571	// {{{ function debug($message, $scope = '', $is_manip = null)
1572
1573	/**
1574	* set a debug message
1575	*
1576	* @param string message that should be appended to the debug variable
1577	* @param string usually the method name that triggered the debug call:
1578	* for example 'query', 'prepare', 'execute', 'parameters',
1579	* 'beginTransaction', 'commit', 'rollback'
1580	* @param array contains context information about the debug() call
1581	* common keys are: is_manip, time, result etc.
1582	*
1583	* @return void
1584	*
1585	* @access public
1586	*/
1587	function debug($message, $scope = '', $context = array())
1588	{
1589	if ($this->options['debug'] && $this->options['debug_handler']) {
1590	if (!$this->options['debug_expanded_output']) {
1591	if (!empty($context['when']) && $context['when'] !== 'pre') {
1592	return null;
1593	}
1594	$context = empty($context['is_manip']) ? false : $context['is_manip'];
1595	}
1596	return call_user_func_array($this->options['debug_handler'], array(&$this, $scope, $message, $context));
1597	}
1598	return null;
1599	}
1600
1601	// }}}
1602	// {{{ function getDebugOutput()
1603
1604	/**
1605	* output debug info
1606	*
1607	* @return string content of the debug_output class variable
1608	*
1609	* @access public
1610	*/
1611	function getDebugOutput()
1612	{
1613	return $this->debug_output;
1614	}
1615
1616	// }}}
1617	// {{{ function escape($text)
1618
1619	/**
1620	* Quotes a string so it can be safely used in a query. It will quote
1621	* the text so it can safely be used within a query.
1622	*
1623	* @param string the input string to quote
1624	* @param bool escape wildcards
1625	*
1626	* @return string quoted string
1627	*
1628	* @access public
1629	*/
1630	function escape($text, $escape_wildcards = false)
1631	{
1632	if ($escape_wildcards) {
1633	$text = $this->escapePattern($text);
1634	}
1635
1636	$text = str_replace($this->string_quoting['end'], $this->string_quoting['escape'] . $this->string_quoting['end'], $text);
1637	return $text;
1638	}
1639
1640	// }}}
1641	// {{{ function escapePattern($text)
1642
1643	/**
1644	* Quotes pattern (% and _) characters in a string)
1645	*
1646	* EXPERIMENTAL
1647	*
1648	* WARNING: this function is experimental and may change signature at
1649	* any time until labelled as non-experimental
1650	*
1651	* @param string the input string to quote
1652	*
1653	* @return string quoted string
1654	*
1655	* @access public
1656	*/
1657	function escapePattern($text)
1658	{
1659	if ($this->string_quoting['escape_pattern']) {
1660	$text = str_replace($this->string_quoting['escape_pattern'], $this->string_quoting['escape_pattern'] . $this->string_quoting['escape_pattern'], $text);
1661	foreach ($this->wildcards as $wildcard) {
1662	$text = str_replace($wildcard, $this->string_quoting['escape_pattern'] . $wildcard, $text);
1663	}
1664	}
1665	return $text;
1666	}
1667
1668	// }}}
1669	// {{{ function quoteIdentifier($str, $check_option = false)
1670
1671	/**
1672	* Quote a string so it can be safely used as a table or column name
1673	*
1674	* Delimiting style depends on which database driver is being used.
1675	*
1676	* NOTE: just because you CAN use delimited identifiers doesn't mean
1677	* you SHOULD use them. In general, they end up causing way more
1678	* problems than they solve.
1679	*
1680	* Portability is broken by using the following characters inside
1681	* delimited identifiers:
1682	* + backtick (<kbd>`</kbd>) -- due to MySQL
1683	* + double quote (<kbd>"</kbd>) -- due to Oracle
1684	* + brackets (<kbd>[</kbd> or <kbd>]</kbd>) -- due to Access
1685	*
1686	* Delimited identifiers are known to generally work correctly under
1687	* the following drivers:
1688	* + mssql
1689	* + mysql
1690	* + mysqli
1691	* + oci8
1692	* + pgsql
1693	* + sqlite
1694	*
1695	* InterBase doesn't seem to be able to use delimited identifiers
1696	* via PHP 4. They work fine under PHP 5.
1697	*
1698	* @param string identifier name to be quoted
1699	* @param bool check the 'quote_identifier' option
1700	*
1701	* @return string quoted identifier string
1702	*
1703	* @access public
1704	*/
1705	function quoteIdentifier($str, $check_option = false)
1706	{
1707	if ($check_option && !$this->options['quote_identifier']) {
1708	return $str;
1709	}
1710	$str = str_replace($this->identifier_quoting['end'], $this->identifier_quoting['escape'] . $this->identifier_quoting['end'], $str);
1711	return $this->identifier_quoting['start'] . $str . $this->identifier_quoting['end'];
1712	}
1713
1714	// }}}
1715	// {{{ function getAsKeyword()
1716
1717	/**
1718	* Gets the string to alias column
1719	*
1720	* @return string to use when aliasing a column
1721	*/
1722	function getAsKeyword()
1723	{
1724	return $this->as_keyword;
1725	}
1726
1727	// }}}
1728	// {{{ function getConnection()
1729
1730	/**
1731	* Returns a native connection
1732	*
1733	* @return mixed a valid MDB2 connection object,
1734	* or a MDB2 error object on error
1735	*
1736	* @access public
1737	*/
1738	function getConnection()
1739	{
1740	$result = $this->connect();
1741	if (PEAR::isError($result)) {
1742	return $result;
1743	}
1744	return $this->connection;
1745	}
1746
1747	// }}}
1748	// {{{ function _fixResultArrayValues(&$row, $mode)
1749
1750	/**
1751	* Do all necessary conversions on result arrays to fix DBMS quirks
1752	*
1753	* @param array the array to be fixed (passed by reference)
1754	* @param array bit-wise addition of the required portability modes
1755	*
1756	* @return void
1757	*
1758	* @access protected
1759	*/
1760	function _fixResultArrayValues(&$row, $mode)
1761	{
1762	switch ($mode) {
1763	case MDB2_PORTABILITY_EMPTY_TO_NULL:
1764	foreach ($row as $key => $value) {
1765	if ($value === '') {
1766	$row[$key] = null;
1767	}
1768	}
1769	break;
1770	case MDB2_PORTABILITY_RTRIM:
1771	foreach ($row as $key => $value) {
1772	if (is_string($value)) {
1773	$row[$key] = rtrim($value);
1774	}
1775	}
1776	break;
1777	case MDB2_PORTABILITY_FIX_ASSOC_FIELD_NAMES:
1778	$tmp_row = array();
1779	foreach ($row as $key => $value) {
1780	$tmp_row[preg_replace('/^(?:.*\.)?([^.]+)$/', '\\1', $key)] = $value;
1781	}
1782	$row = $tmp_row;
1783	break;
1784	case (MDB2_PORTABILITY_RTRIM + MDB2_PORTABILITY_EMPTY_TO_NULL):
1785	foreach ($row as $key => $value) {
1786	if ($value === '') {
1787	$row[$key] = null;
1788	} elseif (is_string($value)) {
1789	$row[$key] = rtrim($value);
1790	}
1791	}
1792	break;
1793	case (MDB2_PORTABILITY_RTRIM + MDB2_PORTABILITY_FIX_ASSOC_FIELD_NAMES):
1794	$tmp_row = array();
1795	foreach ($row as $key => $value) {
1796	if (is_string($value)) {
1797	$value = rtrim($value);
1798	}
1799	$tmp_row[preg_replace('/^(?:.*\.)?([^.]+)$/', '\\1', $key)] = $value;
1800	}
1801	$row = $tmp_row;
1802	break;
1803	case (MDB2_PORTABILITY_EMPTY_TO_NULL + MDB2_PORTABILITY_FIX_ASSOC_FIELD_NAMES):
1804	$tmp_row = array();
1805	foreach ($row as $key => $value) {
1806	if ($value === '') {
1807	$value = null;
1808	}
1809	$tmp_row[preg_replace('/^(?:.*\.)?([^.]+)$/', '\\1', $key)] = $value;
1810	}
1811	$row = $tmp_row;
1812	break;
1813	case (MDB2_PORTABILITY_RTRIM + MDB2_PORTABILITY_EMPTY_TO_NULL + MDB2_PORTABILITY_FIX_ASSOC_FIELD_NAMES):
1814	$tmp_row = array();
1815	foreach ($row as $key => $value) {
1816	if ($value === '') {
1817	$value = null;
1818	} elseif (is_string($value)) {
1819	$value = rtrim($value);
1820	}
1821	$tmp_row[preg_replace('/^(?:.*\.)?([^.]+)$/', '\\1', $key)] = $value;
1822	}
1823	$row = $tmp_row;
1824	break;
1825	}
1826	}
1827
1828	// }}}
1829	// {{{ function &loadModule($module, $property = null, $phptype_specific = null)
1830
1831	/**
1832	* loads a module
1833	*
1834	* @param string name of the module that should be loaded
1835	* (only used for error messages)
1836	* @param string name of the property into which the class will be loaded
1837	* @param bool if the class to load for the module is specific to the
1838	* phptype
1839	*
1840	* @return object on success a reference to the given module is returned
1841	* and on failure a PEAR error
1842	*
1843	* @access public
1844	*/
1845	function &loadModule($module, $property = null, $phptype_specific = null)
1846	{
1847	if (!$property) {
1848	$property = strtolower($module);
1849	}
1850
1851	if (!isset($this->{$property})) {
1852	$version = $phptype_specific;
1853	if ($phptype_specific !== false) {
1854	$version = true;
1855	$class_name = 'MDB2_Driver_'.$module.'_'.$this->phptype;
1856	$file_name = str_replace('_', DIRECTORY_SEPARATOR, $class_name).'.php';
1857	}
1858	if ($phptype_specific === false
1859	\|\| (!MDB2::classExists($class_name) && !MDB2::fileExists($file_name))
1860	) {
1861	$version = false;
1862	$class_name = 'MDB2_'.$module;
1863	$file_name = str_replace('_', DIRECTORY_SEPARATOR, $class_name).'.php';
1864	}
1865
1866	sfprintr($class_name);
1867
1868	$err = MDB2::loadClass($class_name, $this->getOption('debug'));
1869	if (PEAR::isError($err)) {
1870	return $err;
1871	}
1872
1873	// load modul in a specific version
1874	if ($version) {
1875	if (method_exists($class_name, 'getClassName')) {
1876	$class_name_new = call_user_func(array($class_name, 'getClassName'), $this->db_index);
1877	if ($class_name != $class_name_new) {
1878	$class_name = $class_name_new;
1879	$err = MDB2::loadClass($class_name, $this->getOption('debug'));
1880	if (PEAR::isError($err)) {
1881	return $err;
1882	}
1883	}
1884	}
1885	}
1886
1887	if (!MDB2::classExists($class_name)) {
1888	$err =& $this->raiseError(MDB2_ERROR_LOADMODULE, null, null,
1889	"unable to load module '$module' into property '$property'", __FUNCTION__);
1890	return $err;
1891	}
1892	$this->{$property} =& new $class_name($this->db_index);
1893	$this->modules[$module] =& $this->{$property};
1894	if ($version) {
1895	// this will be used in the connect method to determine if the module
1896	// needs to be loaded with a different version if the server
1897	// version changed in between connects
1898	$this->loaded_version_modules[] = $property;
1899	}
1900	}
1901
1902	return $this->{$property};
1903	}
1904
1905	// }}}
1906	// {{{ function __call($method, $params)
1907
1908	/**
1909	* Calls a module method using the __call magic method
1910	*
1911	* @param string Method name.
1912	* @param array Arguments.
1913	*
1914	* @return mixed Returned value.
1915	*/
1916	function __call($method, $params)
1917	{
1918	$module = null;
1919	if (preg_match('/^([a-z]+)([A-Z])(.*)$/', $method, $match)
1920	&& isset($this->options['modules'][$match[1]])
1921	) {
1922	$module = $this->options['modules'][$match[1]];
1923	$method = strtolower($match[2]).$match[3];
1924	if (!isset($this->modules[$module]) \|\| !is_object($this->modules[$module])) {
1925	$result =& $this->loadModule($module);
1926	if (PEAR::isError($result)) {
1927	return $result;
1928	}
1929	}
1930	} else {
1931	foreach ($this->modules as $key => $foo) {
1932	if (is_object($this->modules[$key])
1933	&& method_exists($this->modules[$key], $method)
1934	) {
1935	$module = $key;
1936	break;
1937	}
1938	}
1939	}
1940	if (!is_null($module)) {
1941	return call_user_func_array(array(&$this->modules[$module], $method), $params);
1942	}
1943	trigger_error(sprintf('Call to undefined function: %s::%s().', get_class($this), $method), E_USER_ERROR);
1944	}
1945
1946	// }}}
1947	// {{{ function beginTransaction($savepoint = null)
1948
1949	/**
1950	* Start a transaction or set a savepoint.
1951	*
1952	* @param string name of a savepoint to set
1953	* @return mixed MDB2_OK on success, a MDB2 error on failure
1954	*
1955	* @access public
1956	*/
1957	function beginTransaction($savepoint = null)
1958	{
1959	$this->debug('Starting transaction', __FUNCTION__, array('is_manip' => true, 'savepoint' => $savepoint));
1960	return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
1961	'transactions are not supported', __FUNCTION__);
1962	}
1963
1964	// }}}
1965	// {{{ function commit($savepoint = null)
1966
1967	/**
1968	* Commit the database changes done during a transaction that is in
1969	* progress or release a savepoint. This function may only be called when
1970	* auto-committing is disabled, otherwise it will fail. Therefore, a new
1971	* transaction is implicitly started after committing the pending changes.
1972	*
1973	* @param string name of a savepoint to release
1974	* @return mixed MDB2_OK on success, a MDB2 error on failure
1975	*
1976	* @access public
1977	*/
1978	function commit($savepoint = null)
1979	{
1980	$this->debug('Committing transaction/savepoint', __FUNCTION__, array('is_manip' => true, 'savepoint' => $savepoint));
1981	return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
1982	'commiting transactions is not supported', __FUNCTION__);
1983	}
1984
1985	// }}}
1986	// {{{ function rollback($savepoint = null)
1987
1988	/**
1989	* Cancel any database changes done during a transaction or since a specific
1990	* savepoint that is in progress. This function may only be called when
1991	* auto-committing is disabled, otherwise it will fail. Therefore, a new
1992	* transaction is implicitly started after canceling the pending changes.
1993	*
1994	* @param string name of a savepoint to rollback to
1995	* @return mixed MDB2_OK on success, a MDB2 error on failure
1996	*
1997	* @access public
1998	*/
1999	function rollback($savepoint = null)
2000	{
2001	$this->debug('Rolling back transaction/savepoint', __FUNCTION__, array('is_manip' => true, 'savepoint' => $savepoint));
2002	return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2003	'rolling back transactions is not supported', __FUNCTION__);
2004	}
2005
2006	// }}}
2007	// {{{ function inTransaction($ignore_nested = false)
2008
2009	/**
2010	* If a transaction is currently open.
2011	*
2012	* @param bool if the nested transaction count should be ignored
2013	* @return int\|bool - an integer with the nesting depth is returned if a
2014	* nested transaction is open
2015	* - true is returned for a normal open transaction
2016	* - false is returned if no transaction is open
2017	*
2018	* @access public
2019	*/
2020	function inTransaction($ignore_nested = false)
2021	{
2022	if (!$ignore_nested && isset($this->nested_transaction_counter)) {
2023	return $this->nested_transaction_counter;
2024	}
2025	return $this->in_transaction;
2026	}
2027
2028	// }}}
2029	// {{{ function setTransactionIsolation($isolation)
2030
2031	/**
2032	* Set the transacton isolation level.
2033	*
2034	* @param string standard isolation level
2035	* READ UNCOMMITTED (allows dirty reads)
2036	* READ COMMITTED (prevents dirty reads)
2037	* REPEATABLE READ (prevents nonrepeatable reads)
2038	* SERIALIZABLE (prevents phantom reads)
2039	* @param array some transaction options:
2040	* 'wait' => 'WAIT' \| 'NO WAIT'
2041	* 'rw' => 'READ WRITE' \| 'READ ONLY'
2042	* @return mixed MDB2_OK on success, a MDB2 error on failure
2043	*
2044	* @access public
2045	* @since 2.1.1
2046	*/
2047	function setTransactionIsolation($isolation, $options = array())
2048	{
2049	$this->debug('Setting transaction isolation level', __FUNCTION__, array('is_manip' => true));
2050	return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2051	'isolation level setting is not supported', __FUNCTION__);
2052	}
2053
2054	// }}}
2055	// {{{ function beginNestedTransaction($savepoint = false)
2056
2057	/**
2058	* Start a nested transaction.
2059	*
2060	* EXPERIMENTAL
2061	*
2062	* WARNING: this function is experimental and may change signature at
2063	* any time until labelled as non-experimental
2064	*
2065	* @return mixed MDB2_OK on success/savepoint name, a MDB2 error on failure
2066	*
2067	* @access public
2068	* @since 2.1.1
2069	*/
2070	function beginNestedTransaction()
2071	{
2072	if ($this->in_transaction) {
2073	++$this->nested_transaction_counter;
2074	$savepoint = sprintf($this->options['savepoint_format'], $this->nested_transaction_counter);
2075	if ($this->supports('savepoints') && $savepoint) {
2076	return $this->beginTransaction($savepoint);
2077	}
2078	return MDB2_OK;
2079	}
2080	$this->has_transaction_error = false;
2081	$result = $this->beginTransaction();
2082	$this->nested_transaction_counter = 1;
2083	return $result;
2084	}
2085
2086	// }}}
2087	// {{{ function completeNestedTransaction($force_rollback = false, $release = false)
2088
2089	/**
2090	* Finish a nested transaction by rolling back if an error occured or
2091	* committing otherwise.
2092	*
2093	* EXPERIMENTAL
2094	*
2095	* WARNING: this function is experimental and may change signature at
2096	* any time until labelled as non-experimental
2097	*
2098	* @param bool if the transaction should be rolled back regardless
2099	* even if no error was set within the nested transaction
2100	* @return mixed MDB_OK on commit/counter decrementing, false on rollback
2101	* and a MDB2 error on failure
2102	*
2103	* @access public
2104	* @since 2.1.1
2105	*/
2106	function completeNestedTransaction($force_rollback = false)
2107	{
2108	if ($this->nested_transaction_counter > 1) {
2109	$savepoint = sprintf($this->options['savepoint_format'], $this->nested_transaction_counter);
2110	if ($this->supports('savepoints') && $savepoint) {
2111	if ($force_rollback \|\| $this->has_transaction_error) {
2112	$result = $this->rollback($savepoint);
2113	if (!PEAR::isError($result)) {
2114	$result = false;
2115	$this->has_transaction_error = false;
2116	}
2117	} else {
2118	$result = $this->commit($savepoint);
2119	}
2120	} else {
2121	$result = MDB2_OK;
2122	}
2123	--$this->nested_transaction_counter;
2124	return $result;
2125	}
2126
2127	$this->nested_transaction_counter = null;
2128	$result = MDB2_OK;
2129
2130	// transaction has not yet been rolled back
2131	if ($this->in_transaction) {
2132	if ($force_rollback \|\| $this->has_transaction_error) {
2133	$result = $this->rollback();
2134	if (!PEAR::isError($result)) {
2135	$result = false;
2136	}
2137	} else {
2138	$result = $this->commit();
2139	}
2140	}
2141	$this->has_transaction_error = false;
2142	return $result;
2143	}
2144
2145	// }}}
2146	// {{{ function failNestedTransaction($error = null, $immediately = false)
2147
2148	/**
2149	* Force setting nested transaction to failed.
2150	*
2151	* EXPERIMENTAL
2152	*
2153	* WARNING: this function is experimental and may change signature at
2154	* any time until labelled as non-experimental
2155	*
2156	* @param mixed value to return in getNestededTransactionError()
2157	* @param bool if the transaction should be rolled back immediately
2158	* @return bool MDB2_OK
2159	*
2160	* @access public
2161	* @since 2.1.1
2162	*/
2163	function failNestedTransaction($error = null, $immediately = false)
2164	{
2165	if (is_null($error)) {
2166	$error = $this->has_transaction_error ? $this->has_transaction_error : true;
2167	} elseif (!$error) {
2168	$error = true;
2169	}
2170	$this->has_transaction_error = $error;
2171	if (!$immediately) {
2172	return MDB2_OK;
2173	}
2174	return $this->rollback();
2175	}
2176
2177	// }}}
2178	// {{{ function getNestedTransactionError()
2179
2180	/**
2181	* The first error that occured since the transaction start.
2182	*
2183	* EXPERIMENTAL
2184	*
2185	* WARNING: this function is experimental and may change signature at
2186	* any time until labelled as non-experimental
2187	*
2188	* @return MDB2_Error\|bool MDB2 error object if an error occured or false.
2189	*
2190	* @access public
2191	* @since 2.1.1
2192	*/
2193	function getNestedTransactionError()
2194	{
2195	return $this->has_transaction_error;
2196	}
2197
2198	// }}}
2199	// {{{ connect()
2200
2201	/**
2202	* Connect to the database
2203	*
2204	* @return true on success, MDB2 Error Object on failure
2205	*/
2206	function connect()
2207	{
2208	return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2209	'method not implemented', __FUNCTION__);
2210	}
2211
2212	// }}}
2213	// {{{ setCharset($charset, $connection = null)
2214
2215	/**
2216	* Set the charset on the current connection
2217	*
2218	* @param string charset
2219	* @param resource connection handle
2220	*
2221	* @return true on success, MDB2 Error Object on failure
2222	*/
2223	function setCharset($charset, $connection = null)
2224	{
2225	return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2226	'method not implemented', __FUNCTION__);
2227	}
2228
2229	// }}}
2230	// {{{ function disconnect($force = true)
2231
2232	/**
2233	* Log out and disconnect from the database.
2234	*
2235	* @param bool if the disconnect should be forced even if the
2236	* connection is opened persistently
2237	*
2238	* @return mixed true on success, false if not connected and error
2239	* object on error
2240	*
2241	* @access public
2242	*/
2243	function disconnect($force = true)
2244	{
2245	$this->connection = 0;
2246	$this->connected_dsn = array();
2247	$this->connected_database_name = '';
2248	$this->opened_persistent = null;
2249	$this->connected_server_info = '';
2250	$this->in_transaction = null;
2251	$this->nested_transaction_counter = null;
2252	return MDB2_OK;
2253	}
2254
2255	// }}}
2256	// {{{ function setDatabase($name)
2257
2258	/**
2259	* Select a different database
2260	*
2261	* @param string name of the database that should be selected
2262	*
2263	* @return string name of the database previously connected to
2264	*
2265	* @access public
2266	*/
2267	function setDatabase($name)
2268	{
2269	$previous_database_name = (isset($this->database_name)) ? $this->database_name : '';
2270	$this->database_name = $name;
2271	$this->disconnect(false);
2272	return $previous_database_name;
2273	}
2274
2275	// }}}
2276	// {{{ function getDatabase()
2277
2278	/**
2279	* Get the current database
2280	*
2281	* @return string name of the database
2282	*
2283	* @access public
2284	*/
2285	function getDatabase()
2286	{
2287	return $this->database_name;
2288	}
2289
2290	// }}}
2291	// {{{ function setDSN($dsn)
2292
2293	/**
2294	* set the DSN
2295	*
2296	* @param mixed DSN string or array
2297	*
2298	* @return MDB2_OK
2299	*
2300	* @access public
2301	*/
2302	function setDSN($dsn)
2303	{
2304	$dsn_default = $GLOBALS['_MDB2_dsninfo_default'];
2305	$dsn = MDB2::parseDSN($dsn);
2306	if (array_key_exists('database', $dsn)) {
2307	$this->database_name = $dsn['database'];
2308	unset($dsn['database']);
2309	}
2310	$this->dsn = array_merge($dsn_default, $dsn);
2311	return $this->disconnect(false);
2312	}
2313
2314	// }}}
2315	// {{{ function getDSN($type = 'string', $hidepw = false)
2316
2317	/**
2318	* return the DSN as a string
2319	*
2320	* @param string format to return ("array", "string")
2321	* @param string string to hide the password with
2322	*
2323	* @return mixed DSN in the chosen type
2324	*
2325	* @access public
2326	*/
2327	function getDSN($type = 'string', $hidepw = false)
2328	{
2329	$dsn = array_merge($GLOBALS['_MDB2_dsninfo_default'], $this->dsn);
2330	$dsn['phptype'] = $this->phptype;
2331	$dsn['database'] = $this->database_name;
2332	if ($hidepw) {
2333	$dsn['password'] = $hidepw;
2334	}
2335	switch ($type) {
2336	// expand to include all possible options
2337	case 'string':
2338	$dsn = $dsn['phptype'].
2339	($dsn['dbsyntax'] ? ('('.$dsn['dbsyntax'].')') : '').
2340	'://'.$dsn['username'].':'.
2341	$dsn['password'].'@'.$dsn['hostspec'].
2342	($dsn['port'] ? (':'.$dsn['port']) : '').
2343	'/'.$dsn['database'];
2344	break;
2345	case 'array':
2346	default:
2347	break;
2348	}
2349	return $dsn;
2350	}
2351
2352	// }}}
2353	// {{{ function &standaloneQuery($query, $types = null, $is_manip = false)
2354
2355	/**
2356	* execute a query as database administrator
2357	*
2358	* @param string the SQL query
2359	* @param mixed array that contains the types of the columns in
2360	* the result set
2361	* @param bool if the query is a manipulation query
2362	*
2363	* @return mixed MDB2_OK on success, a MDB2 error on failure
2364	*
2365	* @access public
2366	*/
2367	function &standaloneQuery($query, $types = null, $is_manip = false)
2368	{
2369	$offset = $this->offset;
2370	$limit = $this->limit;
2371	$this->offset = $this->limit = 0;
2372	$query = $this->_modifyQuery($query, $is_manip, $limit, $offset);
2373
2374	$connection = $this->getConnection();
2375	if (PEAR::isError($connection)) {
2376	return $connection;
2377	}
2378
2379	$result =& $this->_doQuery($query, $is_manip, $connection, false);
2380	if (PEAR::isError($result)) {
2381	return $result;
2382	}
2383
2384	if ($is_manip) {
2385	$affected_rows = $this->_affectedRows($connection, $result);
2386	return $affected_rows;
2387	}
2388	$result =& $this->_wrapResult($result, $types, true, false, $limit, $offset);
2389	return $result;
2390	}
2391
2392	// }}}
2393	// {{{ function _modifyQuery($query, $is_manip, $limit, $offset)
2394
2395	/**
2396	* Changes a query string for various DBMS specific reasons
2397	*
2398	* @param string query to modify
2399	* @param bool if it is a DML query
2400	* @param int limit the number of rows
2401	* @param int start reading from given offset
2402	*
2403	* @return string modified query
2404	*
2405	* @access protected
2406	*/
2407	function _modifyQuery($query, $is_manip, $limit, $offset)
2408	{
2409	return $query;
2410	}
2411
2412	// }}}
2413	// {{{ function &_doQuery($query, $is_manip = false, $connection = null, $database_name = null)
2414
2415	/**
2416	* Execute a query
2417	* @param string query
2418	* @param bool if the query is a manipulation query
2419	* @param resource connection handle
2420	* @param string database name
2421	*
2422	* @return result or error object
2423	*
2424	* @access protected
2425	*/
2426	function &_doQuery($query, $is_manip = false, $connection = null, $database_name = null)
2427	{
2428	$this->last_query = $query;
2429	$result = $this->debug($query, 'query', array('is_manip' => $is_manip, 'when' => 'pre'));
2430	if ($result) {
2431	if (PEAR::isError($result)) {
2432	return $result;
2433	}
2434	$query = $result;
2435	}
2436	$err =& $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2437	'method not implemented', __FUNCTION__);
2438	return $err;
2439	}
2440
2441	// }}}
2442	// {{{ function _affectedRows($connection, $result = null)
2443
2444	/**
2445	* Returns the number of rows affected
2446	*
2447	* @param resource result handle
2448	* @param resource connection handle
2449	*
2450	* @return mixed MDB2 Error Object or the number of rows affected
2451	*
2452	* @access private
2453	*/
2454	function _affectedRows($connection, $result = null)
2455	{
2456	return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2457	'method not implemented', __FUNCTION__);
2458	}
2459
2460	// }}}
2461	// {{{ function &exec($query)
2462
2463	/**
2464	* Execute a manipulation query to the database and return the number of affected rows
2465	*
2466	* @param string the SQL query
2467	*
2468	* @return mixed number of affected rows on success, a MDB2 error on failure
2469	*
2470	* @access public
2471	*/
2472	function &exec($query)
2473	{
2474	$offset = $this->offset;
2475	$limit = $this->limit;
2476	$this->offset = $this->limit = 0;
2477	$query = $this->_modifyQuery($query, true, $limit, $offset);
2478
2479	$connection = $this->getConnection();
2480	if (PEAR::isError($connection)) {
2481	return $connection;
2482	}
2483
2484	$result =& $this->_doQuery($query, true, $connection, $this->database_name);
2485	if (PEAR::isError($result)) {
2486	return $result;
2487	}
2488
2489	$affectedRows = $this->_affectedRows($connection, $result);
2490	return $affectedRows;
2491	}
2492
2493	// }}}
2494	// {{{ function &query($query, $types = null, $result_class = true, $result_wrap_class = false)
2495
2496	/**
2497	* Send a query to the database and return any results
2498	*
2499	* @param string the SQL query
2500	* @param mixed array that contains the types of the columns in
2501	* the result set
2502	* @param mixed string which specifies which result class to use
2503	* @param mixed string which specifies which class to wrap results in
2504	*
2505	* @return mixed an MDB2_Result handle on success, a MDB2 error on failure
2506	*
2507	* @access public
2508	*/
2509	function &query($query, $types = null, $result_class = true, $result_wrap_class = false)
2510	{
2511	$offset = $this->offset;
2512	$limit = $this->limit;
2513	$this->offset = $this->limit = 0;
2514	$query = $this->_modifyQuery($query, false, $limit, $offset);
2515
2516	$connection = $this->getConnection();
2517	if (PEAR::isError($connection)) {
2518	return $connection;
2519	}
2520
2521	$result =& $this->_doQuery($query, false, $connection, $this->database_name);
2522	if (PEAR::isError($result)) {
2523	return $result;
2524	}
2525
2526	$result =& $this->_wrapResult($result, $types, $result_class, $result_wrap_class, $limit, $offset);
2527	return $result;
2528	}
2529
2530	// }}}
2531	// {{{ function &_wrapResult($result, $types = array(), $result_class = true, $result_wrap_class = false, $limit = null, $offset = null)
2532
2533	/**
2534	* wrap a result set into the correct class
2535	*
2536	* @param resource result handle
2537	* @param mixed array that contains the types of the columns in
2538	* the result set
2539	* @param mixed string which specifies which result class to use
2540	* @param mixed string which specifies which class to wrap results in
2541	* @param string number of rows to select
2542	* @param string first row to select
2543	*
2544	* @return mixed an MDB2_Result, a MDB2 error on failure
2545	*
2546	* @access protected
2547	*/
2548	function &_wrapResult($result, $types = array(), $result_class = true,
2549	$result_wrap_class = false, $limit = null, $offset = null)
2550	{
2551	if ($types === true) {
2552	if ($this->supports('result_introspection')) {
2553	$this->loadModule('Reverse', null, true);
2554	$tableInfo = $this->reverse->tableInfo($result);
2555	if (PEAR::isError($tableInfo)) {
2556	return $tableInfo;
2557	}
2558	$types = array();
2559	foreach ($tableInfo as $field) {
2560	$types[] = $field['mdb2type'];
2561	}
2562	} else {
2563	$types = null;
2564	}
2565	}
2566
2567	if ($result_class === true) {
2568	$result_class = $this->options['result_buffering']
2569	? $this->options['buffered_result_class'] : $this->options['result_class'];
2570	}
2571
2572	if ($result_class) {
2573	$class_name = sprintf($result_class, $this->phptype);
2574	if (!MDB2::classExists($class_name)) {
2575	$err =& $this->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
2576	'result class does not exist '.$class_name, __FUNCTION__);
2577	return $err;
2578	}
2579	$result =& new $class_name($this, $result, $limit, $offset);
2580	if (!MDB2::isResultCommon($result)) {
2581	$err =& $this->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
2582	'result class is not extended from MDB2_Result_Common', __FUNCTION__);
2583	return $err;
2584	}
2585	if (!empty($types)) {
2586	$err = $result->setResultTypes($types);
2587	if (PEAR::isError($err)) {
2588	$result->free();
2589	return $err;
2590	}
2591	}
2592	}
2593	if ($result_wrap_class === true) {
2594	$result_wrap_class = $this->options['result_wrap_class'];
2595	}
2596	if ($result_wrap_class) {
2597	if (!MDB2::classExists($result_wrap_class)) {
2598	$err =& $this->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
2599	'result wrap class does not exist '.$result_wrap_class, __FUNCTION__);
2600	return $err;
2601	}
2602	$result =& new $result_wrap_class($result, $this->fetchmode);
2603	}
2604	return $result;
2605	}
2606
2607	// }}}
2608	// {{{ function getServerVersion($native = false)
2609
2610	/**
2611	* return version information about the server
2612	*
2613	* @param bool determines if the raw version string should be returned
2614	*
2615	* @return mixed array with version information or row string
2616	*
2617	* @access public
2618	*/
2619	function getServerVersion($native = false)
2620	{
2621	return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2622	'method not implemented', __FUNCTION__);
2623	}
2624
2625	// }}}
2626	// {{{ function setLimit($limit, $offset = null)
2627
2628	/**
2629	* set the range of the next query
2630	*
2631	* @param string number of rows to select
2632	* @param string first row to select
2633	*
2634	* @return mixed MDB2_OK on success, a MDB2 error on failure
2635	*
2636	* @access public
2637	*/
2638	function setLimit($limit, $offset = null)
2639	{
2640	if (!$this->supports('limit_queries')) {
2641	return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2642	'limit is not supported by this driver', __FUNCTION__);
2643	}
2644	$limit = (int)$limit;
2645	if ($limit < 0) {
2646	return $this->raiseError(MDB2_ERROR_SYNTAX, null, null,
2647	'it was not specified a valid selected range row limit', __FUNCTION__);
2648	}
2649	$this->limit = $limit;
2650	if (!is_null($offset)) {
2651	$offset = (int)$offset;
2652	if ($offset < 0) {
2653	return $this->raiseError(MDB2_ERROR_SYNTAX, null, null,
2654	'it was not specified a valid first selected range row', __FUNCTION__);
2655	}
2656	$this->offset = $offset;
2657	}
2658	return MDB2_OK;
2659	}
2660
2661	// }}}
2662	// {{{ function subSelect($query, $type = false)
2663
2664	/**
2665	* simple subselect emulation: leaves the query untouched for all RDBMS
2666	* that support subselects
2667	*
2668	* @param string the SQL query for the subselect that may only
2669	* return a column
2670	* @param string determines type of the field
2671	*
2672	* @return string the query
2673	*
2674	* @access public
2675	*/
2676	function subSelect($query, $type = false)
2677	{
2678	if ($this->supports('sub_selects') === true) {
2679	return $query;
2680	}
2681
2682	if (!$this->supports('sub_selects')) {
2683	return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2684	'method not implemented', __FUNCTION__);
2685	}
2686
2687	$col = $this->queryCol($query, $type);
2688	if (PEAR::isError($col)) {
2689	return $col;
2690	}
2691	if (!is_array($col) \|\| count($col) == 0) {
2692	return 'NULL';
2693	}
2694	if ($type) {
2695	$this->loadModule('Datatype', null, true);
2696	return $this->datatype->implodeArray($col, $type);
2697	}
2698	return implode(', ', $col);
2699	}
2700
2701	// }}}
2702	// {{{ function replace($table, $fields)
2703
2704	/**
2705	* Execute a SQL REPLACE query. A REPLACE query is identical to a INSERT
2706	* query, except that if there is already a row in the table with the same
2707	* key field values, the REPLACE query just updates its values instead of
2708	* inserting a new row.
2709	*
2710	* The REPLACE type of query does not make part of the SQL standards. Since
2711	* practically only MySQL and SQLite implement it natively, this type of
2712	* query isemulated through this method for other DBMS using standard types
2713	* of queries inside a transaction to assure the atomicity of the operation.
2714	*
2715	* @param string name of the table on which the REPLACE query will
2716	* be executed.
2717	* @param array associative array that describes the fields and the
2718	* values that will be inserted or updated in the specified table. The
2719	* indexes of the array are the names of all the fields of the table.
2720	* The values of the array are also associative arrays that describe
2721	* the values and other properties of the table fields.
2722	*
2723	* Here follows a list of field properties that need to be specified:
2724	*
2725	* value
2726	* Value to be assigned to the specified field. This value may be
2727	* of specified in database independent type format as this
2728	* function can perform the necessary datatype conversions.
2729	*
2730	* Default: this property is required unless the Null property is
2731	* set to 1.
2732	*
2733	* type
2734	* Name of the type of the field. Currently, all types MDB2
2735	* are supported except for clob and blob.
2736	*
2737	* Default: no type conversion
2738	*
2739	* null
2740	* bool property that indicates that the value for this field
2741	* should be set to null.
2742	*
2743	* The default value for fields missing in INSERT queries may be
2744	* specified the definition of a table. Often, the default value
2745	* is already null, but since the REPLACE may be emulated using
2746	* an UPDATE query, make sure that all fields of the table are
2747	* listed in this function argument array.
2748	*
2749	* Default: 0
2750	*
2751	* key
2752	* bool property that indicates that this field should be
2753	* handled as a primary key or at least as part of the compound
2754	* unique index of the table that will determine the row that will
2755	* updated if it exists or inserted a new row otherwise.
2756	*
2757	* This function will fail if no key field is specified or if the
2758	* value of a key field is set to null because fields that are
2759	* part of unique index they may not be null.
2760	*
2761	* Default: 0
2762	*
2763	* @return mixed MDB2_OK on success, a MDB2 error on failure
2764	*
2765	* @access public
2766	*/
2767	function replace($table, $fields)
2768	{
2769	if (!$this->supports('replace')) {
2770	return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2771	'replace query is not supported', __FUNCTION__);
2772	}
2773	$count = count($fields);
2774	$condition = $values = array();
2775	for ($colnum = 0, reset($fields); $colnum < $count; next($fields), $colnum++) {
2776	$name = key($fields);
2777	if (isset($fields[$name]['null']) && $fields[$name]['null']) {
2778	$value = 'NULL';
2779	} else {
2780	$type = isset($fields[$name]['type']) ? $fields[$name]['type'] : null;
2781	$value = $this->quote($fields[$name]['value'], $type);
2782	}
2783	$values[$name] = $value;
2784	if (isset($fields[$name]['key']) && $fields[$name]['key']) {
2785	if ($value === 'NULL') {
2786	return $this->raiseError(MDB2_ERROR_CANNOT_REPLACE, null, null,
2787	'key value '.$name.' may not be NULL', __FUNCTION__);
2788	}
2789	$condition[] = $name . '=' . $value;
2790	}
2791	}
2792	if (empty($condition)) {
2793	return $this->raiseError(MDB2_ERROR_CANNOT_REPLACE, null, null,
2794	'not specified which fields are keys', __FUNCTION__);
2795	}
2796
2797	$result = null;
2798	$in_transaction = $this->in_transaction;
2799	if (!$in_transaction && PEAR::isError($result = $this->beginTransaction())) {
2800	return $result;
2801	}
2802
2803	$connection = $this->getConnection();
2804	if (PEAR::isError($connection)) {
2805	return $connection;
2806	}
2807
2808	$condition = ' WHERE '.implode(' AND ', $condition);
2809	$query = "DELETE FROM $table$condition";
2810	$result =& $this->_doQuery($query, true, $connection);
2811	if (!PEAR::isError($result)) {
2812	$affected_rows = $this->_affectedRows($connection, $result);
2813	$insert = implode(', ', array_keys($values));
2814	$values = implode(', ', $values);
2815	$query = "INSERT INTO $table ($insert) VALUES ($values)";
2816	$result =& $this->_doQuery($query, true, $connection);
2817	if (!PEAR::isError($result)) {
2818	$affected_rows += $this->_affectedRows($connection, $result);;
2819	}
2820	}
2821
2822	if (!$in_transaction) {
2823	if (PEAR::isError($result)) {
2824	$this->rollback();
2825	} else {
2826	$result = $this->commit();
2827	}
2828	}
2829
2830	if (PEAR::isError($result)) {
2831	return $result;
2832	}
2833
2834	return $affected_rows;
2835	}
2836
2837	// }}}
2838	// {{{ function &prepare($query, $types = null, $result_types = null, $lobs = array())
2839
2840	/**
2841	* Prepares a query for multiple execution with execute().
2842	* With some database backends, this is emulated.
2843	* prepare() requires a generic query as string like
2844	* 'INSERT INTO numbers VALUES(?,?)' or
2845	* 'INSERT INTO numbers VALUES(:foo,:bar)'.
2846	* The ? and :[a-zA-Z] and are placeholders which can be set using
2847	* bindParam() and the query can be send off using the execute() method.
2848	*
2849	* @param string the query to prepare
2850	* @param mixed array that contains the types of the placeholders
2851	* @param mixed array that contains the types of the columns in
2852	* the result set or MDB2_PREPARE_RESULT, if set to
2853	* MDB2_PREPARE_MANIP the query is handled as a manipulation query
2854	* @param mixed key (field) value (parameter) pair for all lob placeholders
2855	*
2856	* @return mixed resource handle for the prepared query on success,
2857	* a MDB2 error on failure
2858	*
2859	* @access public
2860	* @see bindParam, execute
2861	*/
2862	function &prepare($query, $types = null, $result_types = null, $lobs = array())
2863	{
2864	$is_manip = ($result_types === MDB2_PREPARE_MANIP);
2865	$offset = $this->offset;
2866	$limit = $this->limit;
2867	$this->offset = $this->limit = 0;
2868	$result = $this->debug($query, __FUNCTION__, array('is_manip' => $is_manip, 'when' => 'pre'));
2869	if ($result) {
2870	if (PEAR::isError($result)) {
2871	return $result;
2872	}
2873	$query = $result;
2874	}
2875	$placeholder_type_guess = $placeholder_type = null;
2876	$question = '?';
2877	$colon = ':';
2878	$positions = array();
2879	$position = 0;
2880	$ignores = $this->sql_comments;
2881	$ignores[] = $this->string_quoting;
2882	$ignores[] = $this->identifier_quoting;
2883	while ($position < strlen($query)) {
2884	$q_position = strpos($query, $question, $position);
2885	$c_position = strpos($query, $colon, $position);
2886	if ($q_position && $c_position) {
2887	$p_position = min($q_position, $c_position);
2888	} elseif ($q_position) {
2889	$p_position = $q_position;
2890	} elseif ($c_position) {
2891	$p_position = $c_position;
2892	} else {
2893	break;
2894	}
2895	if (is_null($placeholder_type)) {
2896	$placeholder_type_guess = $query[$p_position];
2897	}
2898
2899	$new_pos = $this->_skipDelimitedStrings($query, $position, $p_position);
2900	if (PEAR::isError($new_pos)) {
2901	return $new_pos;
2902	}
2903	if ($new_pos != $position) {
2904	$position = $new_pos;
2905	continue; //evaluate again starting from the new position
2906	}
2907
2908	if ($query[$position] == $placeholder_type_guess) {
2909	if (is_null($placeholder_type)) {
2910	$placeholder_type = $query[$p_position];
2911	$question = $colon = $placeholder_type;
2912	if (!empty($types) && is_array($types)) {
2913	if ($placeholder_type == ':') {
2914	if (is_int(key($types))) {
2915	$types_tmp = $types;
2916	$types = array();
2917	$count = -1;
2918	}
2919	} else {
2920	$types = array_values($types);
2921	}
2922	}
2923	}
2924	if ($placeholder_type == ':') {
2925	$parameter = preg_replace('/^.{'.($position+1).'}([a-z0-9_]+).*$/si', '\\1', $query);
2926	if ($parameter === '') {
2927	$err =& $this->raiseError(MDB2_ERROR_SYNTAX, null, null,
2928	'named parameter with an empty name', __FUNCTION__);
2929	return $err;
2930	}
2931	$positions[$p_position] = $parameter;
2932	$query = substr_replace($query, '?', $position, strlen($parameter)+1);
2933	// use parameter name in type array
2934	if (isset($count) && isset($types_tmp[++$count])) {
2935	$types[$parameter] = $types_tmp[$count];
2936	}
2937	} else {
2938	$positions[$p_position] = count($positions);
2939	}
2940	$position = $p_position + 1;
2941	} else {
2942	$position = $p_position;
2943	}
2944	}
2945	$class_name = 'MDB2_Statement_'.$this->phptype;
2946	$statement = null;
2947	$obj =& new $class_name($this, $statement, $positions, $query, $types, $result_types, $is_manip, $limit, $offset);
2948	$this->debug($query, __FUNCTION__, array('is_manip' => $is_manip, 'when' => 'post', 'result' => $obj));
2949	return $obj;
2950	}
2951
2952	// }}}
2953	// {{{ function _skipDelimitedStrings($query, $position, $p_position)
2954
2955	/**
2956	* Utility method, used by prepare() to avoid replacing placeholders within delimited strings.
2957	* Check if the placeholder is contained within a delimited string.
2958	* If so, skip it and advance the position, otherwise return the current position,
2959	* which is valid
2960	*
2961	* @param string $query
2962	* @param integer $position current string cursor position
2963	* @param integer $p_position placeholder position
2964	*
2965	* @return mixed integer $new_position on success
2966	* MDB2_Error on failure
2967	*
2968	* @access protected
2969	*/
2970	function _skipDelimitedStrings($query, $position, $p_position)
2971	{
2972	$ignores = $this->sql_comments;
2973	$ignores[] = $this->string_quoting;
2974	$ignores[] = $this->identifier_quoting;
2975
2976	foreach ($ignores as $ignore) {
2977	if (!empty($ignore['start'])) {
2978	if (is_int($start_quote = strpos($query, $ignore['start'], $position)) && $start_quote < $p_position) {
2979	$end_quote = $start_quote;
2980	do {
2981	if (!is_int($end_quote = strpos($query, $ignore['end'], $end_quote + 1))) {
2982	if ($ignore['end'] === "\n") {
2983	$end_quote = strlen($query) - 1;
2984	} else {
2985	$err =& $this->raiseError(MDB2_ERROR_SYNTAX, null, null,
2986	'query with an unterminated text string specified', __FUNCTION__);
2987	return $err;
2988	}
2989	}
2990	} while ($ignore['escape'] && $query[($end_quote - 1)] == $ignore['escape']);
2991	$position = $end_quote + 1;
2992	return $position;
2993	}
2994	}
2995	}
2996	return $position;
2997	}
2998
2999	// }}}
3000	// {{{ function quote($value, $type = null, $quote = true)
3001
3002	/**
3003	* Convert a text value into a DBMS specific format that is suitable to
3004	* compose query statements.
3005	*
3006	* @param string text string value that is intended to be converted.
3007	* @param string type to which the value should be converted to
3008	* @param bool quote
3009	* @param bool escape wildcards
3010	*
3011	* @return string text string that represents the given argument value in
3012	* a DBMS specific format.
3013	*
3014	* @access public
3015	*/
3016	function quote($value, $type = null, $quote = true, $escape_wildcards = false)
3017	{
3018	$result = $this->loadModule('Datatype', null, true);
3019	if (PEAR::isError($result)) {
3020	return $result;
3021	}
3022
3023	return $this->datatype->quote($value, $type, $quote, $escape_wildcards);
3024	}
3025
3026	// }}}
3027	// {{{ function getDeclaration($type, $name, $field)
3028
3029	/**
3030	* Obtain DBMS specific SQL code portion needed to declare
3031	* of the given type
3032	*
3033	* @param string type to which the value should be converted to
3034	* @param string name the field to be declared.
3035	* @param string definition of the field
3036	*
3037	* @return string DBMS specific SQL code portion that should be used to
3038	* declare the specified field.
3039	*
3040	* @access public
3041	*/
3042	function getDeclaration($type, $name, $field)
3043	{
3044	$result = $this->loadModule('Datatype', null, true);
3045	if (PEAR::isError($result)) {
3046	return $result;
3047	}
3048	return $this->datatype->getDeclaration($type, $name, $field);
3049	}
3050
3051	// }}}
3052	// {{{ function compareDefinition($current, $previous)
3053
3054	/**
3055	* Obtain an array of changes that may need to applied
3056	*
3057	* @param array new definition
3058	* @param array old definition
3059	*
3060	* @return array containing all changes that will need to be applied
3061	*
3062	* @access public
3063	*/
3064	function compareDefinition($current, $previous)
3065	{
3066	$result = $this->loadModule('Datatype', null, true);
3067	if (PEAR::isError($result)) {
3068	return $result;
3069	}
3070	return $this->datatype->compareDefinition($current, $previous);
3071	}
3072
3073	// }}}
3074	// {{{ function supports($feature)
3075
3076	/**
3077	* Tell whether a DB implementation or its backend extension
3078	* supports a given feature.
3079	*
3080	* @param string name of the feature (see the MDB2 class doc)
3081	*
3082	* @return bool\|string if this DB implementation supports a given feature
3083	* false means no, true means native,
3084	* 'emulated' means emulated
3085	*
3086	* @access public
3087	*/
3088	function supports($feature)
3089	{
3090	if (array_key_exists($feature, $this->supported)) {
3091	return $this->supported[$feature];
3092	}
3093	return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3094	"unknown support feature $feature", __FUNCTION__);
3095	}
3096
3097	// }}}
3098	// {{{ function getSequenceName($sqn)
3099
3100	/**
3101	* adds sequence name formatting to a sequence name
3102	*
3103	* @param string name of the sequence
3104	*
3105	* @return string formatted sequence name
3106	*
3107	* @access public
3108	*/
3109	function getSequenceName($sqn)
3110	{
3111	return sprintf($this->options['seqname_format'],
3112	preg_replace('/[^a-z0-9_\$.]/i', '_', $sqn));
3113	}
3114
3115	// }}}
3116	// {{{ function getIndexName($idx)
3117
3118	/**
3119	* adds index name formatting to a index name
3120	*
3121	* @param string name of the index
3122	*
3123	* @return string formatted index name
3124	*
3125	* @access public
3126	*/
3127	function getIndexName($idx)
3128	{
3129	return sprintf($this->options['idxname_format'],
3130	preg_replace('/[^a-z0-9_\$]/i', '_', $idx));
3131	}
3132
3133	// }}}
3134	// {{{ function nextID($seq_name, $ondemand = true)
3135
3136	/**
3137	* Returns the next free id of a sequence
3138	*
3139	* @param string name of the sequence
3140	* @param bool when true missing sequences are automatic created
3141	*
3142	* @return mixed MDB2 Error Object or id
3143	*
3144	* @access public
3145	*/
3146	function nextID($seq_name, $ondemand = true)
3147	{
3148	return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3149	'method not implemented', __FUNCTION__);
3150	}
3151
3152	// }}}
3153	// {{{ function lastInsertID($table = null, $field = null)
3154
3155	/**
3156	* Returns the autoincrement ID if supported or $id or fetches the current
3157	* ID in a sequence called: $table.(empty($field) ? '' : '_'.$field)
3158	*
3159	* @param string name of the table into which a new row was inserted
3160	* @param string name of the field into which a new row was inserted
3161	*
3162	* @return mixed MDB2 Error Object or id
3163	*
3164	* @access public
3165	*/
3166	function lastInsertID($table = null, $field = null)
3167	{
3168	return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3169	'method not implemented', __FUNCTION__);
3170	}
3171
3172	// }}}
3173	// {{{ function currID($seq_name)
3174
3175	/**
3176	* Returns the current id of a sequence
3177	*
3178	* @param string name of the sequence
3179	*
3180	* @return mixed MDB2 Error Object or id
3181	*
3182	* @access public
3183	*/
3184	function currID($seq_name)
3185	{
3186	$this->warnings[] = 'database does not support getting current
3187	sequence value, the sequence value was incremented';
3188	return $this->nextID($seq_name);
3189	}
3190
3191	// }}}
3192	// {{{ function queryOne($query, $type = null, $colnum = 0)
3193
3194	/**
3195	* Execute the specified query, fetch the value from the first column of
3196	* the first row of the result set and then frees
3197	* the result set.
3198	*
3199	* @param string the SELECT query statement to be executed.
3200	* @param string optional argument that specifies the expected
3201	* datatype of the result set field, so that an eventual conversion
3202	* may be performed. The default datatype is text, meaning that no
3203	* conversion is performed
3204	* @param int the column number to fetch
3205	*
3206	* @return mixed MDB2_OK or field value on success, a MDB2 error on failure
3207	*
3208	* @access public
3209	*/
3210	function queryOne($query, $type = null, $colnum = 0)
3211	{
3212	$result = $this->query($query, $type);
3213	if (!MDB2::isResultCommon($result)) {
3214	return $result;
3215	}
3216
3217	$one = $result->fetchOne($colnum);
3218	$result->free();
3219	return $one;
3220	}
3221
3222	// }}}
3223	// {{{ function queryRow($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT)
3224
3225	/**
3226	* Execute the specified query, fetch the values from the first
3227	* row of the result set into an array and then frees
3228	* the result set.
3229	*
3230	* @param string the SELECT query statement to be executed.
3231	* @param array optional array argument that specifies a list of
3232	* expected datatypes of the result set columns, so that the eventual
3233	* conversions may be performed. The default list of datatypes is
3234	* empty, meaning that no conversion is performed.
3235	* @param int how the array data should be indexed
3236	*
3237	* @return mixed MDB2_OK or data array on success, a MDB2 error on failure
3238	*
3239	* @access public
3240	*/
3241	function queryRow($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT)
3242	{
3243	$result = $this->query($query, $types);
3244	if (!MDB2::isResultCommon($result)) {
3245	return $result;
3246	}
3247
3248	$row = $result->fetchRow($fetchmode);
3249	$result->free();
3250	return $row;
3251	}
3252
3253	// }}}
3254	// {{{ function queryCol($query, $type = null, $colnum = 0)
3255
3256	/**
3257	* Execute the specified query, fetch the value from the first column of
3258	* each row of the result set into an array and then frees the result set.
3259	*
3260	* @param string the SELECT query statement to be executed.
3261	* @param string optional argument that specifies the expected
3262	* datatype of the result set field, so that an eventual conversion
3263	* may be performed. The default datatype is text, meaning that no
3264	* conversion is performed
3265	* @param int the row number to fetch
3266	*
3267	* @return mixed MDB2_OK or data array on success, a MDB2 error on failure
3268	*
3269	* @access public
3270	*/
3271	function queryCol($query, $type = null, $colnum = 0)
3272	{
3273	$result = $this->query($query, $type);
3274	if (!MDB2::isResultCommon($result)) {
3275	return $result;
3276	}
3277
3278	$col = $result->fetchCol($colnum);
3279	$result->free();
3280	return $col;
3281	}
3282
3283	// }}}
3284	// {{{ function queryAll($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT, $rekey = false, $force_array = false, $group = false)
3285
3286	/**
3287	* Execute the specified query, fetch all the rows of the result set into
3288	* a two dimensional array and then frees the result set.
3289	*
3290	* @param string the SELECT query statement to be executed.
3291	* @param array optional array argument that specifies a list of
3292	* expected datatypes of the result set columns, so that the eventual
3293	* conversions may be performed. The default list of datatypes is
3294	* empty, meaning that no conversion is performed.
3295	* @param int how the array data should be indexed
3296	* @param bool if set to true, the $all will have the first
3297	* column as its first dimension
3298	* @param bool used only when the query returns exactly
3299	* two columns. If true, the values of the returned array will be
3300	* one-element arrays instead of scalars.
3301	* @param bool if true, the values of the returned array is
3302	* wrapped in another array. If the same key value (in the first
3303	* column) repeats itself, the values will be appended to this array
3304	* instead of overwriting the existing values.
3305	*
3306	* @return mixed MDB2_OK or data array on success, a MDB2 error on failure
3307	*
3308	* @access public
3309	*/
3310	function queryAll($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT,
3311	$rekey = false, $force_array = false, $group = false)
3312	{
3313	$result = $this->query($query, $types);
3314	if (!MDB2::isResultCommon($result)) {
3315	return $result;
3316	}
3317
3318	$all = $result->fetchAll($fetchmode, $rekey, $force_array, $group);
3319	$result->free();
3320	return $all;
3321	}
3322
3323	// }}}
3324	}
3325
3326	// }}}
3327	// {{{ class MDB2_Result
3328
3329	/**
3330	* The dummy class that all user space result classes should extend from
3331	*
3332	* @package MDB2
3333	* @category Database
3334	* @author Lukas Smith <[email protected]>
3335	*/
3336	class MDB2_Result
3337	{
3338	}
3339
3340	// }}}
3341	// {{{ class MDB2_Result_Common extends MDB2_Result
3342
3343	/**
3344	* The common result class for MDB2 result objects
3345	*
3346	* @package MDB2
3347	* @category Database
3348	* @author Lukas Smith <[email protected]>
3349	*/
3350	class MDB2_Result_Common extends MDB2_Result
3351	{
3352	// {{{ Variables (Properties)
3353
3354	var $db;
3355	var $result;
3356	var $rownum = -1;
3357	var $types = array();
3358	var $values = array();
3359	var $offset;
3360	var $offset_count = 0;
3361	var $limit;
3362	var $column_names;
3363
3364	// }}}
3365	// {{{ constructor: function __construct(&$db, &$result, $limit = 0, $offset = 0)
3366
3367	/**
3368	* Constructor
3369	*/
3370	function __construct(&$db, &$result, $limit = 0, $offset = 0)
3371	{
3372	$this->db =& $db;
3373	$this->result =& $result;
3374	$this->offset = $offset;
3375	$this->limit = max(0, $limit - 1);
3376	}
3377
3378	// }}}
3379	// {{{ function MDB2_Result_Common(&$db, &$result, $limit = 0, $offset = 0)
3380
3381	/**
3382	* PHP 4 Constructor
3383	*/
3384	function MDB2_Result_Common(&$db, &$result, $limit = 0, $offset = 0)
3385	{
3386	$this->__construct($db, $result, $limit, $offset);
3387	}
3388
3389	// }}}
3390	// {{{ function setResultTypes($types)
3391
3392	/**
3393	* Define the list of types to be associated with the columns of a given
3394	* result set.
3395	*
3396	* This function may be called before invoking fetchRow(), fetchOne(),
3397	* fetchCol() and fetchAll() so that the necessary data type
3398	* conversions are performed on the data to be retrieved by them. If this
3399	* function is not called, the type of all result set columns is assumed
3400	* to be text, thus leading to not perform any conversions.
3401	*
3402	* @param array variable that lists the
3403	* data types to be expected in the result set columns. If this array
3404	* contains less types than the number of columns that are returned
3405	* in the result set, the remaining columns are assumed to be of the
3406	* type text. Currently, the types clob and blob are not fully
3407	* supported.
3408	*
3409	* @return mixed MDB2_OK on success, a MDB2 error on failure
3410	*
3411	* @access public
3412	*/
3413	function setResultTypes($types)
3414	{
3415	$load = $this->db->loadModule('Datatype', null, true);
3416	if (PEAR::isError($load)) {
3417	return $load;
3418	}
3419	$types = $this->db->datatype->checkResultTypes($types);
3420	if (PEAR::isError($types)) {
3421	return $types;
3422	}
3423	$this->types = $types;
3424	return MDB2_OK;
3425	}
3426
3427	// }}}
3428	// {{{ function seek($rownum = 0)
3429
3430	/**
3431	* Seek to a specific row in a result set
3432	*
3433	* @param int number of the row where the data can be found
3434	*
3435	* @return mixed MDB2_OK on success, a MDB2 error on failure
3436	*
3437	* @access public
3438	*/
3439	function seek($rownum = 0)
3440	{
3441	$target_rownum = $rownum - 1;
3442	if ($this->rownum > $target_rownum) {
3443	return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3444	'seeking to previous rows not implemented', __FUNCTION__);
3445	}
3446	while ($this->rownum < $target_rownum) {
3447	$this->fetchRow();
3448	}
3449	return MDB2_OK;
3450	}
3451
3452	// }}}
3453	// {{{ function &fetchRow($fetchmode = MDB2_FETCHMODE_DEFAULT, $rownum = null)
3454
3455	/**
3456	* Fetch and return a row of data
3457	*
3458	* @param int how the array data should be indexed
3459	* @param int number of the row where the data can be found
3460	*
3461	* @return int data array on success, a MDB2 error on failure
3462	*
3463	* @access public
3464	*/
3465	function &fetchRow($fetchmode = MDB2_FETCHMODE_DEFAULT, $rownum = null)
3466	{
3467	$err =& $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3468	'method not implemented', __FUNCTION__);
3469	return $err;
3470	}
3471
3472	// }}}
3473	// {{{ function fetchOne($colnum = 0)
3474
3475	/**
3476	* fetch single column from the next row from a result set
3477	*
3478	* @param int the column number to fetch
3479	* @param int number of the row where the data can be found
3480	*
3481	* @return string data on success, a MDB2 error on failure
3482	*
3483	* @access public
3484	*/
3485	function fetchOne($colnum = 0, $rownum = null)
3486	{
3487	$fetchmode = is_numeric($colnum) ? MDB2_FETCHMODE_ORDERED : MDB2_FETCHMODE_ASSOC;
3488	$row = $this->fetchRow($fetchmode, $rownum);
3489	if (!is_array($row) \|\| PEAR::isError($row)) {
3490	return $row;
3491	}
3492	if (!array_key_exists($colnum, $row)) {
3493	return $this->db->raiseError(MDB2_ERROR_TRUNCATED, null, null,
3494	'column is not defined in the result set: '.$colnum, __FUNCTION__);
3495	}
3496	return $row[$colnum];
3497	}
3498
3499	// }}}
3500	// {{{ function fetchCol($colnum = 0)
3501
3502	/**
3503	* Fetch and return a column from the current row pointer position
3504	*
3505	* @param int the column number to fetch
3506	*
3507	* @return mixed data array on success, a MDB2 error on failure
3508	*
3509	* @access public
3510	*/
3511	function fetchCol($colnum = 0)
3512	{
3513	$column = array();
3514	$fetchmode = is_numeric($colnum) ? MDB2_FETCHMODE_ORDERED : MDB2_FETCHMODE_ASSOC;
3515	$row = $this->fetchRow($fetchmode);
3516	if (is_array($row)) {
3517	if (!array_key_exists($colnum, $row)) {
3518	return $this->db->raiseError(MDB2_ERROR_TRUNCATED, null, null,
3519	'column is not defined in the result set: '.$colnum, __FUNCTION__);
3520	}
3521	do {
3522	$column[] = $row[$colnum];
3523	} while (is_array($row = $this->fetchRow($fetchmode)));
3524	}
3525	if (PEAR::isError($row)) {
3526	return $row;
3527	}
3528	return $column;
3529	}
3530
3531	// }}}
3532	// {{{ function fetchAll($fetchmode = MDB2_FETCHMODE_DEFAULT, $rekey = false, $force_array = false, $group = false)
3533
3534	/**
3535	* Fetch and return all rows from the current row pointer position
3536	*
3537	* @param int $fetchmode the fetch mode to use:
3538	* + MDB2_FETCHMODE_ORDERED
3539	* + MDB2_FETCHMODE_ASSOC
3540	* + MDB2_FETCHMODE_ORDERED \| MDB2_FETCHMODE_FLIPPED
3541	* + MDB2_FETCHMODE_ASSOC \| MDB2_FETCHMODE_FLIPPED
3542	* @param bool if set to true, the $all will have the first
3543	* column as its first dimension
3544	* @param bool used only when the query returns exactly
3545	* two columns. If true, the values of the returned array will be
3546	* one-element arrays instead of scalars.
3547	* @param bool if true, the values of the returned array is
3548	* wrapped in another array. If the same key value (in the first
3549	* column) repeats itself, the values will be appended to this array
3550	* instead of overwriting the existing values.
3551	*
3552	* @return mixed data array on success, a MDB2 error on failure
3553	*
3554	* @access public
3555	* @see getAssoc()
3556	*/
3557	function fetchAll($fetchmode = MDB2_FETCHMODE_DEFAULT, $rekey = false,
3558	$force_array = false, $group = false)
3559	{
3560	$all = array();
3561	$row = $this->fetchRow($fetchmode);
3562	if (PEAR::isError($row)) {
3563	return $row;
3564	} elseif (!$row) {
3565	return $all;
3566	}
3567
3568	$shift_array = $rekey ? false : null;
3569	if (!is_null($shift_array)) {
3570	if (is_object($row)) {
3571	$colnum = count(get_object_vars($row));
3572	} else {
3573	$colnum = count($row);
3574	}
3575	if ($colnum < 2) {
3576	return $this->db->raiseError(MDB2_ERROR_TRUNCATED, null, null,
3577	'rekey feature requires atleast 2 column', __FUNCTION__);
3578	}
3579	$shift_array = (!$force_array && $colnum == 2);
3580	}
3581
3582	if ($rekey) {
3583	do {
3584	if (is_object($row)) {
3585	$arr = get_object_vars($row);
3586	$key = reset($arr);
3587	unset($row->{$key});
3588	} else {
3589	if ($fetchmode & MDB2_FETCHMODE_ASSOC) {
3590	$key = reset($row);
3591	unset($row[key($row)]);
3592	} else {
3593	$key = array_shift($row);
3594	}
3595	if ($shift_array) {
3596	$row = array_shift($row);
3597	}
3598	}
3599	if ($group) {
3600	$all[$key][] = $row;
3601	} else {
3602	$all[$key] = $row;
3603	}
3604	} while (($row = $this->fetchRow($fetchmode)));
3605	} elseif ($fetchmode & MDB2_FETCHMODE_FLIPPED) {
3606	do {
3607	foreach ($row as $key => $val) {
3608	$all[$key][] = $val;
3609	}
3610	} while (($row = $this->fetchRow($fetchmode)));
3611	} else {
3612	do {
3613	$all[] = $row;
3614	} while (($row = $this->fetchRow($fetchmode)));
3615	}
3616
3617	return $all;
3618	}
3619
3620	// }}}
3621	// {{{ function rowCount()
3622	/**
3623	* Returns the actual row number that was last fetched (count from 0)
3624	* @return int
3625	*
3626	* @access public
3627	*/
3628	function rowCount()
3629	{
3630	return $this->rownum + 1;
3631	}
3632
3633	// }}}
3634	// {{{ function numRows()
3635
3636	/**
3637	* Returns the number of rows in a result object
3638	*
3639	* @return mixed MDB2 Error Object or the number of rows
3640	*
3641	* @access public
3642	*/
3643	function numRows()
3644	{
3645	return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3646	'method not implemented', __FUNCTION__);
3647	}
3648
3649	// }}}
3650	// {{{ function nextResult()
3651
3652	/**
3653	* Move the internal result pointer to the next available result
3654	*
3655	* @return true on success, false if there is no more result set or an error object on failure
3656	*
3657	* @access public
3658	*/
3659	function nextResult()
3660	{
3661	return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3662	'method not implemented', __FUNCTION__);
3663	}
3664
3665	// }}}
3666	// {{{ function getColumnNames()
3667
3668	/**
3669	* Retrieve the names of columns returned by the DBMS in a query result or
3670	* from the cache.
3671	*
3672	* @param bool If set to true the values are the column names,
3673	* otherwise the names of the columns are the keys.
3674	* @return mixed Array variable that holds the names of columns or an
3675	* MDB2 error on failure.
3676	* Some DBMS may not return any columns when the result set
3677	* does not contain any rows.
3678	*
3679	* @access public
3680	*/
3681	function getColumnNames($flip = false)
3682	{
3683	if (!isset($this->column_names)) {
3684	$result = $this->_getColumnNames();
3685	if (PEAR::isError($result)) {
3686	return $result;
3687	}
3688	$this->column_names = $result;
3689	}
3690	if ($flip) {
3691	return array_flip($this->column_names);
3692	}
3693	return $this->column_names;
3694	}
3695
3696	// }}}
3697	// {{{ function _getColumnNames()
3698
3699	/**
3700	* Retrieve the names of columns returned by the DBMS in a query result.
3701	*
3702	* @return mixed Array variable that holds the names of columns as keys
3703	* or an MDB2 error on failure.
3704	* Some DBMS may not return any columns when the result set
3705	* does not contain any rows.
3706	*
3707	* @access private
3708	*/
3709	function _getColumnNames()
3710	{
3711	return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3712	'method not implemented', __FUNCTION__);
3713	}
3714
3715	// }}}
3716	// {{{ function numCols()
3717
3718	/**
3719	* Count the number of columns returned by the DBMS in a query result.
3720	*
3721	* @return mixed integer value with the number of columns, a MDB2 error
3722	* on failure
3723	*
3724	* @access public
3725	*/
3726	function numCols()
3727	{
3728	return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3729	'method not implemented', __FUNCTION__);
3730	}
3731
3732	// }}}
3733	// {{{ function getResource()
3734
3735	/**
3736	* return the resource associated with the result object
3737	*
3738	* @return resource
3739	*
3740	* @access public
3741	*/
3742	function getResource()
3743	{
3744	return $this->result;
3745	}
3746
3747	// }}}
3748	// {{{ function bindColumn($column, &$value, $type = null)
3749
3750	/**
3751	* Set bind variable to a column.
3752	*
3753	* @param int column number or name
3754	* @param mixed variable reference
3755	* @param string specifies the type of the field
3756	*
3757	* @return mixed MDB2_OK on success, a MDB2 error on failure
3758	*
3759	* @access public
3760	*/
3761	function bindColumn($column, &$value, $type = null)
3762	{
3763	if (!is_numeric($column)) {
3764	$column_names = $this->getColumnNames();
3765	if ($this->db->options['portability'] & MDB2_PORTABILITY_FIX_CASE) {
3766	if ($this->db->options['field_case'] == CASE_LOWER) {
3767	$column = strtolower($column);
3768	} else {
3769	$column = strtoupper($column);
3770	}
3771	}
3772	$column = $column_names[$column];
3773	}
3774	$this->values[$column] =& $value;
3775	if (!is_null($type)) {
3776	$this->types[$column] = $type;
3777	}
3778	return MDB2_OK;
3779	}
3780
3781	// }}}
3782	// {{{ function _assignBindColumns($row)
3783
3784	/**
3785	* Bind a variable to a value in the result row.
3786	*
3787	* @param array row data
3788	*
3789	* @return mixed MDB2_OK on success, a MDB2 error on failure
3790	*
3791	* @access private
3792	*/
3793	function _assignBindColumns($row)
3794	{
3795	$row = array_values($row);
3796	foreach ($row as $column => $value) {
3797	if (array_key_exists($column, $this->values)) {
3798	$this->values[$column] = $value;
3799	}
3800	}
3801	return MDB2_OK;
3802	}
3803
3804	// }}}
3805	// {{{ function free()
3806
3807	/**
3808	* Free the internal resources associated with result.
3809	*
3810	* @return bool true on success, false if result is invalid
3811	*
3812	* @access public
3813	*/
3814	function free()
3815	{
3816	$this->result = false;
3817	return MDB2_OK;
3818	}
3819
3820	// }}}
3821	}
3822
3823	// }}}
3824	// {{{ class MDB2_Row
3825
3826	/**
3827	* The simple class that accepts row data as an array
3828	*
3829	* @package MDB2
3830	* @category Database
3831	* @author Lukas Smith <[email protected]>
3832	*/
3833	class MDB2_Row
3834	{
3835	// {{{ constructor: function __construct(&$row)
3836
3837	/**
3838	* constructor
3839	*
3840	* @param resource row data as array
3841	*/
3842	function __construct(&$row)
3843	{
3844	foreach ($row as $key => $value) {
3845	$this->$key = &$row[$key];
3846	}
3847	}
3848
3849	// }}}
3850	// {{{ function MDB2_Row(&$row)
3851
3852	/**
3853	* PHP 4 Constructor
3854	*
3855	* @param resource row data as array
3856	*/
3857	function MDB2_Row(&$row)
3858	{
3859	$this->__construct($row);
3860	}
3861
3862	// }}}
3863	}
3864
3865	// }}}
3866	// {{{ class MDB2_Statement_Common
3867
3868	/**
3869	* The common statement class for MDB2 statement objects
3870	*
3871	* @package MDB2
3872	* @category Database
3873	* @author Lukas Smith <[email protected]>
3874	*/
3875	class MDB2_Statement_Common
3876	{
3877	// {{{ Variables (Properties)
3878
3879	var $db;
3880	var $statement;
3881	var $query;
3882	var $result_types;
3883	var $types;
3884	var $values = array();
3885	var $limit;
3886	var $offset;
3887	var $is_manip;
3888
3889	// }}}
3890	// {{{ constructor: function __construct(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null)
3891
3892	/**
3893	* Constructor
3894	*/
3895	function __construct(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null)
3896	{
3897	$this->db =& $db;
3898	$this->statement =& $statement;
3899	$this->positions = $positions;
3900	$this->query = $query;
3901	$this->types = (array)$types;
3902	$this->result_types = (array)$result_types;
3903	$this->limit = $limit;
3904	$this->is_manip = $is_manip;
3905	$this->offset = $offset;
3906	}
3907
3908	// }}}
3909	// {{{ function MDB2_Statement_Common(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null)
3910
3911	/**
3912	* PHP 4 Constructor
3913	*/
3914	function MDB2_Statement_Common(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null)
3915	{
3916	$this->__construct($db, $statement, $positions, $query, $types, $result_types, $is_manip, $limit, $offset);
3917	}
3918
3919	// }}}
3920	// {{{ function bindValue($parameter, &$value, $type = null)
3921
3922	/**
3923	* Set the value of a parameter of a prepared query.
3924	*
3925	* @param int the order number of the parameter in the query
3926	* statement. The order number of the first parameter is 1.
3927	* @param mixed value that is meant to be assigned to specified
3928	* parameter. The type of the value depends on the $type argument.
3929	* @param string specifies the type of the field
3930	*
3931	* @return mixed MDB2_OK on success, a MDB2 error on failure
3932	*
3933	* @access public
3934	*/
3935	function bindValue($parameter, $value, $type = null)
3936	{
3937	if (!is_numeric($parameter)) {
3938	$parameter = preg_replace('/^:(.*)$/', '\\1', $parameter);
3939	}
3940	if (!in_array($parameter, $this->positions)) {
3941	return $this->db->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
3942	'Unable to bind to missing placeholder: '.$parameter, __FUNCTION__);
3943	}
3944	$this->values[$parameter] = $value;
3945	if (!is_null($type)) {
3946	$this->types[$parameter] = $type;
3947	}
3948	return MDB2_OK;
3949	}
3950
3951	// }}}
3952	// {{{ function bindValueArray($values, $types = null)
3953
3954	/**
3955	* Set the values of multiple a parameter of a prepared query in bulk.
3956	*
3957	* @param array specifies all necessary information
3958	* for bindValue() the array elements must use keys corresponding to
3959	* the number of the position of the parameter.
3960	* @param array specifies the types of the fields
3961	*
3962	* @return mixed MDB2_OK on success, a MDB2 error on failure
3963	*
3964	* @access public
3965	* @see bindParam()
3966	*/
3967	function bindValueArray($values, $types = null)
3968	{
3969	$types = is_array($types) ? array_values($types) : array_fill(0, count($values), null);
3970	$parameters = array_keys($values);
3971	foreach ($parameters as $key => $parameter) {
3972	$err = $this->bindValue($parameter, $values[$parameter], $types[$key]);
3973	if (PEAR::isError($err)) {
3974	return $err;
3975	}
3976	}
3977	return MDB2_OK;
3978	}
3979
3980	// }}}
3981	// {{{ function bindParam($parameter, &$value, $type = null)
3982
3983	/**
3984	* Bind a variable to a parameter of a prepared query.
3985	*
3986	* @param int the order number of the parameter in the query
3987	* statement. The order number of the first parameter is 1.
3988	* @param mixed variable that is meant to be bound to specified
3989	* parameter. The type of the value depends on the $type argument.
3990	* @param string specifies the type of the field
3991	*
3992	* @return mixed MDB2_OK on success, a MDB2 error on failure
3993	*
3994	* @access public
3995	*/
3996	function bindParam($parameter, &$value, $type = null)
3997	{
3998	if (!is_numeric($parameter)) {
3999	$parameter = preg_replace('/^:(.*)$/', '\\1', $parameter);
4000	}
4001	if (!in_array($parameter, $this->positions)) {
4002	return $this->db->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
4003	'Unable to bind to missing placeholder: '.$parameter, __FUNCTION__);
4004	}
4005	$this->values[$parameter] =& $value;
4006	if (!is_null($type)) {
4007	$this->types[$parameter] = $type;
4008	}
4009	return MDB2_OK;
4010	}
4011
4012	// }}}
4013	// {{{ function bindParamArray(&$values, $types = null)
4014
4015	/**
4016	* Bind the variables of multiple a parameter of a prepared query in bulk.
4017	*
4018	* @param array specifies all necessary information
4019	* for bindParam() the array elements must use keys corresponding to
4020	* the number of the position of the parameter.
4021	* @param array specifies the types of the fields
4022	*
4023	* @return mixed MDB2_OK on success, a MDB2 error on failure
4024	*
4025	* @access public
4026	* @see bindParam()
4027	*/
4028	function bindParamArray(&$values, $types = null)
4029	{
4030	$types = is_array($types) ? array_values($types) : array_fill(0, count($values), null);
4031	$parameters = array_keys($values);
4032	foreach ($parameters as $key => $parameter) {
4033	$err = $this->bindParam($parameter, $values[$parameter], $types[$key]);
4034	if (PEAR::isError($err)) {
4035	return $err;
4036	}
4037	}
4038	return MDB2_OK;
4039	}
4040
4041	// }}}
4042	// {{{ function &execute($values = null, $result_class = true, $result_wrap_class = false)
4043
4044	/**
4045	* Execute a prepared query statement.
4046	*
4047	* @param array specifies all necessary information
4048	* for bindParam() the array elements must use keys corresponding to
4049	* the number of the position of the parameter.
4050	* @param mixed specifies which result class to use
4051	* @param mixed specifies which class to wrap results in
4052	*
4053	* @return mixed a result handle or MDB2_OK on success, a MDB2 error on failure
4054	*
4055	* @access public
4056	*/
4057	function &execute($values = null, $result_class = true, $result_wrap_class = false)
4058	{
4059	if (is_null($this->positions)) {
4060	return $this->db->raiseError(MDB2_ERROR, null, null,
4061	'Prepared statement has already been freed', __FUNCTION__);
4062	}
4063
4064	$values = (array)$values;
4065	if (!empty($values)) {
4066	$err = $this->bindValueArray($values);
4067	if (PEAR::isError($err)) {
4068	return $this->db->raiseError(MDB2_ERROR, null, null,
4069	'Binding Values failed with message: ' . $err->getMessage(), __FUNCTION__);
4070	}
4071	}
4072	$result =& $this->_execute($result_class, $result_wrap_class);
4073	return $result;
4074	}
4075
4076	// }}}
4077	// {{{ function &_execute($result_class = true, $result_wrap_class = false)
4078
4079	/**
4080	* Execute a prepared query statement helper method.
4081	*
4082	* @param mixed specifies which result class to use
4083	* @param mixed specifies which class to wrap results in
4084	*
4085	* @return mixed MDB2_Result or integer on success, a MDB2 error on failure
4086	*
4087	* @access private
4088	*/
4089	function &_execute($result_class = true, $result_wrap_class = false)
4090	{
4091	$this->last_query = $this->query;
4092	$query = '';
4093	$last_position = 0;
4094	foreach ($this->positions as $current_position => $parameter) {
4095	if (!array_key_exists($parameter, $this->values)) {
4096	return $this->db->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
4097	'Unable to bind to missing placeholder: '.$parameter, __FUNCTION__);
4098	}
4099	$value = $this->values[$parameter];
4100	$query.= substr($this->query, $last_position, $current_position - $last_position);
4101	if (!isset($value)) {
4102	$value_quoted = 'NULL';
4103	} else {
4104	$type = !empty($this->types[$parameter]) ? $this->types[$parameter] : null;
4105	$value_quoted = $this->db->quote($value, $type);
4106	if (PEAR::isError($value_quoted)) {
4107	return $value_quoted;
4108	}
4109	}
4110	$query.= $value_quoted;
4111	$last_position = $current_position + 1;
4112	}
4113	$query.= substr($this->query, $last_position);
4114
4115	$this->db->offset = $this->offset;
4116	$this->db->limit = $this->limit;
4117	if ($this->is_manip) {
4118	$result = $this->db->exec($query);
4119	} else {
4120	$result =& $this->db->query($query, $this->result_types, $result_class, $result_wrap_class);
4121	}
4122	return $result;
4123	}
4124
4125	// }}}
4126	// {{{ function free()
4127
4128	/**
4129	* Release resources allocated for the specified prepared query.
4130	*
4131	* @return mixed MDB2_OK on success, a MDB2 error on failure
4132	*
4133	* @access public
4134	*/
4135	function free()
4136	{
4137	if (is_null($this->positions)) {
4138	return $this->db->raiseError(MDB2_ERROR, null, null,
4139	'Prepared statement has already been freed', __FUNCTION__);
4140	}
4141
4142	$this->statement = null;
4143	$this->positions = null;
4144	$this->query = null;
4145	$this->types = null;
4146	$this->result_types = null;
4147	$this->limit = null;
4148	$this->is_manip = null;
4149	$this->offset = null;
4150	$this->values = null;
4151
4152	return MDB2_OK;
4153	}
4154
4155	// }}}
4156	}
4157
4158	// }}}
4159	// {{{ class MDB2_Module_Common
4160
4161	/**
4162	* The common modules class for MDB2 module objects
4163	*
4164	* @package MDB2
4165	* @category Database
4166	* @author Lukas Smith <[email protected]>
4167	*/
4168	class MDB2_Module_Common
4169	{
4170	// {{{ Variables (Properties)
4171
4172	/**
4173	* contains the key to the global MDB2 instance array of the associated
4174	* MDB2 instance
4175	*
4176	* @var int
4177	* @access protected
4178	*/
4179	var $db_index;
4180
4181	// }}}
4182	// {{{ constructor: function __construct($db_index)
4183
4184	/**
4185	* Constructor
4186	*/
4187	function __construct($db_index)
4188	{
4189	$this->db_index = $db_index;
4190	}
4191
4192	// }}}
4193	// {{{ function MDB2_Module_Common($db_index)
4194
4195	/**
4196	* PHP 4 Constructor
4197	*/
4198	function MDB2_Module_Common($db_index)
4199	{
4200	$this->__construct($db_index);
4201	}
4202
4203	// }}}
4204	// {{{ function &getDBInstance()
4205
4206	/**
4207	* Get the instance of MDB2 associated with the module instance
4208	*
4209	* @return object MDB2 instance or a MDB2 error on failure
4210	*
4211	* @access public
4212	*/
4213	function &getDBInstance()
4214	{
4215	if (isset($GLOBALS['_MDB2_databases'][$this->db_index])) {
4216	$result =& $GLOBALS['_MDB2_databases'][$this->db_index];
4217	} else {
4218	$result =& MDB2::raiseError(MDB2_ERROR_NOT_FOUND, null, null,
4219	'could not find MDB2 instance');
4220	}
4221	return $result;
4222	}
4223
4224	// }}}
4225	}
4226
4227	// }}}
4228	// {{{ function MDB2_closeOpenTransactions()
4229
4230	/**
4231	* Close any open transactions form persistent connections
4232	*
4233	* @return void
4234	*
4235	* @access public
4236	*/
4237
4238	function MDB2_closeOpenTransactions()
4239	{
4240	reset($GLOBALS['_MDB2_databases']);
4241	while (next($GLOBALS['_MDB2_databases'])) {
4242	$key = key($GLOBALS['_MDB2_databases']);
4243	if ($GLOBALS['_MDB2_databases'][$key]->opened_persistent
4244	&& $GLOBALS['_MDB2_databases'][$key]->in_transaction
4245	) {
4246	$GLOBALS['_MDB2_databases'][$key]->rollback();
4247	}
4248	}
4249	}
4250
4251	// }}}
4252	// {{{ function MDB2_defaultDebugOutput(&$db, $scope, $message, $is_manip = null)
4253
4254	/**
4255	* default debug output handler
4256	*
4257	* @param object reference to an MDB2 database object
4258	* @param string usually the method name that triggered the debug call:
4259	* for example 'query', 'prepare', 'execute', 'parameters',
4260	* 'beginTransaction', 'commit', 'rollback'
4261	* @param string message that should be appended to the debug variable
4262	* @param array contains context information about the debug() call
4263	* common keys are: is_manip, time, result etc.
4264	*
4265	* @return void\|string optionally return a modified message, this allows
4266	* rewriting a query before being issued or prepared
4267	*
4268	* @access public
4269	*/
4270	function MDB2_defaultDebugOutput(&$db, $scope, $message, $context = array())
4271	{
4272	$db->debug_output.= $scope.'('.$db->db_index.'): ';
4273	$db->debug_output.= $message.$db->getOption('log_line_break');
4274	return $message;
4275	}
4276
4277	// }}}
4278	?>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: