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 <smith@pooteeweet.org> | |
---|
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 <smith@pooteeweet.org> |
---|
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 <smith@pooteeweet.org> |
---|
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 <cox@idecnet.com> |
---|
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¶m2=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 <ssb@fast.no> |
---|
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 <smith@pooteeweet.org> |
---|
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 | $err = MDB2::loadClass($class_name, $this->getOption('debug')); |
---|
1867 | if (PEAR::isError($err)) { |
---|
1868 | return $err; |
---|
1869 | } |
---|
1870 | |
---|
1871 | // load modul in a specific version |
---|
1872 | if ($version) { |
---|
1873 | if (method_exists($class_name, 'getClassName')) { |
---|
1874 | $class_name_new = call_user_func(array($class_name, 'getClassName'), $this->db_index); |
---|
1875 | if ($class_name != $class_name_new) { |
---|
1876 | $class_name = $class_name_new; |
---|
1877 | $err = MDB2::loadClass($class_name, $this->getOption('debug')); |
---|
1878 | if (PEAR::isError($err)) { |
---|
1879 | return $err; |
---|
1880 | } |
---|
1881 | } |
---|
1882 | } |
---|
1883 | } |
---|
1884 | |
---|
1885 | if (!MDB2::classExists($class_name)) { |
---|
1886 | $err =& $this->raiseError(MDB2_ERROR_LOADMODULE, null, null, |
---|
1887 | "unable to load module '$module' into property '$property'", __FUNCTION__); |
---|
1888 | return $err; |
---|
1889 | } |
---|
1890 | $this->{$property} =& new $class_name($this->db_index); |
---|
1891 | $this->modules[$module] =& $this->{$property}; |
---|
1892 | if ($version) { |
---|
1893 | // this will be used in the connect method to determine if the module |
---|
1894 | // needs to be loaded with a different version if the server |
---|
1895 | // version changed in between connects |
---|
1896 | $this->loaded_version_modules[] = $property; |
---|
1897 | } |
---|
1898 | } |
---|
1899 | |
---|
1900 | return $this->{$property}; |
---|
1901 | } |
---|
1902 | |
---|
1903 | // }}} |
---|
1904 | // {{{ function __call($method, $params) |
---|
1905 | |
---|
1906 | /** |
---|
1907 | * Calls a module method using the __call magic method |
---|
1908 | * |
---|
1909 | * @param string Method name. |
---|
1910 | * @param array Arguments. |
---|
1911 | * |
---|
1912 | * @return mixed Returned value. |
---|
1913 | */ |
---|
1914 | function __call($method, $params) |
---|
1915 | { |
---|
1916 | $module = null; |
---|
1917 | if (preg_match('/^([a-z]+)([A-Z])(.*)$/', $method, $match) |
---|
1918 | && isset($this->options['modules'][$match[1]]) |
---|
1919 | ) { |
---|
1920 | $module = $this->options['modules'][$match[1]]; |
---|
1921 | $method = strtolower($match[2]).$match[3]; |
---|
1922 | if (!isset($this->modules[$module]) || !is_object($this->modules[$module])) { |
---|
1923 | sfprintr($module.":1"); |
---|
1924 | $result =& $this->loadModule($module); |
---|
1925 | if (PEAR::isError($result)) { |
---|
1926 | return $result; |
---|
1927 | } |
---|
1928 | } |
---|
1929 | } else { |
---|
1930 | foreach ($this->modules as $key => $foo) { |
---|
1931 | if (is_object($this->modules[$key]) |
---|
1932 | && method_exists($this->modules[$key], $method) |
---|
1933 | ) { |
---|
1934 | $module = $key; |
---|
1935 | break; |
---|
1936 | } |
---|
1937 | } |
---|
1938 | } |
---|
1939 | if (!is_null($module)) { |
---|
1940 | return call_user_func_array(array(&$this->modules[$module], $method), $params); |
---|
1941 | } |
---|
1942 | trigger_error(sprintf('Call to undefined function: %s::%s().', get_class($this), $method), E_USER_ERROR); |
---|
1943 | } |
---|
1944 | |
---|
1945 | // }}} |
---|
1946 | // {{{ function beginTransaction($savepoint = null) |
---|
1947 | |
---|
1948 | /** |
---|
1949 | * Start a transaction or set a savepoint. |
---|
1950 | * |
---|
1951 | * @param string name of a savepoint to set |
---|
1952 | * @return mixed MDB2_OK on success, a MDB2 error on failure |
---|
1953 | * |
---|
1954 | * @access public |
---|
1955 | */ |
---|
1956 | function beginTransaction($savepoint = null) |
---|
1957 | { |
---|
1958 | $this->debug('Starting transaction', __FUNCTION__, array('is_manip' => true, 'savepoint' => $savepoint)); |
---|
1959 | return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
1960 | 'transactions are not supported', __FUNCTION__); |
---|
1961 | } |
---|
1962 | |
---|
1963 | // }}} |
---|
1964 | // {{{ function commit($savepoint = null) |
---|
1965 | |
---|
1966 | /** |
---|
1967 | * Commit the database changes done during a transaction that is in |
---|
1968 | * progress or release a savepoint. This function may only be called when |
---|
1969 | * auto-committing is disabled, otherwise it will fail. Therefore, a new |
---|
1970 | * transaction is implicitly started after committing the pending changes. |
---|
1971 | * |
---|
1972 | * @param string name of a savepoint to release |
---|
1973 | * @return mixed MDB2_OK on success, a MDB2 error on failure |
---|
1974 | * |
---|
1975 | * @access public |
---|
1976 | */ |
---|
1977 | function commit($savepoint = null) |
---|
1978 | { |
---|
1979 | $this->debug('Committing transaction/savepoint', __FUNCTION__, array('is_manip' => true, 'savepoint' => $savepoint)); |
---|
1980 | return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
1981 | 'commiting transactions is not supported', __FUNCTION__); |
---|
1982 | } |
---|
1983 | |
---|
1984 | // }}} |
---|
1985 | // {{{ function rollback($savepoint = null) |
---|
1986 | |
---|
1987 | /** |
---|
1988 | * Cancel any database changes done during a transaction or since a specific |
---|
1989 | * savepoint that is in progress. This function may only be called when |
---|
1990 | * auto-committing is disabled, otherwise it will fail. Therefore, a new |
---|
1991 | * transaction is implicitly started after canceling the pending changes. |
---|
1992 | * |
---|
1993 | * @param string name of a savepoint to rollback to |
---|
1994 | * @return mixed MDB2_OK on success, a MDB2 error on failure |
---|
1995 | * |
---|
1996 | * @access public |
---|
1997 | */ |
---|
1998 | function rollback($savepoint = null) |
---|
1999 | { |
---|
2000 | $this->debug('Rolling back transaction/savepoint', __FUNCTION__, array('is_manip' => true, 'savepoint' => $savepoint)); |
---|
2001 | return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
2002 | 'rolling back transactions is not supported', __FUNCTION__); |
---|
2003 | } |
---|
2004 | |
---|
2005 | // }}} |
---|
2006 | // {{{ function inTransaction($ignore_nested = false) |
---|
2007 | |
---|
2008 | /** |
---|
2009 | * If a transaction is currently open. |
---|
2010 | * |
---|
2011 | * @param bool if the nested transaction count should be ignored |
---|
2012 | * @return int|bool - an integer with the nesting depth is returned if a |
---|
2013 | * nested transaction is open |
---|
2014 | * - true is returned for a normal open transaction |
---|
2015 | * - false is returned if no transaction is open |
---|
2016 | * |
---|
2017 | * @access public |
---|
2018 | */ |
---|
2019 | function inTransaction($ignore_nested = false) |
---|
2020 | { |
---|
2021 | if (!$ignore_nested && isset($this->nested_transaction_counter)) { |
---|
2022 | return $this->nested_transaction_counter; |
---|
2023 | } |
---|
2024 | return $this->in_transaction; |
---|
2025 | } |
---|
2026 | |
---|
2027 | // }}} |
---|
2028 | // {{{ function setTransactionIsolation($isolation) |
---|
2029 | |
---|
2030 | /** |
---|
2031 | * Set the transacton isolation level. |
---|
2032 | * |
---|
2033 | * @param string standard isolation level |
---|
2034 | * READ UNCOMMITTED (allows dirty reads) |
---|
2035 | * READ COMMITTED (prevents dirty reads) |
---|
2036 | * REPEATABLE READ (prevents nonrepeatable reads) |
---|
2037 | * SERIALIZABLE (prevents phantom reads) |
---|
2038 | * @param array some transaction options: |
---|
2039 | * 'wait' => 'WAIT' | 'NO WAIT' |
---|
2040 | * 'rw' => 'READ WRITE' | 'READ ONLY' |
---|
2041 | * @return mixed MDB2_OK on success, a MDB2 error on failure |
---|
2042 | * |
---|
2043 | * @access public |
---|
2044 | * @since 2.1.1 |
---|
2045 | */ |
---|
2046 | function setTransactionIsolation($isolation, $options = array()) |
---|
2047 | { |
---|
2048 | $this->debug('Setting transaction isolation level', __FUNCTION__, array('is_manip' => true)); |
---|
2049 | return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
2050 | 'isolation level setting is not supported', __FUNCTION__); |
---|
2051 | } |
---|
2052 | |
---|
2053 | // }}} |
---|
2054 | // {{{ function beginNestedTransaction($savepoint = false) |
---|
2055 | |
---|
2056 | /** |
---|
2057 | * Start a nested transaction. |
---|
2058 | * |
---|
2059 | * EXPERIMENTAL |
---|
2060 | * |
---|
2061 | * WARNING: this function is experimental and may change signature at |
---|
2062 | * any time until labelled as non-experimental |
---|
2063 | * |
---|
2064 | * @return mixed MDB2_OK on success/savepoint name, a MDB2 error on failure |
---|
2065 | * |
---|
2066 | * @access public |
---|
2067 | * @since 2.1.1 |
---|
2068 | */ |
---|
2069 | function beginNestedTransaction() |
---|
2070 | { |
---|
2071 | if ($this->in_transaction) { |
---|
2072 | ++$this->nested_transaction_counter; |
---|
2073 | $savepoint = sprintf($this->options['savepoint_format'], $this->nested_transaction_counter); |
---|
2074 | if ($this->supports('savepoints') && $savepoint) { |
---|
2075 | return $this->beginTransaction($savepoint); |
---|
2076 | } |
---|
2077 | return MDB2_OK; |
---|
2078 | } |
---|
2079 | $this->has_transaction_error = false; |
---|
2080 | $result = $this->beginTransaction(); |
---|
2081 | $this->nested_transaction_counter = 1; |
---|
2082 | return $result; |
---|
2083 | } |
---|
2084 | |
---|
2085 | // }}} |
---|
2086 | // {{{ function completeNestedTransaction($force_rollback = false, $release = false) |
---|
2087 | |
---|
2088 | /** |
---|
2089 | * Finish a nested transaction by rolling back if an error occured or |
---|
2090 | * committing otherwise. |
---|
2091 | * |
---|
2092 | * EXPERIMENTAL |
---|
2093 | * |
---|
2094 | * WARNING: this function is experimental and may change signature at |
---|
2095 | * any time until labelled as non-experimental |
---|
2096 | * |
---|
2097 | * @param bool if the transaction should be rolled back regardless |
---|
2098 | * even if no error was set within the nested transaction |
---|
2099 | * @return mixed MDB_OK on commit/counter decrementing, false on rollback |
---|
2100 | * and a MDB2 error on failure |
---|
2101 | * |
---|
2102 | * @access public |
---|
2103 | * @since 2.1.1 |
---|
2104 | */ |
---|
2105 | function completeNestedTransaction($force_rollback = false) |
---|
2106 | { |
---|
2107 | if ($this->nested_transaction_counter > 1) { |
---|
2108 | $savepoint = sprintf($this->options['savepoint_format'], $this->nested_transaction_counter); |
---|
2109 | if ($this->supports('savepoints') && $savepoint) { |
---|
2110 | if ($force_rollback || $this->has_transaction_error) { |
---|
2111 | $result = $this->rollback($savepoint); |
---|
2112 | if (!PEAR::isError($result)) { |
---|
2113 | $result = false; |
---|
2114 | $this->has_transaction_error = false; |
---|
2115 | } |
---|
2116 | } else { |
---|
2117 | $result = $this->commit($savepoint); |
---|
2118 | } |
---|
2119 | } else { |
---|
2120 | $result = MDB2_OK; |
---|
2121 | } |
---|
2122 | --$this->nested_transaction_counter; |
---|
2123 | return $result; |
---|
2124 | } |
---|
2125 | |
---|
2126 | $this->nested_transaction_counter = null; |
---|
2127 | $result = MDB2_OK; |
---|
2128 | |
---|
2129 | // transaction has not yet been rolled back |
---|
2130 | if ($this->in_transaction) { |
---|
2131 | if ($force_rollback || $this->has_transaction_error) { |
---|
2132 | $result = $this->rollback(); |
---|
2133 | if (!PEAR::isError($result)) { |
---|
2134 | $result = false; |
---|
2135 | } |
---|
2136 | } else { |
---|
2137 | $result = $this->commit(); |
---|
2138 | } |
---|
2139 | } |
---|
2140 | $this->has_transaction_error = false; |
---|
2141 | return $result; |
---|
2142 | } |
---|
2143 | |
---|
2144 | // }}} |
---|
2145 | // {{{ function failNestedTransaction($error = null, $immediately = false) |
---|
2146 | |
---|
2147 | /** |
---|
2148 | * Force setting nested transaction to failed. |
---|
2149 | * |
---|
2150 | * EXPERIMENTAL |
---|
2151 | * |
---|
2152 | * WARNING: this function is experimental and may change signature at |
---|
2153 | * any time until labelled as non-experimental |
---|
2154 | * |
---|
2155 | * @param mixed value to return in getNestededTransactionError() |
---|
2156 | * @param bool if the transaction should be rolled back immediately |
---|
2157 | * @return bool MDB2_OK |
---|
2158 | * |
---|
2159 | * @access public |
---|
2160 | * @since 2.1.1 |
---|
2161 | */ |
---|
2162 | function failNestedTransaction($error = null, $immediately = false) |
---|
2163 | { |
---|
2164 | if (is_null($error)) { |
---|
2165 | $error = $this->has_transaction_error ? $this->has_transaction_error : true; |
---|
2166 | } elseif (!$error) { |
---|
2167 | $error = true; |
---|
2168 | } |
---|
2169 | $this->has_transaction_error = $error; |
---|
2170 | if (!$immediately) { |
---|
2171 | return MDB2_OK; |
---|
2172 | } |
---|
2173 | return $this->rollback(); |
---|
2174 | } |
---|
2175 | |
---|
2176 | // }}} |
---|
2177 | // {{{ function getNestedTransactionError() |
---|
2178 | |
---|
2179 | /** |
---|
2180 | * The first error that occured since the transaction start. |
---|
2181 | * |
---|
2182 | * EXPERIMENTAL |
---|
2183 | * |
---|
2184 | * WARNING: this function is experimental and may change signature at |
---|
2185 | * any time until labelled as non-experimental |
---|
2186 | * |
---|
2187 | * @return MDB2_Error|bool MDB2 error object if an error occured or false. |
---|
2188 | * |
---|
2189 | * @access public |
---|
2190 | * @since 2.1.1 |
---|
2191 | */ |
---|
2192 | function getNestedTransactionError() |
---|
2193 | { |
---|
2194 | return $this->has_transaction_error; |
---|
2195 | } |
---|
2196 | |
---|
2197 | // }}} |
---|
2198 | // {{{ connect() |
---|
2199 | |
---|
2200 | /** |
---|
2201 | * Connect to the database |
---|
2202 | * |
---|
2203 | * @return true on success, MDB2 Error Object on failure |
---|
2204 | */ |
---|
2205 | function connect() |
---|
2206 | { |
---|
2207 | return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
2208 | 'method not implemented', __FUNCTION__); |
---|
2209 | } |
---|
2210 | |
---|
2211 | // }}} |
---|
2212 | // {{{ setCharset($charset, $connection = null) |
---|
2213 | |
---|
2214 | /** |
---|
2215 | * Set the charset on the current connection |
---|
2216 | * |
---|
2217 | * @param string charset |
---|
2218 | * @param resource connection handle |
---|
2219 | * |
---|
2220 | * @return true on success, MDB2 Error Object on failure |
---|
2221 | */ |
---|
2222 | function setCharset($charset, $connection = null) |
---|
2223 | { |
---|
2224 | return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
2225 | 'method not implemented', __FUNCTION__); |
---|
2226 | } |
---|
2227 | |
---|
2228 | // }}} |
---|
2229 | // {{{ function disconnect($force = true) |
---|
2230 | |
---|
2231 | /** |
---|
2232 | * Log out and disconnect from the database. |
---|
2233 | * |
---|
2234 | * @param bool if the disconnect should be forced even if the |
---|
2235 | * connection is opened persistently |
---|
2236 | * |
---|
2237 | * @return mixed true on success, false if not connected and error |
---|
2238 | * object on error |
---|
2239 | * |
---|
2240 | * @access public |
---|
2241 | */ |
---|
2242 | function disconnect($force = true) |
---|
2243 | { |
---|
2244 | $this->connection = 0; |
---|
2245 | $this->connected_dsn = array(); |
---|
2246 | $this->connected_database_name = ''; |
---|
2247 | $this->opened_persistent = null; |
---|
2248 | $this->connected_server_info = ''; |
---|
2249 | $this->in_transaction = null; |
---|
2250 | $this->nested_transaction_counter = null; |
---|
2251 | return MDB2_OK; |
---|
2252 | } |
---|
2253 | |
---|
2254 | // }}} |
---|
2255 | // {{{ function setDatabase($name) |
---|
2256 | |
---|
2257 | /** |
---|
2258 | * Select a different database |
---|
2259 | * |
---|
2260 | * @param string name of the database that should be selected |
---|
2261 | * |
---|
2262 | * @return string name of the database previously connected to |
---|
2263 | * |
---|
2264 | * @access public |
---|
2265 | */ |
---|
2266 | function setDatabase($name) |
---|
2267 | { |
---|
2268 | $previous_database_name = (isset($this->database_name)) ? $this->database_name : ''; |
---|
2269 | $this->database_name = $name; |
---|
2270 | $this->disconnect(false); |
---|
2271 | return $previous_database_name; |
---|
2272 | } |
---|
2273 | |
---|
2274 | // }}} |
---|
2275 | // {{{ function getDatabase() |
---|
2276 | |
---|
2277 | /** |
---|
2278 | * Get the current database |
---|
2279 | * |
---|
2280 | * @return string name of the database |
---|
2281 | * |
---|
2282 | * @access public |
---|
2283 | */ |
---|
2284 | function getDatabase() |
---|
2285 | { |
---|
2286 | return $this->database_name; |
---|
2287 | } |
---|
2288 | |
---|
2289 | // }}} |
---|
2290 | // {{{ function setDSN($dsn) |
---|
2291 | |
---|
2292 | /** |
---|
2293 | * set the DSN |
---|
2294 | * |
---|
2295 | * @param mixed DSN string or array |
---|
2296 | * |
---|
2297 | * @return MDB2_OK |
---|
2298 | * |
---|
2299 | * @access public |
---|
2300 | */ |
---|
2301 | function setDSN($dsn) |
---|
2302 | { |
---|
2303 | $dsn_default = $GLOBALS['_MDB2_dsninfo_default']; |
---|
2304 | $dsn = MDB2::parseDSN($dsn); |
---|
2305 | if (array_key_exists('database', $dsn)) { |
---|
2306 | $this->database_name = $dsn['database']; |
---|
2307 | unset($dsn['database']); |
---|
2308 | } |
---|
2309 | $this->dsn = array_merge($dsn_default, $dsn); |
---|
2310 | return $this->disconnect(false); |
---|
2311 | } |
---|
2312 | |
---|
2313 | // }}} |
---|
2314 | // {{{ function getDSN($type = 'string', $hidepw = false) |
---|
2315 | |
---|
2316 | /** |
---|
2317 | * return the DSN as a string |
---|
2318 | * |
---|
2319 | * @param string format to return ("array", "string") |
---|
2320 | * @param string string to hide the password with |
---|
2321 | * |
---|
2322 | * @return mixed DSN in the chosen type |
---|
2323 | * |
---|
2324 | * @access public |
---|
2325 | */ |
---|
2326 | function getDSN($type = 'string', $hidepw = false) |
---|
2327 | { |
---|
2328 | $dsn = array_merge($GLOBALS['_MDB2_dsninfo_default'], $this->dsn); |
---|
2329 | $dsn['phptype'] = $this->phptype; |
---|
2330 | $dsn['database'] = $this->database_name; |
---|
2331 | if ($hidepw) { |
---|
2332 | $dsn['password'] = $hidepw; |
---|
2333 | } |
---|
2334 | switch ($type) { |
---|
2335 | // expand to include all possible options |
---|
2336 | case 'string': |
---|
2337 | $dsn = $dsn['phptype']. |
---|
2338 | ($dsn['dbsyntax'] ? ('('.$dsn['dbsyntax'].')') : ''). |
---|
2339 | '://'.$dsn['username'].':'. |
---|
2340 | $dsn['password'].'@'.$dsn['hostspec']. |
---|
2341 | ($dsn['port'] ? (':'.$dsn['port']) : ''). |
---|
2342 | '/'.$dsn['database']; |
---|
2343 | break; |
---|
2344 | case 'array': |
---|
2345 | default: |
---|
2346 | break; |
---|
2347 | } |
---|
2348 | return $dsn; |
---|
2349 | } |
---|
2350 | |
---|
2351 | // }}} |
---|
2352 | // {{{ function &standaloneQuery($query, $types = null, $is_manip = false) |
---|
2353 | |
---|
2354 | /** |
---|
2355 | * execute a query as database administrator |
---|
2356 | * |
---|
2357 | * @param string the SQL query |
---|
2358 | * @param mixed array that contains the types of the columns in |
---|
2359 | * the result set |
---|
2360 | * @param bool if the query is a manipulation query |
---|
2361 | * |
---|
2362 | * @return mixed MDB2_OK on success, a MDB2 error on failure |
---|
2363 | * |
---|
2364 | * @access public |
---|
2365 | */ |
---|
2366 | function &standaloneQuery($query, $types = null, $is_manip = false) |
---|
2367 | { |
---|
2368 | $offset = $this->offset; |
---|
2369 | $limit = $this->limit; |
---|
2370 | $this->offset = $this->limit = 0; |
---|
2371 | $query = $this->_modifyQuery($query, $is_manip, $limit, $offset); |
---|
2372 | |
---|
2373 | $connection = $this->getConnection(); |
---|
2374 | if (PEAR::isError($connection)) { |
---|
2375 | return $connection; |
---|
2376 | } |
---|
2377 | |
---|
2378 | $result =& $this->_doQuery($query, $is_manip, $connection, false); |
---|
2379 | if (PEAR::isError($result)) { |
---|
2380 | return $result; |
---|
2381 | } |
---|
2382 | |
---|
2383 | if ($is_manip) { |
---|
2384 | $affected_rows = $this->_affectedRows($connection, $result); |
---|
2385 | return $affected_rows; |
---|
2386 | } |
---|
2387 | $result =& $this->_wrapResult($result, $types, true, false, $limit, $offset); |
---|
2388 | return $result; |
---|
2389 | } |
---|
2390 | |
---|
2391 | // }}} |
---|
2392 | // {{{ function _modifyQuery($query, $is_manip, $limit, $offset) |
---|
2393 | |
---|
2394 | /** |
---|
2395 | * Changes a query string for various DBMS specific reasons |
---|
2396 | * |
---|
2397 | * @param string query to modify |
---|
2398 | * @param bool if it is a DML query |
---|
2399 | * @param int limit the number of rows |
---|
2400 | * @param int start reading from given offset |
---|
2401 | * |
---|
2402 | * @return string modified query |
---|
2403 | * |
---|
2404 | * @access protected |
---|
2405 | */ |
---|
2406 | function _modifyQuery($query, $is_manip, $limit, $offset) |
---|
2407 | { |
---|
2408 | return $query; |
---|
2409 | } |
---|
2410 | |
---|
2411 | // }}} |
---|
2412 | // {{{ function &_doQuery($query, $is_manip = false, $connection = null, $database_name = null) |
---|
2413 | |
---|
2414 | /** |
---|
2415 | * Execute a query |
---|
2416 | * @param string query |
---|
2417 | * @param bool if the query is a manipulation query |
---|
2418 | * @param resource connection handle |
---|
2419 | * @param string database name |
---|
2420 | * |
---|
2421 | * @return result or error object |
---|
2422 | * |
---|
2423 | * @access protected |
---|
2424 | */ |
---|
2425 | function &_doQuery($query, $is_manip = false, $connection = null, $database_name = null) |
---|
2426 | { |
---|
2427 | $this->last_query = $query; |
---|
2428 | $result = $this->debug($query, 'query', array('is_manip' => $is_manip, 'when' => 'pre')); |
---|
2429 | if ($result) { |
---|
2430 | if (PEAR::isError($result)) { |
---|
2431 | return $result; |
---|
2432 | } |
---|
2433 | $query = $result; |
---|
2434 | } |
---|
2435 | $err =& $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
2436 | 'method not implemented', __FUNCTION__); |
---|
2437 | return $err; |
---|
2438 | } |
---|
2439 | |
---|
2440 | // }}} |
---|
2441 | // {{{ function _affectedRows($connection, $result = null) |
---|
2442 | |
---|
2443 | /** |
---|
2444 | * Returns the number of rows affected |
---|
2445 | * |
---|
2446 | * @param resource result handle |
---|
2447 | * @param resource connection handle |
---|
2448 | * |
---|
2449 | * @return mixed MDB2 Error Object or the number of rows affected |
---|
2450 | * |
---|
2451 | * @access private |
---|
2452 | */ |
---|
2453 | function _affectedRows($connection, $result = null) |
---|
2454 | { |
---|
2455 | return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
2456 | 'method not implemented', __FUNCTION__); |
---|
2457 | } |
---|
2458 | |
---|
2459 | // }}} |
---|
2460 | // {{{ function &exec($query) |
---|
2461 | |
---|
2462 | /** |
---|
2463 | * Execute a manipulation query to the database and return the number of affected rows |
---|
2464 | * |
---|
2465 | * @param string the SQL query |
---|
2466 | * |
---|
2467 | * @return mixed number of affected rows on success, a MDB2 error on failure |
---|
2468 | * |
---|
2469 | * @access public |
---|
2470 | */ |
---|
2471 | function &exec($query) |
---|
2472 | { |
---|
2473 | $offset = $this->offset; |
---|
2474 | $limit = $this->limit; |
---|
2475 | $this->offset = $this->limit = 0; |
---|
2476 | $query = $this->_modifyQuery($query, true, $limit, $offset); |
---|
2477 | |
---|
2478 | $connection = $this->getConnection(); |
---|
2479 | if (PEAR::isError($connection)) { |
---|
2480 | return $connection; |
---|
2481 | } |
---|
2482 | |
---|
2483 | $result =& $this->_doQuery($query, true, $connection, $this->database_name); |
---|
2484 | if (PEAR::isError($result)) { |
---|
2485 | return $result; |
---|
2486 | } |
---|
2487 | |
---|
2488 | $affectedRows = $this->_affectedRows($connection, $result); |
---|
2489 | return $affectedRows; |
---|
2490 | } |
---|
2491 | |
---|
2492 | // }}} |
---|
2493 | // {{{ function &query($query, $types = null, $result_class = true, $result_wrap_class = false) |
---|
2494 | |
---|
2495 | /** |
---|
2496 | * Send a query to the database and return any results |
---|
2497 | * |
---|
2498 | * @param string the SQL query |
---|
2499 | * @param mixed array that contains the types of the columns in |
---|
2500 | * the result set |
---|
2501 | * @param mixed string which specifies which result class to use |
---|
2502 | * @param mixed string which specifies which class to wrap results in |
---|
2503 | * |
---|
2504 | * @return mixed an MDB2_Result handle on success, a MDB2 error on failure |
---|
2505 | * |
---|
2506 | * @access public |
---|
2507 | */ |
---|
2508 | function &query($query, $types = null, $result_class = true, $result_wrap_class = false) |
---|
2509 | { |
---|
2510 | $offset = $this->offset; |
---|
2511 | $limit = $this->limit; |
---|
2512 | $this->offset = $this->limit = 0; |
---|
2513 | $query = $this->_modifyQuery($query, false, $limit, $offset); |
---|
2514 | |
---|
2515 | $connection = $this->getConnection(); |
---|
2516 | if (PEAR::isError($connection)) { |
---|
2517 | return $connection; |
---|
2518 | } |
---|
2519 | |
---|
2520 | $result =& $this->_doQuery($query, false, $connection, $this->database_name); |
---|
2521 | if (PEAR::isError($result)) { |
---|
2522 | return $result; |
---|
2523 | } |
---|
2524 | |
---|
2525 | $result =& $this->_wrapResult($result, $types, $result_class, $result_wrap_class, $limit, $offset); |
---|
2526 | return $result; |
---|
2527 | } |
---|
2528 | |
---|
2529 | // }}} |
---|
2530 | // {{{ function &_wrapResult($result, $types = array(), $result_class = true, $result_wrap_class = false, $limit = null, $offset = null) |
---|
2531 | |
---|
2532 | /** |
---|
2533 | * wrap a result set into the correct class |
---|
2534 | * |
---|
2535 | * @param resource result handle |
---|
2536 | * @param mixed array that contains the types of the columns in |
---|
2537 | * the result set |
---|
2538 | * @param mixed string which specifies which result class to use |
---|
2539 | * @param mixed string which specifies which class to wrap results in |
---|
2540 | * @param string number of rows to select |
---|
2541 | * @param string first row to select |
---|
2542 | * |
---|
2543 | * @return mixed an MDB2_Result, a MDB2 error on failure |
---|
2544 | * |
---|
2545 | * @access protected |
---|
2546 | */ |
---|
2547 | function &_wrapResult($result, $types = array(), $result_class = true, |
---|
2548 | $result_wrap_class = false, $limit = null, $offset = null) |
---|
2549 | { |
---|
2550 | if ($types === true) { |
---|
2551 | if ($this->supports('result_introspection')) { |
---|
2552 | $this->loadModule('Reverse', null, true); |
---|
2553 | $tableInfo = $this->reverse->tableInfo($result); |
---|
2554 | if (PEAR::isError($tableInfo)) { |
---|
2555 | return $tableInfo; |
---|
2556 | } |
---|
2557 | $types = array(); |
---|
2558 | foreach ($tableInfo as $field) { |
---|
2559 | $types[] = $field['mdb2type']; |
---|
2560 | } |
---|
2561 | } else { |
---|
2562 | $types = null; |
---|
2563 | } |
---|
2564 | } |
---|
2565 | |
---|
2566 | if ($result_class === true) { |
---|
2567 | $result_class = $this->options['result_buffering'] |
---|
2568 | ? $this->options['buffered_result_class'] : $this->options['result_class']; |
---|
2569 | } |
---|
2570 | |
---|
2571 | if ($result_class) { |
---|
2572 | $class_name = sprintf($result_class, $this->phptype); |
---|
2573 | if (!MDB2::classExists($class_name)) { |
---|
2574 | $err =& $this->raiseError(MDB2_ERROR_NOT_FOUND, null, null, |
---|
2575 | 'result class does not exist '.$class_name, __FUNCTION__); |
---|
2576 | return $err; |
---|
2577 | } |
---|
2578 | $result =& new $class_name($this, $result, $limit, $offset); |
---|
2579 | if (!MDB2::isResultCommon($result)) { |
---|
2580 | $err =& $this->raiseError(MDB2_ERROR_NOT_FOUND, null, null, |
---|
2581 | 'result class is not extended from MDB2_Result_Common', __FUNCTION__); |
---|
2582 | return $err; |
---|
2583 | } |
---|
2584 | if (!empty($types)) { |
---|
2585 | $err = $result->setResultTypes($types); |
---|
2586 | if (PEAR::isError($err)) { |
---|
2587 | $result->free(); |
---|
2588 | return $err; |
---|
2589 | } |
---|
2590 | } |
---|
2591 | } |
---|
2592 | if ($result_wrap_class === true) { |
---|
2593 | $result_wrap_class = $this->options['result_wrap_class']; |
---|
2594 | } |
---|
2595 | if ($result_wrap_class) { |
---|
2596 | if (!MDB2::classExists($result_wrap_class)) { |
---|
2597 | $err =& $this->raiseError(MDB2_ERROR_NOT_FOUND, null, null, |
---|
2598 | 'result wrap class does not exist '.$result_wrap_class, __FUNCTION__); |
---|
2599 | return $err; |
---|
2600 | } |
---|
2601 | $result =& new $result_wrap_class($result, $this->fetchmode); |
---|
2602 | } |
---|
2603 | return $result; |
---|
2604 | } |
---|
2605 | |
---|
2606 | // }}} |
---|
2607 | // {{{ function getServerVersion($native = false) |
---|
2608 | |
---|
2609 | /** |
---|
2610 | * return version information about the server |
---|
2611 | * |
---|
2612 | * @param bool determines if the raw version string should be returned |
---|
2613 | * |
---|
2614 | * @return mixed array with version information or row string |
---|
2615 | * |
---|
2616 | * @access public |
---|
2617 | */ |
---|
2618 | function getServerVersion($native = false) |
---|
2619 | { |
---|
2620 | return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
2621 | 'method not implemented', __FUNCTION__); |
---|
2622 | } |
---|
2623 | |
---|
2624 | // }}} |
---|
2625 | // {{{ function setLimit($limit, $offset = null) |
---|
2626 | |
---|
2627 | /** |
---|
2628 | * set the range of the next query |
---|
2629 | * |
---|
2630 | * @param string number of rows to select |
---|
2631 | * @param string first row to select |
---|
2632 | * |
---|
2633 | * @return mixed MDB2_OK on success, a MDB2 error on failure |
---|
2634 | * |
---|
2635 | * @access public |
---|
2636 | */ |
---|
2637 | function setLimit($limit, $offset = null) |
---|
2638 | { |
---|
2639 | if (!$this->supports('limit_queries')) { |
---|
2640 | return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
2641 | 'limit is not supported by this driver', __FUNCTION__); |
---|
2642 | } |
---|
2643 | $limit = (int)$limit; |
---|
2644 | if ($limit < 0) { |
---|
2645 | return $this->raiseError(MDB2_ERROR_SYNTAX, null, null, |
---|
2646 | 'it was not specified a valid selected range row limit', __FUNCTION__); |
---|
2647 | } |
---|
2648 | $this->limit = $limit; |
---|
2649 | if (!is_null($offset)) { |
---|
2650 | $offset = (int)$offset; |
---|
2651 | if ($offset < 0) { |
---|
2652 | return $this->raiseError(MDB2_ERROR_SYNTAX, null, null, |
---|
2653 | 'it was not specified a valid first selected range row', __FUNCTION__); |
---|
2654 | } |
---|
2655 | $this->offset = $offset; |
---|
2656 | } |
---|
2657 | return MDB2_OK; |
---|
2658 | } |
---|
2659 | |
---|
2660 | // }}} |
---|
2661 | // {{{ function subSelect($query, $type = false) |
---|
2662 | |
---|
2663 | /** |
---|
2664 | * simple subselect emulation: leaves the query untouched for all RDBMS |
---|
2665 | * that support subselects |
---|
2666 | * |
---|
2667 | * @param string the SQL query for the subselect that may only |
---|
2668 | * return a column |
---|
2669 | * @param string determines type of the field |
---|
2670 | * |
---|
2671 | * @return string the query |
---|
2672 | * |
---|
2673 | * @access public |
---|
2674 | */ |
---|
2675 | function subSelect($query, $type = false) |
---|
2676 | { |
---|
2677 | if ($this->supports('sub_selects') === true) { |
---|
2678 | return $query; |
---|
2679 | } |
---|
2680 | |
---|
2681 | if (!$this->supports('sub_selects')) { |
---|
2682 | return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
2683 | 'method not implemented', __FUNCTION__); |
---|
2684 | } |
---|
2685 | |
---|
2686 | $col = $this->queryCol($query, $type); |
---|
2687 | if (PEAR::isError($col)) { |
---|
2688 | return $col; |
---|
2689 | } |
---|
2690 | if (!is_array($col) || count($col) == 0) { |
---|
2691 | return 'NULL'; |
---|
2692 | } |
---|
2693 | if ($type) { |
---|
2694 | sfprintr($module.":2"); |
---|
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 | sfprintr($module.":3"); |
---|
3019 | $result = $this->loadModule('Datatype', null, true); |
---|
3020 | if (PEAR::isError($result)) { |
---|
3021 | return $result; |
---|
3022 | } |
---|
3023 | |
---|
3024 | return $this->datatype->quote($value, $type, $quote, $escape_wildcards); |
---|
3025 | } |
---|
3026 | |
---|
3027 | // }}} |
---|
3028 | // {{{ function getDeclaration($type, $name, $field) |
---|
3029 | |
---|
3030 | /** |
---|
3031 | * Obtain DBMS specific SQL code portion needed to declare |
---|
3032 | * of the given type |
---|
3033 | * |
---|
3034 | * @param string type to which the value should be converted to |
---|
3035 | * @param string name the field to be declared. |
---|
3036 | * @param string definition of the field |
---|
3037 | * |
---|
3038 | * @return string DBMS specific SQL code portion that should be used to |
---|
3039 | * declare the specified field. |
---|
3040 | * |
---|
3041 | * @access public |
---|
3042 | */ |
---|
3043 | function getDeclaration($type, $name, $field) |
---|
3044 | { |
---|
3045 | sfprintr($module.":4"); |
---|
3046 | $result = $this->loadModule('Datatype', null, true); |
---|
3047 | if (PEAR::isError($result)) { |
---|
3048 | return $result; |
---|
3049 | } |
---|
3050 | return $this->datatype->getDeclaration($type, $name, $field); |
---|
3051 | } |
---|
3052 | |
---|
3053 | // }}} |
---|
3054 | // {{{ function compareDefinition($current, $previous) |
---|
3055 | |
---|
3056 | /** |
---|
3057 | * Obtain an array of changes that may need to applied |
---|
3058 | * |
---|
3059 | * @param array new definition |
---|
3060 | * @param array old definition |
---|
3061 | * |
---|
3062 | * @return array containing all changes that will need to be applied |
---|
3063 | * |
---|
3064 | * @access public |
---|
3065 | */ |
---|
3066 | function compareDefinition($current, $previous) |
---|
3067 | { |
---|
3068 | sfprintr($module.":5"); |
---|
3069 | $result = $this->loadModule('Datatype', null, true); |
---|
3070 | if (PEAR::isError($result)) { |
---|
3071 | return $result; |
---|
3072 | } |
---|
3073 | return $this->datatype->compareDefinition($current, $previous); |
---|
3074 | } |
---|
3075 | |
---|
3076 | // }}} |
---|
3077 | // {{{ function supports($feature) |
---|
3078 | |
---|
3079 | /** |
---|
3080 | * Tell whether a DB implementation or its backend extension |
---|
3081 | * supports a given feature. |
---|
3082 | * |
---|
3083 | * @param string name of the feature (see the MDB2 class doc) |
---|
3084 | * |
---|
3085 | * @return bool|string if this DB implementation supports a given feature |
---|
3086 | * false means no, true means native, |
---|
3087 | * 'emulated' means emulated |
---|
3088 | * |
---|
3089 | * @access public |
---|
3090 | */ |
---|
3091 | function supports($feature) |
---|
3092 | { |
---|
3093 | if (array_key_exists($feature, $this->supported)) { |
---|
3094 | return $this->supported[$feature]; |
---|
3095 | } |
---|
3096 | return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
3097 | "unknown support feature $feature", __FUNCTION__); |
---|
3098 | } |
---|
3099 | |
---|
3100 | // }}} |
---|
3101 | // {{{ function getSequenceName($sqn) |
---|
3102 | |
---|
3103 | /** |
---|
3104 | * adds sequence name formatting to a sequence name |
---|
3105 | * |
---|
3106 | * @param string name of the sequence |
---|
3107 | * |
---|
3108 | * @return string formatted sequence name |
---|
3109 | * |
---|
3110 | * @access public |
---|
3111 | */ |
---|
3112 | function getSequenceName($sqn) |
---|
3113 | { |
---|
3114 | return sprintf($this->options['seqname_format'], |
---|
3115 | preg_replace('/[^a-z0-9_\$.]/i', '_', $sqn)); |
---|
3116 | } |
---|
3117 | |
---|
3118 | // }}} |
---|
3119 | // {{{ function getIndexName($idx) |
---|
3120 | |
---|
3121 | /** |
---|
3122 | * adds index name formatting to a index name |
---|
3123 | * |
---|
3124 | * @param string name of the index |
---|
3125 | * |
---|
3126 | * @return string formatted index name |
---|
3127 | * |
---|
3128 | * @access public |
---|
3129 | */ |
---|
3130 | function getIndexName($idx) |
---|
3131 | { |
---|
3132 | return sprintf($this->options['idxname_format'], |
---|
3133 | preg_replace('/[^a-z0-9_\$]/i', '_', $idx)); |
---|
3134 | } |
---|
3135 | |
---|
3136 | // }}} |
---|
3137 | // {{{ function nextID($seq_name, $ondemand = true) |
---|
3138 | |
---|
3139 | /** |
---|
3140 | * Returns the next free id of a sequence |
---|
3141 | * |
---|
3142 | * @param string name of the sequence |
---|
3143 | * @param bool when true missing sequences are automatic created |
---|
3144 | * |
---|
3145 | * @return mixed MDB2 Error Object or id |
---|
3146 | * |
---|
3147 | * @access public |
---|
3148 | */ |
---|
3149 | function nextID($seq_name, $ondemand = true) |
---|
3150 | { |
---|
3151 | return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
3152 | 'method not implemented', __FUNCTION__); |
---|
3153 | } |
---|
3154 | |
---|
3155 | // }}} |
---|
3156 | // {{{ function lastInsertID($table = null, $field = null) |
---|
3157 | |
---|
3158 | /** |
---|
3159 | * Returns the autoincrement ID if supported or $id or fetches the current |
---|
3160 | * ID in a sequence called: $table.(empty($field) ? '' : '_'.$field) |
---|
3161 | * |
---|
3162 | * @param string name of the table into which a new row was inserted |
---|
3163 | * @param string name of the field into which a new row was inserted |
---|
3164 | * |
---|
3165 | * @return mixed MDB2 Error Object or id |
---|
3166 | * |
---|
3167 | * @access public |
---|
3168 | */ |
---|
3169 | function lastInsertID($table = null, $field = null) |
---|
3170 | { |
---|
3171 | return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
3172 | 'method not implemented', __FUNCTION__); |
---|
3173 | } |
---|
3174 | |
---|
3175 | // }}} |
---|
3176 | // {{{ function currID($seq_name) |
---|
3177 | |
---|
3178 | /** |
---|
3179 | * Returns the current id of a sequence |
---|
3180 | * |
---|
3181 | * @param string name of the sequence |
---|
3182 | * |
---|
3183 | * @return mixed MDB2 Error Object or id |
---|
3184 | * |
---|
3185 | * @access public |
---|
3186 | */ |
---|
3187 | function currID($seq_name) |
---|
3188 | { |
---|
3189 | $this->warnings[] = 'database does not support getting current |
---|
3190 | sequence value, the sequence value was incremented'; |
---|
3191 | return $this->nextID($seq_name); |
---|
3192 | } |
---|
3193 | |
---|
3194 | // }}} |
---|
3195 | // {{{ function queryOne($query, $type = null, $colnum = 0) |
---|
3196 | |
---|
3197 | /** |
---|
3198 | * Execute the specified query, fetch the value from the first column of |
---|
3199 | * the first row of the result set and then frees |
---|
3200 | * the result set. |
---|
3201 | * |
---|
3202 | * @param string the SELECT query statement to be executed. |
---|
3203 | * @param string optional argument that specifies the expected |
---|
3204 | * datatype of the result set field, so that an eventual conversion |
---|
3205 | * may be performed. The default datatype is text, meaning that no |
---|
3206 | * conversion is performed |
---|
3207 | * @param int the column number to fetch |
---|
3208 | * |
---|
3209 | * @return mixed MDB2_OK or field value on success, a MDB2 error on failure |
---|
3210 | * |
---|
3211 | * @access public |
---|
3212 | */ |
---|
3213 | function queryOne($query, $type = null, $colnum = 0) |
---|
3214 | { |
---|
3215 | $result = $this->query($query, $type); |
---|
3216 | if (!MDB2::isResultCommon($result)) { |
---|
3217 | return $result; |
---|
3218 | } |
---|
3219 | |
---|
3220 | $one = $result->fetchOne($colnum); |
---|
3221 | $result->free(); |
---|
3222 | return $one; |
---|
3223 | } |
---|
3224 | |
---|
3225 | // }}} |
---|
3226 | // {{{ function queryRow($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT) |
---|
3227 | |
---|
3228 | /** |
---|
3229 | * Execute the specified query, fetch the values from the first |
---|
3230 | * row of the result set into an array and then frees |
---|
3231 | * the result set. |
---|
3232 | * |
---|
3233 | * @param string the SELECT query statement to be executed. |
---|
3234 | * @param array optional array argument that specifies a list of |
---|
3235 | * expected datatypes of the result set columns, so that the eventual |
---|
3236 | * conversions may be performed. The default list of datatypes is |
---|
3237 | * empty, meaning that no conversion is performed. |
---|
3238 | * @param int how the array data should be indexed |
---|
3239 | * |
---|
3240 | * @return mixed MDB2_OK or data array on success, a MDB2 error on failure |
---|
3241 | * |
---|
3242 | * @access public |
---|
3243 | */ |
---|
3244 | function queryRow($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT) |
---|
3245 | { |
---|
3246 | $result = $this->query($query, $types); |
---|
3247 | if (!MDB2::isResultCommon($result)) { |
---|
3248 | return $result; |
---|
3249 | } |
---|
3250 | |
---|
3251 | $row = $result->fetchRow($fetchmode); |
---|
3252 | $result->free(); |
---|
3253 | return $row; |
---|
3254 | } |
---|
3255 | |
---|
3256 | // }}} |
---|
3257 | // {{{ function queryCol($query, $type = null, $colnum = 0) |
---|
3258 | |
---|
3259 | /** |
---|
3260 | * Execute the specified query, fetch the value from the first column of |
---|
3261 | * each row of the result set into an array and then frees the result set. |
---|
3262 | * |
---|
3263 | * @param string the SELECT query statement to be executed. |
---|
3264 | * @param string optional argument that specifies the expected |
---|
3265 | * datatype of the result set field, so that an eventual conversion |
---|
3266 | * may be performed. The default datatype is text, meaning that no |
---|
3267 | * conversion is performed |
---|
3268 | * @param int the row number to fetch |
---|
3269 | * |
---|
3270 | * @return mixed MDB2_OK or data array on success, a MDB2 error on failure |
---|
3271 | * |
---|
3272 | * @access public |
---|
3273 | */ |
---|
3274 | function queryCol($query, $type = null, $colnum = 0) |
---|
3275 | { |
---|
3276 | $result = $this->query($query, $type); |
---|
3277 | if (!MDB2::isResultCommon($result)) { |
---|
3278 | return $result; |
---|
3279 | } |
---|
3280 | |
---|
3281 | $col = $result->fetchCol($colnum); |
---|
3282 | $result->free(); |
---|
3283 | return $col; |
---|
3284 | } |
---|
3285 | |
---|
3286 | // }}} |
---|
3287 | // {{{ function queryAll($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT, $rekey = false, $force_array = false, $group = false) |
---|
3288 | |
---|
3289 | /** |
---|
3290 | * Execute the specified query, fetch all the rows of the result set into |
---|
3291 | * a two dimensional array and then frees the result set. |
---|
3292 | * |
---|
3293 | * @param string the SELECT query statement to be executed. |
---|
3294 | * @param array optional array argument that specifies a list of |
---|
3295 | * expected datatypes of the result set columns, so that the eventual |
---|
3296 | * conversions may be performed. The default list of datatypes is |
---|
3297 | * empty, meaning that no conversion is performed. |
---|
3298 | * @param int how the array data should be indexed |
---|
3299 | * @param bool if set to true, the $all will have the first |
---|
3300 | * column as its first dimension |
---|
3301 | * @param bool used only when the query returns exactly |
---|
3302 | * two columns. If true, the values of the returned array will be |
---|
3303 | * one-element arrays instead of scalars. |
---|
3304 | * @param bool if true, the values of the returned array is |
---|
3305 | * wrapped in another array. If the same key value (in the first |
---|
3306 | * column) repeats itself, the values will be appended to this array |
---|
3307 | * instead of overwriting the existing values. |
---|
3308 | * |
---|
3309 | * @return mixed MDB2_OK or data array on success, a MDB2 error on failure |
---|
3310 | * |
---|
3311 | * @access public |
---|
3312 | */ |
---|
3313 | function queryAll($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT, |
---|
3314 | $rekey = false, $force_array = false, $group = false) |
---|
3315 | { |
---|
3316 | $result = $this->query($query, $types); |
---|
3317 | if (!MDB2::isResultCommon($result)) { |
---|
3318 | return $result; |
---|
3319 | } |
---|
3320 | |
---|
3321 | $all = $result->fetchAll($fetchmode, $rekey, $force_array, $group); |
---|
3322 | $result->free(); |
---|
3323 | return $all; |
---|
3324 | } |
---|
3325 | |
---|
3326 | // }}} |
---|
3327 | } |
---|
3328 | |
---|
3329 | // }}} |
---|
3330 | // {{{ class MDB2_Result |
---|
3331 | |
---|
3332 | /** |
---|
3333 | * The dummy class that all user space result classes should extend from |
---|
3334 | * |
---|
3335 | * @package MDB2 |
---|
3336 | * @category Database |
---|
3337 | * @author Lukas Smith <smith@pooteeweet.org> |
---|
3338 | */ |
---|
3339 | class MDB2_Result |
---|
3340 | { |
---|
3341 | } |
---|
3342 | |
---|
3343 | // }}} |
---|
3344 | // {{{ class MDB2_Result_Common extends MDB2_Result |
---|
3345 | |
---|
3346 | /** |
---|
3347 | * The common result class for MDB2 result objects |
---|
3348 | * |
---|
3349 | * @package MDB2 |
---|
3350 | * @category Database |
---|
3351 | * @author Lukas Smith <smith@pooteeweet.org> |
---|
3352 | */ |
---|
3353 | class MDB2_Result_Common extends MDB2_Result |
---|
3354 | { |
---|
3355 | // {{{ Variables (Properties) |
---|
3356 | |
---|
3357 | var $db; |
---|
3358 | var $result; |
---|
3359 | var $rownum = -1; |
---|
3360 | var $types = array(); |
---|
3361 | var $values = array(); |
---|
3362 | var $offset; |
---|
3363 | var $offset_count = 0; |
---|
3364 | var $limit; |
---|
3365 | var $column_names; |
---|
3366 | |
---|
3367 | // }}} |
---|
3368 | // {{{ constructor: function __construct(&$db, &$result, $limit = 0, $offset = 0) |
---|
3369 | |
---|
3370 | /** |
---|
3371 | * Constructor |
---|
3372 | */ |
---|
3373 | function __construct(&$db, &$result, $limit = 0, $offset = 0) |
---|
3374 | { |
---|
3375 | $this->db =& $db; |
---|
3376 | $this->result =& $result; |
---|
3377 | $this->offset = $offset; |
---|
3378 | $this->limit = max(0, $limit - 1); |
---|
3379 | } |
---|
3380 | |
---|
3381 | // }}} |
---|
3382 | // {{{ function MDB2_Result_Common(&$db, &$result, $limit = 0, $offset = 0) |
---|
3383 | |
---|
3384 | /** |
---|
3385 | * PHP 4 Constructor |
---|
3386 | */ |
---|
3387 | function MDB2_Result_Common(&$db, &$result, $limit = 0, $offset = 0) |
---|
3388 | { |
---|
3389 | $this->__construct($db, $result, $limit, $offset); |
---|
3390 | } |
---|
3391 | |
---|
3392 | // }}} |
---|
3393 | // {{{ function setResultTypes($types) |
---|
3394 | |
---|
3395 | /** |
---|
3396 | * Define the list of types to be associated with the columns of a given |
---|
3397 | * result set. |
---|
3398 | * |
---|
3399 | * This function may be called before invoking fetchRow(), fetchOne(), |
---|
3400 | * fetchCol() and fetchAll() so that the necessary data type |
---|
3401 | * conversions are performed on the data to be retrieved by them. If this |
---|
3402 | * function is not called, the type of all result set columns is assumed |
---|
3403 | * to be text, thus leading to not perform any conversions. |
---|
3404 | * |
---|
3405 | * @param array variable that lists the |
---|
3406 | * data types to be expected in the result set columns. If this array |
---|
3407 | * contains less types than the number of columns that are returned |
---|
3408 | * in the result set, the remaining columns are assumed to be of the |
---|
3409 | * type text. Currently, the types clob and blob are not fully |
---|
3410 | * supported. |
---|
3411 | * |
---|
3412 | * @return mixed MDB2_OK on success, a MDB2 error on failure |
---|
3413 | * |
---|
3414 | * @access public |
---|
3415 | */ |
---|
3416 | function setResultTypes($types) |
---|
3417 | { |
---|
3418 | sfprintr($module.":6"); |
---|
3419 | $load = $this->db->loadModule('Datatype', null, true); |
---|
3420 | if (PEAR::isError($load)) { |
---|
3421 | return $load; |
---|
3422 | } |
---|
3423 | $types = $this->db->datatype->checkResultTypes($types); |
---|
3424 | if (PEAR::isError($types)) { |
---|
3425 | return $types; |
---|
3426 | } |
---|
3427 | $this->types = $types; |
---|
3428 | return MDB2_OK; |
---|
3429 | } |
---|
3430 | |
---|
3431 | // }}} |
---|
3432 | // {{{ function seek($rownum = 0) |
---|
3433 | |
---|
3434 | /** |
---|
3435 | * Seek to a specific row in a result set |
---|
3436 | * |
---|
3437 | * @param int number of the row where the data can be found |
---|
3438 | * |
---|
3439 | * @return mixed MDB2_OK on success, a MDB2 error on failure |
---|
3440 | * |
---|
3441 | * @access public |
---|
3442 | */ |
---|
3443 | function seek($rownum = 0) |
---|
3444 | { |
---|
3445 | $target_rownum = $rownum - 1; |
---|
3446 | if ($this->rownum > $target_rownum) { |
---|
3447 | return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
3448 | 'seeking to previous rows not implemented', __FUNCTION__); |
---|
3449 | } |
---|
3450 | while ($this->rownum < $target_rownum) { |
---|
3451 | $this->fetchRow(); |
---|
3452 | } |
---|
3453 | return MDB2_OK; |
---|
3454 | } |
---|
3455 | |
---|
3456 | // }}} |
---|
3457 | // {{{ function &fetchRow($fetchmode = MDB2_FETCHMODE_DEFAULT, $rownum = null) |
---|
3458 | |
---|
3459 | /** |
---|
3460 | * Fetch and return a row of data |
---|
3461 | * |
---|
3462 | * @param int how the array data should be indexed |
---|
3463 | * @param int number of the row where the data can be found |
---|
3464 | * |
---|
3465 | * @return int data array on success, a MDB2 error on failure |
---|
3466 | * |
---|
3467 | * @access public |
---|
3468 | */ |
---|
3469 | function &fetchRow($fetchmode = MDB2_FETCHMODE_DEFAULT, $rownum = null) |
---|
3470 | { |
---|
3471 | $err =& $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
3472 | 'method not implemented', __FUNCTION__); |
---|
3473 | return $err; |
---|
3474 | } |
---|
3475 | |
---|
3476 | // }}} |
---|
3477 | // {{{ function fetchOne($colnum = 0) |
---|
3478 | |
---|
3479 | /** |
---|
3480 | * fetch single column from the next row from a result set |
---|
3481 | * |
---|
3482 | * @param int the column number to fetch |
---|
3483 | * @param int number of the row where the data can be found |
---|
3484 | * |
---|
3485 | * @return string data on success, a MDB2 error on failure |
---|
3486 | * |
---|
3487 | * @access public |
---|
3488 | */ |
---|
3489 | function fetchOne($colnum = 0, $rownum = null) |
---|
3490 | { |
---|
3491 | $fetchmode = is_numeric($colnum) ? MDB2_FETCHMODE_ORDERED : MDB2_FETCHMODE_ASSOC; |
---|
3492 | $row = $this->fetchRow($fetchmode, $rownum); |
---|
3493 | if (!is_array($row) || PEAR::isError($row)) { |
---|
3494 | return $row; |
---|
3495 | } |
---|
3496 | if (!array_key_exists($colnum, $row)) { |
---|
3497 | return $this->db->raiseError(MDB2_ERROR_TRUNCATED, null, null, |
---|
3498 | 'column is not defined in the result set: '.$colnum, __FUNCTION__); |
---|
3499 | } |
---|
3500 | return $row[$colnum]; |
---|
3501 | } |
---|
3502 | |
---|
3503 | // }}} |
---|
3504 | // {{{ function fetchCol($colnum = 0) |
---|
3505 | |
---|
3506 | /** |
---|
3507 | * Fetch and return a column from the current row pointer position |
---|
3508 | * |
---|
3509 | * @param int the column number to fetch |
---|
3510 | * |
---|
3511 | * @return mixed data array on success, a MDB2 error on failure |
---|
3512 | * |
---|
3513 | * @access public |
---|
3514 | */ |
---|
3515 | function fetchCol($colnum = 0) |
---|
3516 | { |
---|
3517 | $column = array(); |
---|
3518 | $fetchmode = is_numeric($colnum) ? MDB2_FETCHMODE_ORDERED : MDB2_FETCHMODE_ASSOC; |
---|
3519 | $row = $this->fetchRow($fetchmode); |
---|
3520 | if (is_array($row)) { |
---|
3521 | if (!array_key_exists($colnum, $row)) { |
---|
3522 | return $this->db->raiseError(MDB2_ERROR_TRUNCATED, null, null, |
---|
3523 | 'column is not defined in the result set: '.$colnum, __FUNCTION__); |
---|
3524 | } |
---|
3525 | do { |
---|
3526 | $column[] = $row[$colnum]; |
---|
3527 | } while (is_array($row = $this->fetchRow($fetchmode))); |
---|
3528 | } |
---|
3529 | if (PEAR::isError($row)) { |
---|
3530 | return $row; |
---|
3531 | } |
---|
3532 | return $column; |
---|
3533 | } |
---|
3534 | |
---|
3535 | // }}} |
---|
3536 | // {{{ function fetchAll($fetchmode = MDB2_FETCHMODE_DEFAULT, $rekey = false, $force_array = false, $group = false) |
---|
3537 | |
---|
3538 | /** |
---|
3539 | * Fetch and return all rows from the current row pointer position |
---|
3540 | * |
---|
3541 | * @param int $fetchmode the fetch mode to use: |
---|
3542 | * + MDB2_FETCHMODE_ORDERED |
---|
3543 | * + MDB2_FETCHMODE_ASSOC |
---|
3544 | * + MDB2_FETCHMODE_ORDERED | MDB2_FETCHMODE_FLIPPED |
---|
3545 | * + MDB2_FETCHMODE_ASSOC | MDB2_FETCHMODE_FLIPPED |
---|
3546 | * @param bool if set to true, the $all will have the first |
---|
3547 | * column as its first dimension |
---|
3548 | * @param bool used only when the query returns exactly |
---|
3549 | * two columns. If true, the values of the returned array will be |
---|
3550 | * one-element arrays instead of scalars. |
---|
3551 | * @param bool if true, the values of the returned array is |
---|
3552 | * wrapped in another array. If the same key value (in the first |
---|
3553 | * column) repeats itself, the values will be appended to this array |
---|
3554 | * instead of overwriting the existing values. |
---|
3555 | * |
---|
3556 | * @return mixed data array on success, a MDB2 error on failure |
---|
3557 | * |
---|
3558 | * @access public |
---|
3559 | * @see getAssoc() |
---|
3560 | */ |
---|
3561 | function fetchAll($fetchmode = MDB2_FETCHMODE_DEFAULT, $rekey = false, |
---|
3562 | $force_array = false, $group = false) |
---|
3563 | { |
---|
3564 | $all = array(); |
---|
3565 | $row = $this->fetchRow($fetchmode); |
---|
3566 | if (PEAR::isError($row)) { |
---|
3567 | return $row; |
---|
3568 | } elseif (!$row) { |
---|
3569 | return $all; |
---|
3570 | } |
---|
3571 | |
---|
3572 | $shift_array = $rekey ? false : null; |
---|
3573 | if (!is_null($shift_array)) { |
---|
3574 | if (is_object($row)) { |
---|
3575 | $colnum = count(get_object_vars($row)); |
---|
3576 | } else { |
---|
3577 | $colnum = count($row); |
---|
3578 | } |
---|
3579 | if ($colnum < 2) { |
---|
3580 | return $this->db->raiseError(MDB2_ERROR_TRUNCATED, null, null, |
---|
3581 | 'rekey feature requires atleast 2 column', __FUNCTION__); |
---|
3582 | } |
---|
3583 | $shift_array = (!$force_array && $colnum == 2); |
---|
3584 | } |
---|
3585 | |
---|
3586 | if ($rekey) { |
---|
3587 | do { |
---|
3588 | if (is_object($row)) { |
---|
3589 | $arr = get_object_vars($row); |
---|
3590 | $key = reset($arr); |
---|
3591 | unset($row->{$key}); |
---|
3592 | } else { |
---|
3593 | if ($fetchmode & MDB2_FETCHMODE_ASSOC) { |
---|
3594 | $key = reset($row); |
---|
3595 | unset($row[key($row)]); |
---|
3596 | } else { |
---|
3597 | $key = array_shift($row); |
---|
3598 | } |
---|
3599 | if ($shift_array) { |
---|
3600 | $row = array_shift($row); |
---|
3601 | } |
---|
3602 | } |
---|
3603 | if ($group) { |
---|
3604 | $all[$key][] = $row; |
---|
3605 | } else { |
---|
3606 | $all[$key] = $row; |
---|
3607 | } |
---|
3608 | } while (($row = $this->fetchRow($fetchmode))); |
---|
3609 | } elseif ($fetchmode & MDB2_FETCHMODE_FLIPPED) { |
---|
3610 | do { |
---|
3611 | foreach ($row as $key => $val) { |
---|
3612 | $all[$key][] = $val; |
---|
3613 | } |
---|
3614 | } while (($row = $this->fetchRow($fetchmode))); |
---|
3615 | } else { |
---|
3616 | do { |
---|
3617 | $all[] = $row; |
---|
3618 | } while (($row = $this->fetchRow($fetchmode))); |
---|
3619 | } |
---|
3620 | |
---|
3621 | return $all; |
---|
3622 | } |
---|
3623 | |
---|
3624 | // }}} |
---|
3625 | // {{{ function rowCount() |
---|
3626 | /** |
---|
3627 | * Returns the actual row number that was last fetched (count from 0) |
---|
3628 | * @return int |
---|
3629 | * |
---|
3630 | * @access public |
---|
3631 | */ |
---|
3632 | function rowCount() |
---|
3633 | { |
---|
3634 | return $this->rownum + 1; |
---|
3635 | } |
---|
3636 | |
---|
3637 | // }}} |
---|
3638 | // {{{ function numRows() |
---|
3639 | |
---|
3640 | /** |
---|
3641 | * Returns the number of rows in a result object |
---|
3642 | * |
---|
3643 | * @return mixed MDB2 Error Object or the number of rows |
---|
3644 | * |
---|
3645 | * @access public |
---|
3646 | */ |
---|
3647 | function numRows() |
---|
3648 | { |
---|
3649 | return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
3650 | 'method not implemented', __FUNCTION__); |
---|
3651 | } |
---|
3652 | |
---|
3653 | // }}} |
---|
3654 | // {{{ function nextResult() |
---|
3655 | |
---|
3656 | /** |
---|
3657 | * Move the internal result pointer to the next available result |
---|
3658 | * |
---|
3659 | * @return true on success, false if there is no more result set or an error object on failure |
---|
3660 | * |
---|
3661 | * @access public |
---|
3662 | */ |
---|
3663 | function nextResult() |
---|
3664 | { |
---|
3665 | return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
3666 | 'method not implemented', __FUNCTION__); |
---|
3667 | } |
---|
3668 | |
---|
3669 | // }}} |
---|
3670 | // {{{ function getColumnNames() |
---|
3671 | |
---|
3672 | /** |
---|
3673 | * Retrieve the names of columns returned by the DBMS in a query result or |
---|
3674 | * from the cache. |
---|
3675 | * |
---|
3676 | * @param bool If set to true the values are the column names, |
---|
3677 | * otherwise the names of the columns are the keys. |
---|
3678 | * @return mixed Array variable that holds the names of columns or an |
---|
3679 | * MDB2 error on failure. |
---|
3680 | * Some DBMS may not return any columns when the result set |
---|
3681 | * does not contain any rows. |
---|
3682 | * |
---|
3683 | * @access public |
---|
3684 | */ |
---|
3685 | function getColumnNames($flip = false) |
---|
3686 | { |
---|
3687 | if (!isset($this->column_names)) { |
---|
3688 | $result = $this->_getColumnNames(); |
---|
3689 | if (PEAR::isError($result)) { |
---|
3690 | return $result; |
---|
3691 | } |
---|
3692 | $this->column_names = $result; |
---|
3693 | } |
---|
3694 | if ($flip) { |
---|
3695 | return array_flip($this->column_names); |
---|
3696 | } |
---|
3697 | return $this->column_names; |
---|
3698 | } |
---|
3699 | |
---|
3700 | // }}} |
---|
3701 | // {{{ function _getColumnNames() |
---|
3702 | |
---|
3703 | /** |
---|
3704 | * Retrieve the names of columns returned by the DBMS in a query result. |
---|
3705 | * |
---|
3706 | * @return mixed Array variable that holds the names of columns as keys |
---|
3707 | * or an MDB2 error on failure. |
---|
3708 | * Some DBMS may not return any columns when the result set |
---|
3709 | * does not contain any rows. |
---|
3710 | * |
---|
3711 | * @access private |
---|
3712 | */ |
---|
3713 | function _getColumnNames() |
---|
3714 | { |
---|
3715 | return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
3716 | 'method not implemented', __FUNCTION__); |
---|
3717 | } |
---|
3718 | |
---|
3719 | // }}} |
---|
3720 | // {{{ function numCols() |
---|
3721 | |
---|
3722 | /** |
---|
3723 | * Count the number of columns returned by the DBMS in a query result. |
---|
3724 | * |
---|
3725 | * @return mixed integer value with the number of columns, a MDB2 error |
---|
3726 | * on failure |
---|
3727 | * |
---|
3728 | * @access public |
---|
3729 | */ |
---|
3730 | function numCols() |
---|
3731 | { |
---|
3732 | return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null, |
---|
3733 | 'method not implemented', __FUNCTION__); |
---|
3734 | } |
---|
3735 | |
---|
3736 | // }}} |
---|
3737 | // {{{ function getResource() |
---|
3738 | |
---|
3739 | /** |
---|
3740 | * return the resource associated with the result object |
---|
3741 | * |
---|
3742 | * @return resource |
---|
3743 | * |
---|
3744 | * @access public |
---|
3745 | */ |
---|
3746 | function getResource() |
---|
3747 | { |
---|
3748 | return $this->result; |
---|
3749 | } |
---|
3750 | |
---|
3751 | // }}} |
---|
3752 | // {{{ function bindColumn($column, &$value, $type = null) |
---|
3753 | |
---|
3754 | /** |
---|
3755 | * Set bind variable to a column. |
---|
3756 | * |
---|
3757 | * @param int column number or name |
---|
3758 | * @param mixed variable reference |
---|
3759 | * @param string specifies the type of the field |
---|
3760 | * |
---|
3761 | * @return mixed MDB2_OK on success, a MDB2 error on failure |
---|
3762 | * |
---|
3763 | * @access public |
---|
3764 | */ |
---|
3765 | function bindColumn($column, &$value, $type = null) |
---|
3766 | { |
---|
3767 | if (!is_numeric($column)) { |
---|
3768 | $column_names = $this->getColumnNames(); |
---|
3769 | if ($this->db->options['portability'] & MDB2_PORTABILITY_FIX_CASE) { |
---|
3770 | if ($this->db->options['field_case'] == CASE_LOWER) { |
---|
3771 | $column = strtolower($column); |
---|
3772 | } else { |
---|
3773 | $column = strtoupper($column); |
---|
3774 | } |
---|
3775 | } |
---|
3776 | $column = $column_names[$column]; |
---|
3777 | } |
---|
3778 | $this->values[$column] =& $value; |
---|
3779 | if (!is_null($type)) { |
---|
3780 | $this->types[$column] = $type; |
---|
3781 | } |
---|
3782 | return MDB2_OK; |
---|
3783 | } |
---|
3784 | |
---|
3785 | // }}} |
---|
3786 | // {{{ function _assignBindColumns($row) |
---|
3787 | |
---|
3788 | /** |
---|
3789 | * Bind a variable to a value in the result row. |
---|
3790 | * |
---|
3791 | * @param array row data |
---|
3792 | * |
---|
3793 | * @return mixed MDB2_OK on success, a MDB2 error on failure |
---|
3794 | * |
---|
3795 | * @access private |
---|
3796 | */ |
---|
3797 | function _assignBindColumns($row) |
---|
3798 | { |
---|
3799 | $row = array_values($row); |
---|
3800 | foreach ($row as $column => $value) { |
---|
3801 | if (array_key_exists($column, $this->values)) { |
---|
3802 | $this->values[$column] = $value; |
---|
3803 | } |
---|
3804 | } |
---|
3805 | return MDB2_OK; |
---|
3806 | } |
---|
3807 | |
---|
3808 | // }}} |
---|
3809 | // {{{ function free() |
---|
3810 | |
---|
3811 | /** |
---|
3812 | * Free the internal resources associated with result. |
---|
3813 | * |
---|
3814 | * @return bool true on success, false if result is invalid |
---|
3815 | * |
---|
3816 | * @access public |
---|
3817 | */ |
---|
3818 | function free() |
---|
3819 | { |
---|
3820 | $this->result = false; |
---|
3821 | return MDB2_OK; |
---|
3822 | } |
---|
3823 | |
---|
3824 | // }}} |
---|
3825 | } |
---|
3826 | |
---|
3827 | // }}} |
---|
3828 | // {{{ class MDB2_Row |
---|
3829 | |
---|
3830 | /** |
---|
3831 | * The simple class that accepts row data as an array |
---|
3832 | * |
---|
3833 | * @package MDB2 |
---|
3834 | * @category Database |
---|
3835 | * @author Lukas Smith <smith@pooteeweet.org> |
---|
3836 | */ |
---|
3837 | class MDB2_Row |
---|
3838 | { |
---|
3839 | // {{{ constructor: function __construct(&$row) |
---|
3840 | |
---|
3841 | /** |
---|
3842 | * constructor |
---|
3843 | * |
---|
3844 | * @param resource row data as array |
---|
3845 | */ |
---|
3846 | function __construct(&$row) |
---|
3847 | { |
---|
3848 | foreach ($row as $key => $value) { |
---|
3849 | $this->$key = &$row[$key]; |
---|
3850 | } |
---|
3851 | } |
---|
3852 | |
---|
3853 | // }}} |
---|
3854 | // {{{ function MDB2_Row(&$row) |
---|
3855 | |
---|
3856 | /** |
---|
3857 | * PHP 4 Constructor |
---|
3858 | * |
---|
3859 | * @param resource row data as array |
---|
3860 | */ |
---|
3861 | function MDB2_Row(&$row) |
---|
3862 | { |
---|
3863 | $this->__construct($row); |
---|
3864 | } |
---|
3865 | |
---|
3866 | // }}} |
---|
3867 | } |
---|
3868 | |
---|
3869 | // }}} |
---|
3870 | // {{{ class MDB2_Statement_Common |
---|
3871 | |
---|
3872 | /** |
---|
3873 | * The common statement class for MDB2 statement objects |
---|
3874 | * |
---|
3875 | * @package MDB2 |
---|
3876 | * @category Database |
---|
3877 | * @author Lukas Smith <smith@pooteeweet.org> |
---|
3878 | */ |
---|
3879 | class MDB2_Statement_Common |
---|
3880 | { |
---|
3881 | // {{{ Variables (Properties) |
---|
3882 | |
---|
3883 | var $db; |
---|
3884 | var $statement; |
---|
3885 | var $query; |
---|
3886 | var $result_types; |
---|
3887 | var $types; |
---|
3888 | var $values = array(); |
---|
3889 | var $limit; |
---|
3890 | var $offset; |
---|
3891 | var $is_manip; |
---|
3892 | |
---|
3893 | // }}} |
---|
3894 | // {{{ constructor: function __construct(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null) |
---|
3895 | |
---|
3896 | /** |
---|
3897 | * Constructor |
---|
3898 | */ |
---|
3899 | function __construct(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null) |
---|
3900 | { |
---|
3901 | $this->db =& $db; |
---|
3902 | $this->statement =& $statement; |
---|
3903 | $this->positions = $positions; |
---|
3904 | $this->query = $query; |
---|
3905 | $this->types = (array)$types; |
---|
3906 | $this->result_types = (array)$result_types; |
---|
3907 | $this->limit = $limit; |
---|
3908 | $this->is_manip = $is_manip; |
---|
3909 | $this->offset = $offset; |
---|
3910 | } |
---|
3911 | |
---|
3912 | // }}} |
---|
3913 | // {{{ function MDB2_Statement_Common(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null) |
---|
3914 | |
---|
3915 | /** |
---|
3916 | * PHP 4 Constructor |
---|
3917 | */ |
---|
3918 | function MDB2_Statement_Common(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null) |
---|
3919 | { |
---|
3920 | $this->__construct($db, $statement, $positions, $query, $types, $result_types, $is_manip, $limit, $offset); |
---|
3921 | } |
---|
3922 | |
---|
3923 | // }}} |
---|
3924 | // {{{ function bindValue($parameter, &$value, $type = null) |
---|
3925 | |
---|
3926 | /** |
---|
3927 | * Set the value of a parameter of a prepared query. |
---|
3928 | * |
---|
3929 | * @param int the order number of the parameter in the query |
---|
3930 | * statement. The order number of the first parameter is 1. |
---|
3931 | * @param mixed value that is meant to be assigned to specified |
---|
3932 | * parameter. The type of the value depends on the $type argument. |
---|
3933 | * @param string specifies the type of the field |
---|
3934 | * |
---|
3935 | * @return mixed MDB2_OK on success, a MDB2 error on failure |
---|
3936 | * |
---|
3937 | * @access public |
---|
3938 | */ |
---|
3939 | function bindValue($parameter, $value, $type = null) |
---|
3940 | { |
---|
3941 | if (!is_numeric($parameter)) { |
---|
3942 | $parameter = preg_replace('/^:(.*)$/', '\\1', $parameter); |
---|
3943 | } |
---|
3944 | if (!in_array($parameter, $this->positions)) { |
---|
3945 | return $this->db->raiseError(MDB2_ERROR_NOT_FOUND, null, null, |
---|
3946 | 'Unable to bind to missing placeholder: '.$parameter, __FUNCTION__); |
---|
3947 | } |
---|
3948 | $this->values[$parameter] = $value; |
---|
3949 | if (!is_null($type)) { |
---|
3950 | $this->types[$parameter] = $type; |
---|
3951 | } |
---|
3952 | return MDB2_OK; |
---|
3953 | } |
---|
3954 | |
---|
3955 | // }}} |
---|
3956 | // {{{ function bindValueArray($values, $types = null) |
---|
3957 | |
---|
3958 | /** |
---|
3959 | * Set the values of multiple a parameter of a prepared query in bulk. |
---|
3960 | * |
---|
3961 | * @param array specifies all necessary information |
---|
3962 | * for bindValue() the array elements must use keys corresponding to |
---|
3963 | * the number of the position of the parameter. |
---|
3964 | * @param array specifies the types of the fields |
---|
3965 | * |
---|
3966 | * @return mixed MDB2_OK on success, a MDB2 error on failure |
---|
3967 | * |
---|
3968 | * @access public |
---|
3969 | * @see bindParam() |
---|
3970 | */ |
---|
3971 | function bindValueArray($values, $types = null) |
---|
3972 | { |
---|
3973 | $types = is_array($types) ? array_values($types) : array_fill(0, count($values), null); |
---|
3974 | $parameters = array_keys($values); |
---|
3975 | foreach ($parameters as $key => $parameter) { |
---|
3976 | $err = $this->bindValue($parameter, $values[$parameter], $types[$key]); |
---|
3977 | if (PEAR::isError($err)) { |
---|
3978 | return $err; |
---|
3979 | } |
---|
3980 | } |
---|
3981 | return MDB2_OK; |
---|
3982 | } |
---|
3983 | |
---|
3984 | // }}} |
---|
3985 | // {{{ function bindParam($parameter, &$value, $type = null) |
---|
3986 | |
---|
3987 | /** |
---|
3988 | * Bind a variable to a parameter of a prepared query. |
---|
3989 | * |
---|
3990 | * @param int the order number of the parameter in the query |
---|
3991 | * statement. The order number of the first parameter is 1. |
---|
3992 | * @param mixed variable that is meant to be bound to specified |
---|
3993 | * parameter. The type of the value depends on the $type argument. |
---|
3994 | * @param string specifies the type of the field |
---|
3995 | * |
---|
3996 | * @return mixed MDB2_OK on success, a MDB2 error on failure |
---|
3997 | * |
---|
3998 | * @access public |
---|
3999 | */ |
---|
4000 | function bindParam($parameter, &$value, $type = null) |
---|
4001 | { |
---|
4002 | if (!is_numeric($parameter)) { |
---|
4003 | $parameter = preg_replace('/^:(.*)$/', '\\1', $parameter); |
---|
4004 | } |
---|
4005 | if (!in_array($parameter, $this->positions)) { |
---|
4006 | return $this->db->raiseError(MDB2_ERROR_NOT_FOUND, null, null, |
---|
4007 | 'Unable to bind to missing placeholder: '.$parameter, __FUNCTION__); |
---|
4008 | } |
---|
4009 | $this->values[$parameter] =& $value; |
---|
4010 | if (!is_null($type)) { |
---|
4011 | $this->types[$parameter] = $type; |
---|
4012 | } |
---|
4013 | return MDB2_OK; |
---|
4014 | } |
---|
4015 | |
---|
4016 | // }}} |
---|
4017 | // {{{ function bindParamArray(&$values, $types = null) |
---|
4018 | |
---|
4019 | /** |
---|
4020 | * Bind the variables of multiple a parameter of a prepared query in bulk. |
---|
4021 | * |
---|
4022 | * @param array specifies all necessary information |
---|
4023 | * for bindParam() the array elements must use keys corresponding to |
---|
4024 | * the number of the position of the parameter. |
---|
4025 | * @param array specifies the types of the fields |
---|
4026 | * |
---|
4027 | * @return mixed MDB2_OK on success, a MDB2 error on failure |
---|
4028 | * |
---|
4029 | * @access public |
---|
4030 | * @see bindParam() |
---|
4031 | */ |
---|
4032 | function bindParamArray(&$values, $types = null) |
---|
4033 | { |
---|
4034 | $types = is_array($types) ? array_values($types) : array_fill(0, count($values), null); |
---|
4035 | $parameters = array_keys($values); |
---|
4036 | foreach ($parameters as $key => $parameter) { |
---|
4037 | $err = $this->bindParam($parameter, $values[$parameter], $types[$key]); |
---|
4038 | if (PEAR::isError($err)) { |
---|
4039 | return $err; |
---|
4040 | } |
---|
4041 | } |
---|
4042 | return MDB2_OK; |
---|
4043 | } |
---|
4044 | |
---|
4045 | // }}} |
---|
4046 | // {{{ function &execute($values = null, $result_class = true, $result_wrap_class = false) |
---|
4047 | |
---|
4048 | /** |
---|
4049 | * Execute a prepared query statement. |
---|
4050 | * |
---|
4051 | * @param array specifies all necessary information |
---|
4052 | * for bindParam() the array elements must use keys corresponding to |
---|
4053 | * the number of the position of the parameter. |
---|
4054 | * @param mixed specifies which result class to use |
---|
4055 | * @param mixed specifies which class to wrap results in |
---|
4056 | * |
---|
4057 | * @return mixed a result handle or MDB2_OK on success, a MDB2 error on failure |
---|
4058 | * |
---|
4059 | * @access public |
---|
4060 | */ |
---|
4061 | function &execute($values = null, $result_class = true, $result_wrap_class = false) |
---|
4062 | { |
---|
4063 | if (is_null($this->positions)) { |
---|
4064 | return $this->db->raiseError(MDB2_ERROR, null, null, |
---|
4065 | 'Prepared statement has already been freed', __FUNCTION__); |
---|
4066 | } |
---|
4067 | |
---|
4068 | $values = (array)$values; |
---|
4069 | if (!empty($values)) { |
---|
4070 | $err = $this->bindValueArray($values); |
---|
4071 | if (PEAR::isError($err)) { |
---|
4072 | return $this->db->raiseError(MDB2_ERROR, null, null, |
---|
4073 | 'Binding Values failed with message: ' . $err->getMessage(), __FUNCTION__); |
---|
4074 | } |
---|
4075 | } |
---|
4076 | $result =& $this->_execute($result_class, $result_wrap_class); |
---|
4077 | return $result; |
---|
4078 | } |
---|
4079 | |
---|
4080 | // }}} |
---|
4081 | // {{{ function &_execute($result_class = true, $result_wrap_class = false) |
---|
4082 | |
---|
4083 | /** |
---|
4084 | * Execute a prepared query statement helper method. |
---|
4085 | * |
---|
4086 | * @param mixed specifies which result class to use |
---|
4087 | * @param mixed specifies which class to wrap results in |
---|
4088 | * |
---|
4089 | * @return mixed MDB2_Result or integer on success, a MDB2 error on failure |
---|
4090 | * |
---|
4091 | * @access private |
---|
4092 | */ |
---|
4093 | function &_execute($result_class = true, $result_wrap_class = false) |
---|
4094 | { |
---|
4095 | $this->last_query = $this->query; |
---|
4096 | $query = ''; |
---|
4097 | $last_position = 0; |
---|
4098 | foreach ($this->positions as $current_position => $parameter) { |
---|
4099 | if (!array_key_exists($parameter, $this->values)) { |
---|
4100 | return $this->db->raiseError(MDB2_ERROR_NOT_FOUND, null, null, |
---|
4101 | 'Unable to bind to missing placeholder: '.$parameter, __FUNCTION__); |
---|
4102 | } |
---|
4103 | $value = $this->values[$parameter]; |
---|
4104 | $query.= substr($this->query, $last_position, $current_position - $last_position); |
---|
4105 | if (!isset($value)) { |
---|
4106 | $value_quoted = 'NULL'; |
---|
4107 | } else { |
---|
4108 | $type = !empty($this->types[$parameter]) ? $this->types[$parameter] : null; |
---|
4109 | $value_quoted = $this->db->quote($value, $type); |
---|
4110 | if (PEAR::isError($value_quoted)) { |
---|
4111 | return $value_quoted; |
---|
4112 | } |
---|
4113 | } |
---|
4114 | $query.= $value_quoted; |
---|
4115 | $last_position = $current_position + 1; |
---|
4116 | } |
---|
4117 | $query.= substr($this->query, $last_position); |
---|
4118 | |
---|
4119 | $this->db->offset = $this->offset; |
---|
4120 | $this->db->limit = $this->limit; |
---|
4121 | if ($this->is_manip) { |
---|
4122 | $result = $this->db->exec($query); |
---|
4123 | } else { |
---|
4124 | $result =& $this->db->query($query, $this->result_types, $result_class, $result_wrap_class); |
---|
4125 | } |
---|
4126 | return $result; |
---|
4127 | } |
---|
4128 | |
---|
4129 | // }}} |
---|
4130 | // {{{ function free() |
---|
4131 | |
---|
4132 | /** |
---|
4133 | * Release resources allocated for the specified prepared query. |
---|
4134 | * |
---|
4135 | * @return mixed MDB2_OK on success, a MDB2 error on failure |
---|
4136 | * |
---|
4137 | * @access public |
---|
4138 | */ |
---|
4139 | function free() |
---|
4140 | { |
---|
4141 | if (is_null($this->positions)) { |
---|
4142 | return $this->db->raiseError(MDB2_ERROR, null, null, |
---|
4143 | 'Prepared statement has already been freed', __FUNCTION__); |
---|
4144 | } |
---|
4145 | |
---|
4146 | $this->statement = null; |
---|
4147 | $this->positions = null; |
---|
4148 | $this->query = null; |
---|
4149 | $this->types = null; |
---|
4150 | $this->result_types = null; |
---|
4151 | $this->limit = null; |
---|
4152 | $this->is_manip = null; |
---|
4153 | $this->offset = null; |
---|
4154 | $this->values = null; |
---|
4155 | |
---|
4156 | return MDB2_OK; |
---|
4157 | } |
---|
4158 | |
---|
4159 | // }}} |
---|
4160 | } |
---|
4161 | |
---|
4162 | // }}} |
---|
4163 | // {{{ class MDB2_Module_Common |
---|
4164 | |
---|
4165 | /** |
---|
4166 | * The common modules class for MDB2 module objects |
---|
4167 | * |
---|
4168 | * @package MDB2 |
---|
4169 | * @category Database |
---|
4170 | * @author Lukas Smith <smith@pooteeweet.org> |
---|
4171 | */ |
---|
4172 | class MDB2_Module_Common |
---|
4173 | { |
---|
4174 | // {{{ Variables (Properties) |
---|
4175 | |
---|
4176 | /** |
---|
4177 | * contains the key to the global MDB2 instance array of the associated |
---|
4178 | * MDB2 instance |
---|
4179 | * |
---|
4180 | * @var int |
---|
4181 | * @access protected |
---|
4182 | */ |
---|
4183 | var $db_index; |
---|
4184 | |
---|
4185 | // }}} |
---|
4186 | // {{{ constructor: function __construct($db_index) |
---|
4187 | |
---|
4188 | /** |
---|
4189 | * Constructor |
---|
4190 | */ |
---|
4191 | function __construct($db_index) |
---|
4192 | { |
---|
4193 | $this->db_index = $db_index; |
---|
4194 | } |
---|
4195 | |
---|
4196 | // }}} |
---|
4197 | // {{{ function MDB2_Module_Common($db_index) |
---|
4198 | |
---|
4199 | /** |
---|
4200 | * PHP 4 Constructor |
---|
4201 | */ |
---|
4202 | function MDB2_Module_Common($db_index) |
---|
4203 | { |
---|
4204 | $this->__construct($db_index); |
---|
4205 | } |
---|
4206 | |
---|
4207 | // }}} |
---|
4208 | // {{{ function &getDBInstance() |
---|
4209 | |
---|
4210 | /** |
---|
4211 | * Get the instance of MDB2 associated with the module instance |
---|
4212 | * |
---|
4213 | * @return object MDB2 instance or a MDB2 error on failure |
---|
4214 | * |
---|
4215 | * @access public |
---|
4216 | */ |
---|
4217 | function &getDBInstance() |
---|
4218 | { |
---|
4219 | if (isset($GLOBALS['_MDB2_databases'][$this->db_index])) { |
---|
4220 | $result =& $GLOBALS['_MDB2_databases'][$this->db_index]; |
---|
4221 | } else { |
---|
4222 | $result =& MDB2::raiseError(MDB2_ERROR_NOT_FOUND, null, null, |
---|
4223 | 'could not find MDB2 instance'); |
---|
4224 | } |
---|
4225 | return $result; |
---|
4226 | } |
---|
4227 | |
---|
4228 | // }}} |
---|
4229 | } |
---|
4230 | |
---|
4231 | // }}} |
---|
4232 | // {{{ function MDB2_closeOpenTransactions() |
---|
4233 | |
---|
4234 | /** |
---|
4235 | * Close any open transactions form persistent connections |
---|
4236 | * |
---|
4237 | * @return void |
---|
4238 | * |
---|
4239 | * @access public |
---|
4240 | */ |
---|
4241 | |
---|
4242 | function MDB2_closeOpenTransactions() |
---|
4243 | { |
---|
4244 | reset($GLOBALS['_MDB2_databases']); |
---|
4245 | while (next($GLOBALS['_MDB2_databases'])) { |
---|
4246 | $key = key($GLOBALS['_MDB2_databases']); |
---|
4247 | if ($GLOBALS['_MDB2_databases'][$key]->opened_persistent |
---|
4248 | && $GLOBALS['_MDB2_databases'][$key]->in_transaction |
---|
4249 | ) { |
---|
4250 | $GLOBALS['_MDB2_databases'][$key]->rollback(); |
---|
4251 | } |
---|
4252 | } |
---|
4253 | } |
---|
4254 | |
---|
4255 | // }}} |
---|
4256 | // {{{ function MDB2_defaultDebugOutput(&$db, $scope, $message, $is_manip = null) |
---|
4257 | |
---|
4258 | /** |
---|
4259 | * default debug output handler |
---|
4260 | * |
---|
4261 | * @param object reference to an MDB2 database object |
---|
4262 | * @param string usually the method name that triggered the debug call: |
---|
4263 | * for example 'query', 'prepare', 'execute', 'parameters', |
---|
4264 | * 'beginTransaction', 'commit', 'rollback' |
---|
4265 | * @param string message that should be appended to the debug variable |
---|
4266 | * @param array contains context information about the debug() call |
---|
4267 | * common keys are: is_manip, time, result etc. |
---|
4268 | * |
---|
4269 | * @return void|string optionally return a modified message, this allows |
---|
4270 | * rewriting a query before being issued or prepared |
---|
4271 | * |
---|
4272 | * @access public |
---|
4273 | */ |
---|
4274 | function MDB2_defaultDebugOutput(&$db, $scope, $message, $context = array()) |
---|
4275 | { |
---|
4276 | $db->debug_output.= $scope.'('.$db->db_index.'): '; |
---|
4277 | $db->debug_output.= $message.$db->getOption('log_line_break'); |
---|
4278 | return $message; |
---|
4279 | } |
---|
4280 | |
---|
4281 | // }}} |
---|
4282 | ?> |
---|