· 10 years ago · Mar 22, 2016, 05:24 PM
1<?php
2/**
3 * Object Based Database Query Builder and data store
4 *
5 * For PHP versions 4,5 and 6
6 *
7 * LICENSE: This source file is subject to version 3.01 of the PHP license
8 * that is available through the world-wide-web at the following URI:
9 * http://www.php.net/license/3_01.txt. If you did not receive a copy of
10 * the PHP License and are unable to obtain it through the web, please
11 * send a note to license@php.net so we can mail you a copy immediately.
12 *
13 * @category Database
14 * @package DB_DataObject
15 * @author Alan Knowles <alan@akbkhome.com>
16 * @copyright 1997-2006 The PHP Group
17 * @license http://www.php.net/license/3_01.txt PHP License 3.01
18 * @version CVS: $Id: DataObject.php 320069 2011-11-28 04:34:08Z alan_k $
19 * @link http://pear.php.net/package/DB_DataObject
20 *
21 * Patched for php5 compatability 2016-03-22
22 * by Maiyannah Bishop <maiyannah@member.fsf.org>
23 */
24
25
26/* ===========================================================================
27 *
28 * !!!!!!!!!!!!! W A R N I N G !!!!!!!!!!!
29 *
30 * THIS MAY SEGFAULT PHP IF YOU ARE USING THE ZEND OPTIMIZER (to fix it,
31 * just add "define('DB_DATAOBJECT_NO_OVERLOAD',true);" before you include
32 * this file. reducing the optimization level may also solve the segfault.
33 * ===========================================================================
34 */
35
36/**
37 * The main "DB_DataObject" class is really a base class for your own tables classes
38 *
39 * // Set up the class by creating an ini file (refer to the manual for more details
40 * [DB_DataObject]
41 * database = mysql:/username:password@host/database
42 * schema_location = /home/myapplication/database
43 * class_location = /home/myapplication/DBTables/
44 * clase_prefix = DBTables_
45 *
46 *
47 * //Start and initialize...................... - dont forget the &
48 * $config = parse_ini_file('example.ini',true);
49 * $options = &PEAR::getStaticProperty('DB_DataObject','options');
50 * $options = $config['DB_DataObject'];
51 *
52 * // example of a class (that does not use the 'auto generated tables data')
53 * class mytable extends DB_DataObject {
54 * // mandatory - set the table
55 * var $_database_dsn = "mysql://username:password@localhost/database";
56 * var $__table = "mytable";
57 * function table() {
58 * return array(
59 * 'id' => 1, // integer or number
60 * 'name' => 2, // string
61 * );
62 * }
63 * function keys() {
64 * return array('id');
65 * }
66 * }
67 *
68 * // use in the application
69 *
70 *
71 * Simple get one row
72 *
73 * $instance = new mytable;
74 * $instance->get("id",12);
75 * echo $instance->somedata;
76 *
77 *
78 * Get multiple rows
79 *
80 * $instance = new mytable;
81 * $instance->whereAdd("ID > 12");
82 * $instance->whereAdd("ID < 14");
83 * $instance->find();
84 * while ($instance->fetch()) {
85 * echo $instance->somedata;
86 * }
87
88
89/**
90 * Needed classes
91 * - we use getStaticProperty from PEAR pretty extensively (cant remove it ATM)
92 */
93
94require_once 'PEAR.php';
95
96/**
97 * We are duping fetchmode constants to be compatible with
98 * both DB and MDB2
99 */
100define('DB_DATAOBJECT_FETCHMODE_ORDERED',1);
101define('DB_DATAOBJECT_FETCHMODE_ASSOC',2);
102
103
104
105
106
107/**
108 * these are constants for the get_table array
109 * user to determine what type of escaping is required around the object vars.
110 */
111define('DB_DATAOBJECT_INT', 1); // does not require ''
112define('DB_DATAOBJECT_STR', 2); // requires ''
113
114define('DB_DATAOBJECT_DATE', 4); // is date #TODO
115define('DB_DATAOBJECT_TIME', 8); // is time #TODO
116define('DB_DATAOBJECT_BOOL', 16); // is boolean #TODO
117define('DB_DATAOBJECT_TXT', 32); // is long text #TODO
118define('DB_DATAOBJECT_BLOB', 64); // is blob type
119
120
121define('DB_DATAOBJECT_NOTNULL', 128); // not null col.
122define('DB_DATAOBJECT_MYSQLTIMESTAMP' , 256); // mysql timestamps (ignored by update/insert)
123/*
124 * Define this before you include DataObjects.php to disable overload - if it segfaults due to Zend optimizer..
125 */
126//define('DB_DATAOBJECT_NO_OVERLOAD',true)
127
128
129/**
130 * Theses are the standard error codes, most methods will fail silently - and return false
131 * to access the error message either use $table->_lastError
132 * or $last_error = PEAR::getStaticProperty('DB_DataObject','lastError');
133 * the code is $last_error->code, and the message is $last_error->message (a standard PEAR error)
134 */
135
136define('DB_DATAOBJECT_ERROR_INVALIDARGS', -1); // wrong args to function
137define('DB_DATAOBJECT_ERROR_NODATA', -2); // no data available
138define('DB_DATAOBJECT_ERROR_INVALIDCONFIG', -3); // something wrong with the config
139define('DB_DATAOBJECT_ERROR_NOCLASS', -4); // no class exists
140define('DB_DATAOBJECT_ERROR_INVALID_CALL' ,-7); // overlad getter/setter failure
141
142/**
143 * Used in methods like delete() and count() to specify that the method should
144 * build the condition only out of the whereAdd's and not the object parameters.
145 */
146define('DB_DATAOBJECT_WHEREADD_ONLY', true);
147
148/**
149 *
150 * storage for connection and result objects,
151 * it is done this way so that print_r()'ing the is smaller, and
152 * it reduces the memory size of the object.
153 * -- future versions may use $this->_connection = & PEAR object..
154 * although will need speed tests to see how this affects it.
155 * - includes sub arrays
156 * - connections = md5 sum mapp to pear db object
157 * - results = [id] => map to pear db object
158 * - resultseq = sequence id for results & results field
159 * - resultfields = [id] => list of fields return from query (for use with toArray())
160 * - ini = mapping of database to ini file results
161 * - links = mapping of database to links file
162 * - lasterror = pear error objects for last error event.
163 * - config = aliased view of PEAR::getStaticPropery('DB_DataObject','options') * done for performance.
164 * - array of loaded classes by autoload method - to stop it doing file access request over and over again!
165 */
166$GLOBALS['_DB_DATAOBJECT']['RESULTS'] = array();
167$GLOBALS['_DB_DATAOBJECT']['RESULTSEQ'] = 1;
168$GLOBALS['_DB_DATAOBJECT']['RESULTFIELDS'] = array();
169$GLOBALS['_DB_DATAOBJECT']['CONNECTIONS'] = array();
170$GLOBALS['_DB_DATAOBJECT']['INI'] = array();
171$GLOBALS['_DB_DATAOBJECT']['LINKS'] = array();
172$GLOBALS['_DB_DATAOBJECT']['SEQUENCE'] = array();
173$GLOBALS['_DB_DATAOBJECT']['LASTERROR'] = null;
174$GLOBALS['_DB_DATAOBJECT']['CONFIG'] = array();
175$GLOBALS['_DB_DATAOBJECT']['CACHE'] = array();
176$GLOBALS['_DB_DATAOBJECT']['OVERLOADED'] = false;
177$GLOBALS['_DB_DATAOBJECT']['QUERYENDTIME'] = 0;
178
179
180
181// this will be horrifically slow!!!!
182// these two are BC/FC handlers for call in PHP4/5
183
184
185if (!defined('DB_DATAOBJECT_NO_OVERLOAD')) {
186
187 class DB_DataObject_Overload
188 {
189 function __call($method,$args)
190 {
191 $return = null;
192 $this->_call($method,$args,$return);
193 return $return;
194 }
195 function __sleep()
196 {
197 return array_keys(get_object_vars($this)) ;
198 }
199 }
200} else {
201 class DB_DataObject_Overload {}
202}
203
204
205
206
207
208
209
210 /*
211 *
212 * @package DB_DataObject
213 * @author Alan Knowles <alan@akbkhome.com>
214 * @since PHP 4.0
215 */
216
217class DB_DataObject extends DB_DataObject_Overload
218{
219 /**
220 * The Version - use this to check feature changes
221 *
222 * @access private
223 * @var string
224 */
225 var $_DB_DataObject_version = "1.11.3";
226
227 /**
228 * The Database table (used by table extends)
229 *
230 * @access private
231 * @var string
232 */
233 var $__table = ''; // database table
234
235 /**
236 * The Number of rows returned from a query
237 *
238 * @access public
239 * @var int
240 */
241 var $N = 0; // Number of rows returned from a query
242
243 /* ============================================================= */
244 /* Major Public Methods */
245 /* (designed to be optionally then called with parent::method()) */
246 /* ============================================================= */
247
248
249 /**
250 * Get a result using key, value.
251 *
252 * for example
253 * $object->get("ID",1234);
254 * Returns Number of rows located (usually 1) for success,
255 * and puts all the table columns into this classes variables
256 *
257 * see the fetch example on how to extend this.
258 *
259 * if no value is entered, it is assumed that $key is a value
260 * and get will then use the first key in keys()
261 * to obtain the key.
262 *
263 * @param string $k column
264 * @param string $v value
265 * @access public
266 * @return int No. of rows
267 */
268 function get($k = null, $v = null)
269 {
270 global $_DB_DATAOBJECT;
271 if (empty($_DB_DATAOBJECT['CONFIG'])) {
272 DB_DataObject::_loadConfig();
273 }
274 $keys = array();
275
276 if ($v === null) {
277 $v = $k;
278 $keys = $this->keys();
279 if (!$keys) {
280 $this->raiseError("No Keys available for {$this->tableName()}", DB_DATAOBJECT_ERROR_INVALIDCONFIG);
281 return false;
282 }
283 $k = $keys[0];
284 }
285 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
286 $this->debug("$k $v " .print_r($keys,true), "GET");
287 }
288
289 if ($v === null) {
290 $this->raiseError("No Value specified for get", DB_DATAOBJECT_ERROR_INVALIDARGS);
291 return false;
292 }
293 $this->$k = $v;
294 return $this->find(1);
295 }
296
297 /**
298 * Get the value of the primary id
299 *
300 * While I normally use 'id' as the PRIMARY KEY value, some database use
301 * {table}_id as the column name.
302 *
303 * To save a bit of typing,
304 *
305 * $id = $do->pid();
306 *
307 * @return the id
308 */
309 function pid()
310 {
311 $keys = $this->keys();
312 if (!$keys) {
313 $this->raiseError("No Keys available for {$this->tableName()}",
314 DB_DATAOBJECT_ERROR_INVALIDCONFIG);
315 return false;
316 }
317 $k = $keys[0];
318 if (empty($this->$k)) { // we do not
319 $this->raiseError("pid() called on Object where primary key value not available",
320 DB_DATAOBJECT_ERROR_NODATA);
321 return false;
322 }
323 return $this->$k;
324 }
325
326
327
328 /**
329 * build the basic select query.
330 *
331 * @access private
332 */
333
334 function _build_select()
335 {
336 global $_DB_DATAOBJECT;
337 $quoteIdentifiers = !empty($_DB_DATAOBJECT['CONFIG']['quote_identifiers']);
338 if ($quoteIdentifiers) {
339 $this->_connect();
340 $DB = $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
341 }
342 $tn = ($quoteIdentifiers ? $DB->quoteIdentifier($this->tableName()) : $this->tableName()) ;
343 if (!empty($this->_query['derive_table']) && !empty($this->_query['derive_select']) ) {
344
345 // this is a derived select..
346 // not much support in the api yet..
347
348 $sql = 'SELECT ' .
349 $this->_query['derive_select']
350 .' FROM ( SELECT'.
351 $this->_query['data_select'] . " \n" .
352 " FROM $tn " . $this->_query['useindex'] . " \n" .
353 $this->_join . " \n" .
354 $this->_query['condition'] . " \n" .
355 $this->_query['group_by'] . " \n" .
356 $this->_query['having'] . " \n" .
357 ') ' . $this->_query['derive_table'];
358
359 return $sql;
360
361
362 }
363
364
365
366 $sql = 'SELECT ' .
367 $this->_query['data_select'] . " \n" .
368 " FROM $tn " . $this->_query['useindex'] . " \n" .
369 $this->_join . " \n" .
370 $this->_query['condition'] . " \n" .
371 $this->_query['group_by'] . " \n" .
372 $this->_query['having'] . " \n";
373
374 return $sql;
375 }
376
377
378 /**
379 * find results, either normal or crosstable
380 *
381 * for example
382 *
383 * $object = new mytable();
384 * $object->ID = 1;
385 * $object->find();
386 *
387 *
388 * will set $object->N to number of rows, and expects next command to fetch rows
389 * will return $object->N
390 *
391 * if an error occurs $object->N will be set to false and return value will also be false;
392 * if numRows is not supported it will
393 *
394 *
395 * @param boolean $n Fetch first result
396 * @access public
397 * @return mixed (number of rows returned, or true if numRows fetching is not supported)
398 */
399 function find($n = false)
400 {
401 global $_DB_DATAOBJECT;
402 if ($this->_query === false) {
403 $this->raiseError(
404 "You cannot do two queries on the same object (copy it before finding)",
405 DB_DATAOBJECT_ERROR_INVALIDARGS);
406 return false;
407 }
408
409 if (empty($_DB_DATAOBJECT['CONFIG'])) {
410 DB_DataObject::_loadConfig();
411 }
412
413 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
414 $this->debug($n, "find",1);
415 }
416 if (!$this->__table) {
417 // xdebug can backtrace this!
418 trigger_error("NO \$__table SPECIFIED in class definition",E_USER_ERROR);
419 }
420 $this->N = 0;
421 $query_before = $this->_query;
422 $this->_build_condition($this->table()) ;
423
424
425 $this->_connect();
426 $DB = $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
427
428
429 $sql = $this->_build_select();
430
431 foreach ($this->_query['unions'] as $union_ar) {
432 $sql .= $union_ar[1] . $union_ar[0]->_build_select() . " \n";
433 }
434
435 $sql .= $this->_query['order_by'] . " \n";
436
437
438 /* We are checking for method modifyLimitQuery as it is PEAR DB specific */
439 if ((!isset($_DB_DATAOBJECT['CONFIG']['db_driver'])) ||
440 ($_DB_DATAOBJECT['CONFIG']['db_driver'] == 'DB')) {
441 /* PEAR DB specific */
442
443 if (isset($this->_query['limit_start']) && strlen($this->_query['limit_start'] . $this->_query['limit_count'])) {
444 $sql = $DB->modifyLimitQuery($sql,$this->_query['limit_start'], $this->_query['limit_count']);
445 }
446 } else {
447 /* theoretically MDB2! */
448 if (isset($this->_query['limit_start']) && strlen($this->_query['limit_start'] . $this->_query['limit_count'])) {
449 $DB->setLimit($this->_query['limit_count'],$this->_query['limit_start']);
450 }
451 }
452
453
454 $err = $this->_query($sql);
455 if (is_a($err,'PEAR_Error')) {
456 return false;
457 }
458
459 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
460 $this->debug("CHECK autofetchd $n", "find", 1);
461 }
462
463 // find(true)
464
465 $ret = $this->N;
466 if (!$ret && !empty($_DB_DATAOBJECT['RESULTS'][$this->_DB_resultid])) {
467 // clear up memory if nothing found!?
468 unset($_DB_DATAOBJECT['RESULTS'][$this->_DB_resultid]);
469 }
470
471 if ($n && $this->N > 0 ) {
472 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
473 $this->debug("ABOUT TO AUTOFETCH", "find", 1);
474 }
475 $fs = $this->fetch();
476 // if fetch returns false (eg. failed), then the backend doesnt support numRows (eg. ret=true)
477 // - hence find() also returns false..
478 $ret = ($ret === true) ? $fs : $ret;
479 }
480 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
481 $this->debug("DONE", "find", 1);
482 }
483 $this->_query = $query_before;
484 return $ret;
485 }
486
487 /**
488 * fetches next row into this objects var's
489 *
490 * returns 1 on success 0 on failure
491 *
492 *
493 *
494 * Example
495 * $object = new mytable();
496 * $object->name = "fred";
497 * $object->find();
498 * $store = array();
499 * while ($object->fetch()) {
500 * echo $this->ID;
501 * $store[] = $object; // builds an array of object lines.
502 * }
503 *
504 * to add features to a fetch
505 * function fetch () {
506 * $ret = parent::fetch();
507 * $this->date_formated = date('dmY',$this->date);
508 * return $ret;
509 * }
510 *
511 * @access public
512 * @return boolean on success
513 */
514 function fetch()
515 {
516
517 global $_DB_DATAOBJECT;
518 if (empty($_DB_DATAOBJECT['CONFIG'])) {
519 DB_DataObject::_loadConfig();
520 }
521 if (empty($this->N)) {
522 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
523 $this->debug("No data returned from FIND (eg. N is 0)","FETCH", 3);
524 }
525 return false;
526 }
527
528 if (empty($_DB_DATAOBJECT['RESULTS'][$this->_DB_resultid]) ||
529 !is_object($result = $_DB_DATAOBJECT['RESULTS'][$this->_DB_resultid]))
530 {
531 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
532 $this->debug('fetched on object after fetch completed (no results found)');
533 }
534 return false;
535 }
536
537
538 $array = $result->fetchRow(DB_DATAOBJECT_FETCHMODE_ASSOC);
539 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
540 $this->debug(serialize($array),"FETCH");
541 }
542
543 // fetched after last row..
544 if ($array === null) {
545 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
546 $t= explode(' ',microtime());
547
548 $this->debug("Last Data Fetch'ed after " .
549 ($t[0]+$t[1]- $_DB_DATAOBJECT['QUERYENDTIME'] ) .
550 " seconds",
551 "FETCH", 1);
552 }
553 // reduce the memory usage a bit... (but leave the id in, so count() works ok on it)
554 unset($_DB_DATAOBJECT['RESULTS'][$this->_DB_resultid]);
555
556 // we need to keep a copy of resultfields locally so toArray() still works
557 // however we dont want to keep it in the global cache..
558
559 if (!empty($_DB_DATAOBJECT['RESULTFIELDS'][$this->_DB_resultid])) {
560 $this->_resultFields = $_DB_DATAOBJECT['RESULTFIELDS'][$this->_DB_resultid];
561 unset($_DB_DATAOBJECT['RESULTFIELDS'][$this->_DB_resultid]);
562 }
563 // this is probably end of data!!
564 //DB_DataObject::raiseError("fetch: no data returned", DB_DATAOBJECT_ERROR_NODATA);
565 return false;
566 }
567 // make sure resultFields is always empty..
568 $this->_resultFields = false;
569
570 if (!isset($_DB_DATAOBJECT['RESULTFIELDS'][$this->_DB_resultid])) {
571 // note: we dont declare this to keep the print_r size down.
572 $_DB_DATAOBJECT['RESULTFIELDS'][$this->_DB_resultid]= array_flip(array_keys($array));
573 }
574 $replace = array('.', ' ');
575 foreach($array as $k=>$v) {
576 // use strpos as str_replace is slow.
577 $kk = (strpos($k, '.') === false && strpos($k, ' ') === false) ?
578 $k : str_replace($replace, '_', $k);
579
580 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
581 $this->debug("$kk = ". $array[$k], "fetchrow LINE", 3);
582 }
583 $this->$kk = $array[$k];
584 }
585
586 // set link flag
587 $this->_link_loaded=false;
588 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
589 $this->debug("{$this->tableName()} DONE", "fetchrow",2);
590 }
591 if (($this->_query !== false) && empty($_DB_DATAOBJECT['CONFIG']['keep_query_after_fetch'])) {
592 $this->_query = false;
593 }
594 return true;
595 }
596
597
598 /**
599 * fetches all results as an array,
600 *
601 * return format is dependant on args.
602 * if selectAdd() has not been called on the object, then it will add the correct columns to the query.
603 *
604 * A) Array of values (eg. a list of 'id')
605 *
606 * $x = DB_DataObject::factory('mytable');
607 * $x->whereAdd('something = 1')
608 * $ar = $x->fetchAll('id');
609 * -- returns array(1,2,3,4,5)
610 *
611 * B) Array of values (not from table)
612 *
613 * $x = DB_DataObject::factory('mytable');
614 * $x->whereAdd('something = 1');
615 * $x->selectAdd();
616 * $x->selectAdd('distinct(group_id) as group_id');
617 * $ar = $x->fetchAll('group_id');
618 * -- returns array(1,2,3,4,5)
619 * *
620 * C) A key=>value associative array
621 *
622 * $x = DB_DataObject::factory('mytable');
623 * $x->whereAdd('something = 1')
624 * $ar = $x->fetchAll('id','name');
625 * -- returns array(1=>'fred',2=>'blogs',3=> .......
626 *
627 * D) array of objects
628 * $x = DB_DataObject::factory('mytable');
629 * $x->whereAdd('something = 1');
630 * $ar = $x->fetchAll();
631 *
632 * E) array of arrays (for example)
633 * $x = DB_DataObject::factory('mytable');
634 * $x->whereAdd('something = 1');
635 * $ar = $x->fetchAll(false,false,'toArray');
636 *
637 *
638 * @param string|false $k key
639 * @param string|false $v value
640 * @param string|false $method method to call on each result to get array value (eg. 'toArray')
641 * @access public
642 * @return array format dependant on arguments, may be empty
643 */
644 function fetchAll($k= false, $v = false, $method = false)
645 {
646 // should it even do this!!!?!?
647 if ($k !== false &&
648 ( // only do this is we have not been explicit..
649 empty($this->_query['data_select']) ||
650 ($this->_query['data_select'] == '*')
651 )
652 ) {
653 $this->selectAdd();
654 $this->selectAdd($k);
655 if ($v !== false) {
656 $this->selectAdd($v);
657 }
658 }
659
660 $this->find();
661 $ret = array();
662 while ($this->fetch()) {
663 if ($v !== false) {
664 $ret[$this->$k] = $this->$v;
665 continue;
666 }
667 $ret[] = $k === false ?
668 ($method == false ? clone($this) : $this->$method())
669 : $this->$k;
670 }
671 return $ret;
672
673 }
674
675
676 /**
677 * Adds a condition to the WHERE statement, defaults to AND
678 *
679 * $object->whereAdd(); //reset or cleaer ewhwer
680 * $object->whereAdd("ID > 20");
681 * $object->whereAdd("age > 20","OR");
682 *
683 * @param string $cond condition
684 * @param string $logic optional logic "OR" (defaults to "AND")
685 * @access public
686 * @return string|PEAR::Error - previous condition or Error when invalid args found
687 */
688 function whereAdd($cond = false, $logic = 'AND')
689 {
690 // for PHP5.2.3 - there is a bug with setting array properties of an object.
691 $_query = $this->_query;
692
693 if (!isset($this->_query) || ($_query === false)) {
694 return $this->raiseError(
695 "You cannot do two queries on the same object (clone it before finding)",
696 DB_DATAOBJECT_ERROR_INVALIDARGS);
697 }
698
699 if ($cond === false) {
700 $r = $this->_query['condition'];
701 $_query['condition'] = '';
702 $this->_query = $_query;
703 return preg_replace('/^\s+WHERE\s+/','',$r);
704 }
705 // check input...= 0 or ' ' == error!
706 if (!trim($cond)) {
707 return $this->raiseError("WhereAdd: No Valid Arguments", DB_DATAOBJECT_ERROR_INVALIDARGS);
708 }
709 $r = $_query['condition'];
710 if ($_query['condition']) {
711 $_query['condition'] .= " {$logic} ( {$cond} )";
712 $this->_query = $_query;
713 return $r;
714 }
715 $_query['condition'] = " WHERE ( {$cond} ) ";
716 $this->_query = $_query;
717 return $r;
718 }
719
720 /**
721 * Adds a 'IN' condition to the WHERE statement
722 *
723 * $object->whereAddIn('id', $array, 'int'); //minimal usage
724 * $object->whereAddIn('price', $array, 'float', 'OR'); // cast to float, and call whereAdd with 'OR'
725 * $object->whereAddIn('name', $array, 'string'); // quote strings
726 *
727 * @param string $key key column to match
728 * @param array $list list of values to match
729 * @param string $type string|int|integer|float|bool cast to type.
730 * @param string $logic optional logic to call whereAdd with eg. "OR" (defaults to "AND")
731 * @access public
732 * @return string|PEAR::Error - previous condition or Error when invalid args found
733 */
734 function whereAddIn($key, $list, $type, $logic = 'AND')
735 {
736 $not = '';
737 if ($key[0] == '!') {
738 $not = 'NOT ';
739 $key = substr($key, 1);
740 }
741 // fix type for short entry.
742 $type = $type == 'int' ? 'integer' : $type;
743
744 if ($type == 'string') {
745 $this->_connect();
746 }
747
748 $ar = array();
749 foreach($list as $k) {
750 settype($k, $type);
751 $ar[] = $type == 'string' ? $this->_quote($k) : $k;
752 }
753
754 if (!$ar) {
755 return $not ? $this->_query['condition'] : $this->whereAdd("1=0");
756 }
757 return $this->whereAdd("$key $not IN (". implode(',', $ar). ')', $logic );
758 }
759
760
761
762 /**
763 * Adds a order by condition
764 *
765 * $object->orderBy(); //clears order by
766 * $object->orderBy("ID");
767 * $object->orderBy("ID,age");
768 *
769 * @param string $order Order
770 * @access public
771 * @return none|PEAR::Error - invalid args only
772 */
773 function orderBy($order = false)
774 {
775 if ($this->_query === false) {
776 $this->raiseError(
777 "You cannot do two queries on the same object (copy it before finding)",
778 DB_DATAOBJECT_ERROR_INVALIDARGS);
779 return false;
780 }
781 if ($order === false) {
782 $this->_query['order_by'] = '';
783 return;
784 }
785 // check input...= 0 or ' ' == error!
786 if (!trim($order)) {
787 return $this->raiseError("orderBy: No Valid Arguments", DB_DATAOBJECT_ERROR_INVALIDARGS);
788 }
789
790 if (!$this->_query['order_by']) {
791 $this->_query['order_by'] = " ORDER BY {$order} ";
792 return;
793 }
794 $this->_query['order_by'] .= " , {$order}";
795 }
796
797 /**
798 * Adds a group by condition
799 *
800 * $object->groupBy(); //reset the grouping
801 * $object->groupBy("ID DESC");
802 * $object->groupBy("ID,age");
803 *
804 * @param string $group Grouping
805 * @access public
806 * @return none|PEAR::Error - invalid args only
807 */
808 function groupBy($group = false)
809 {
810 if ($this->_query === false) {
811 $this->raiseError(
812 "You cannot do two queries on the same object (copy it before finding)",
813 DB_DATAOBJECT_ERROR_INVALIDARGS);
814 return false;
815 }
816 if ($group === false) {
817 $this->_query['group_by'] = '';
818 return;
819 }
820 // check input...= 0 or ' ' == error!
821 if (!trim($group)) {
822 return $this->raiseError("groupBy: No Valid Arguments", DB_DATAOBJECT_ERROR_INVALIDARGS);
823 }
824
825
826 if (!$this->_query['group_by']) {
827 $this->_query['group_by'] = " GROUP BY {$group} ";
828 return;
829 }
830 $this->_query['group_by'] .= " , {$group}";
831 }
832
833 /**
834 * Adds a having clause
835 *
836 * $object->having(); //reset the grouping
837 * $object->having("sum(value) > 0 ");
838 *
839 * @param string $having condition
840 * @access public
841 * @return none|PEAR::Error - invalid args only
842 */
843 function having($having = false)
844 {
845 if ($this->_query === false) {
846 $this->raiseError(
847 "You cannot do two queries on the same object (copy it before finding)",
848 DB_DATAOBJECT_ERROR_INVALIDARGS);
849 return false;
850 }
851 if ($having === false) {
852 $this->_query['having'] = '';
853 return;
854 }
855 // check input...= 0 or ' ' == error!
856 if (!trim($having)) {
857 return $this->raiseError("Having: No Valid Arguments", DB_DATAOBJECT_ERROR_INVALIDARGS);
858 }
859
860
861 if (!$this->_query['having']) {
862 $this->_query['having'] = " HAVING {$having} ";
863 return;
864 }
865 $this->_query['having'] .= " AND {$having}";
866 }
867
868 /**
869 * Adds a using Index
870 *
871 * $object->useIndex(); //reset the use Index
872 * $object->useIndex("some_index");
873 *
874 * Note do not put unfiltered user input into theis method.
875 * This is mysql specific at present? - might need altering to support other databases.
876 *
877 * @param string|array $index index or indexes to use.
878 * @access public
879 * @return none|PEAR::Error - invalid args only
880 */
881 function useIndex($index = false)
882 {
883 if ($this->_query === false) {
884 $this->raiseError(
885 "You cannot do two queries on the same object (copy it before finding)",
886 DB_DATAOBJECT_ERROR_INVALIDARGS);
887 return false;
888 }
889 if ($index=== false) {
890 $this->_query['useindex'] = '';
891 return;
892 }
893 // check input...= 0 or ' ' == error!
894 if ((is_string($index) && !trim($index)) || (is_array($index) && !count($index)) ) {
895 return $this->raiseError("Having: No Valid Arguments", DB_DATAOBJECT_ERROR_INVALIDARGS);
896 }
897 $index = is_array($index) ? implode(', ', $index) : $index;
898
899 if (!$this->_query['useindex']) {
900 $this->_query['useindex'] = " USE INDEX ({$index}) ";
901 return;
902 }
903 $this->_query['useindex'] = substr($this->_query['useindex'],0, -2) . ", {$index}) ";
904 }
905 /**
906 * Sets the Limit
907 *
908 * $boject->limit(); // clear limit
909 * $object->limit(12);
910 * $object->limit(12,10);
911 *
912 * Note this will emit an error on databases other than mysql/postgress
913 * as there is no 'clean way' to implement it. - you should consider refering to
914 * your database manual to decide how you want to implement it.
915 *
916 * @param string $a limit start (or number), or blank to reset
917 * @param string $b number
918 * @access public
919 * @return none|PEAR::Error - invalid args only
920 */
921 function limit($a = null, $b = null)
922 {
923 if ($this->_query === false) {
924 $this->raiseError(
925 "You cannot do two queries on the same object (copy it before finding)",
926 DB_DATAOBJECT_ERROR_INVALIDARGS);
927 return false;
928 }
929
930 if ($a === null) {
931 $this->_query['limit_start'] = '';
932 $this->_query['limit_count'] = '';
933 return;
934 }
935 // check input...= 0 or ' ' == error!
936 if ((!is_int($a) && ((string)((int)$a) !== (string)$a))
937 || (($b !== null) && (!is_int($b) && ((string)((int)$b) !== (string)$b)))) {
938 return $this->raiseError("limit: No Valid Arguments", DB_DATAOBJECT_ERROR_INVALIDARGS);
939 }
940 global $_DB_DATAOBJECT;
941 $this->_connect();
942 $DB = $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
943
944 $this->_query['limit_start'] = ($b == null) ? 0 : (int)$a;
945 $this->_query['limit_count'] = ($b == null) ? (int)$a : (int)$b;
946
947 }
948
949 /**
950 * Adds a select columns
951 *
952 * $object->selectAdd(); // resets select to nothing!
953 * $object->selectAdd("*"); // default select
954 * $object->selectAdd("unixtime(DATE) as udate");
955 * $object->selectAdd("DATE");
956 *
957 * to prepend distict:
958 * $object->selectAdd('distinct ' . $object->selectAdd());
959 *
960 * @param string $k
961 * @access public
962 * @return mixed null or old string if you reset it.
963 */
964 function selectAdd($k = null)
965 {
966 if ($this->_query === false) {
967 $this->raiseError(
968 "You cannot do two queries on the same object (copy it before finding)",
969 DB_DATAOBJECT_ERROR_INVALIDARGS);
970 return false;
971 }
972 if ($k === null) {
973 $old = $this->_query['data_select'];
974 $this->_query['data_select'] = '';
975 return $old;
976 }
977
978 // check input...= 0 or ' ' == error!
979 if (!trim($k)) {
980 return $this->raiseError("selectAdd: No Valid Arguments", DB_DATAOBJECT_ERROR_INVALIDARGS);
981 }
982
983 if ($this->_query['data_select']) {
984 $this->_query['data_select'] .= ', ';
985 }
986 $this->_query['data_select'] .= " $k ";
987 }
988 /**
989 * Adds multiple Columns or objects to select with formating.
990 *
991 * $object->selectAs(null); // adds "table.colnameA as colnameA,table.colnameB as colnameB,......"
992 * // note with null it will also clear the '*' default select
993 * $object->selectAs(array('a','b'),'%s_x'); // adds "a as a_x, b as b_x"
994 * $object->selectAs(array('a','b'),'ddd_%s','ccc'); // adds "ccc.a as ddd_a, ccc.b as ddd_b"
995 * $object->selectAdd($object,'prefix_%s'); // calls $object->get_table and adds it all as
996 * objectTableName.colnameA as prefix_colnameA
997 *
998 * @param array|object|null the array or object to take column names from.
999 * @param string format in sprintf format (use %s for the colname)
1000 * @param string table name eg. if you have joinAdd'd or send $from as an array.
1001 * @access public
1002 * @return void
1003 */
1004 function selectAs($from = null,$format = '%s',$tableName=false)
1005 {
1006 global $_DB_DATAOBJECT;
1007
1008 if ($this->_query === false) {
1009 $this->raiseError(
1010 "You cannot do two queries on the same object (copy it before finding)",
1011 DB_DATAOBJECT_ERROR_INVALIDARGS);
1012 return false;
1013 }
1014
1015 if ($from === null) {
1016 // blank the '*'
1017 $this->selectAdd();
1018 $from = $this;
1019 }
1020
1021
1022 $table = $this->tableName();
1023 if (is_object($from)) {
1024 $table = $from->tableName();
1025 $from = array_keys($from->table());
1026 }
1027
1028 if ($tableName !== false) {
1029 $table = $tableName;
1030 }
1031 $s = '%s';
1032 if (!empty($_DB_DATAOBJECT['CONFIG']['quote_identifiers'])) {
1033 $this->_connect();
1034 $DB = $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
1035 $s = $DB->quoteIdentifier($s);
1036 $format = $DB->quoteIdentifier($format);
1037 }
1038 foreach ($from as $k) {
1039 $this->selectAdd(sprintf("{$s}.{$s} as {$format}",$table,$k,$k));
1040 }
1041 $this->_query['data_select'] .= "\n";
1042 }
1043 /**
1044 * Insert the current objects variables into the database
1045 *
1046 * Returns the ID of the inserted element (if auto increment or sequences are used.)
1047 *
1048 * for example
1049 *
1050 * Designed to be extended
1051 *
1052 * $object = new mytable();
1053 * $object->name = "fred";
1054 * echo $object->insert();
1055 *
1056 * @access public
1057 * @return mixed false on failure, int when auto increment or sequence used, otherwise true on success
1058 */
1059 function insert()
1060 {
1061 global $_DB_DATAOBJECT;
1062
1063 // we need to write to the connection (For nextid) - so us the real
1064 // one not, a copyied on (as ret-by-ref fails with overload!)
1065
1066 if (!isset($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5])) {
1067 $this->_connect();
1068 }
1069
1070 $quoteIdentifiers = !empty($_DB_DATAOBJECT['CONFIG']['quote_identifiers']);
1071
1072 $DB = $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
1073
1074 $items = $this->table();
1075
1076 if (!$items) {
1077 $this->raiseError("insert:No table definition for {$this->tableName()}",
1078 DB_DATAOBJECT_ERROR_INVALIDCONFIG);
1079 return false;
1080 }
1081 $options = $_DB_DATAOBJECT['CONFIG'];
1082
1083
1084 $datasaved = 1;
1085 $leftq = '';
1086 $rightq = '';
1087
1088 $seqKeys = isset($_DB_DATAOBJECT['SEQUENCE'][$this->_database][$this->tableName()]) ?
1089 $_DB_DATAOBJECT['SEQUENCE'][$this->_database][$this->tableName()] :
1090 $this->sequenceKey();
1091
1092 $key = isset($seqKeys[0]) ? $seqKeys[0] : false;
1093 $useNative = isset($seqKeys[1]) ? $seqKeys[1] : false;
1094 $seq = isset($seqKeys[2]) ? $seqKeys[2] : false;
1095
1096 $dbtype = $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->dsn["phptype"];
1097
1098
1099 // nativeSequences or Sequences..
1100
1101 // big check for using sequences
1102
1103 if (($key !== false) && !$useNative) {
1104
1105 if (!$seq) {
1106 $keyvalue = $DB->nextId($this->tableName());
1107 } else {
1108 $f = $DB->getOption('seqname_format');
1109 $DB->setOption('seqname_format','%s');
1110 $keyvalue = $DB->nextId($seq);
1111 $DB->setOption('seqname_format',$f);
1112 }
1113 if (is_a($keyvalue, 'PEAR_Error')) {
1114 $this->raiseError($keyvalue->toString(), DB_DATAOBJECT_ERROR_INVALIDCONFIG);
1115 return false;
1116 }
1117 $this->$key = $keyvalue;
1118 }
1119
1120 // if we haven't set disable_null_strings to "full"
1121 $ignore_null = !isset($options['disable_null_strings'])
1122 || !is_string($options['disable_null_strings'])
1123 || strtolower($options['disable_null_strings']) !== 'full' ;
1124
1125
1126 foreach($items as $k => $v) {
1127
1128 // if we are using autoincrement - skip the column...
1129 if ($key && ($k == $key) && $useNative) {
1130 continue;
1131 }
1132
1133
1134 // Ignore INTEGERS which aren't set to a value - or empty string..
1135 if ( (!isset($this->$k) || ($v == 1 && $this->$k === ''))
1136 && $ignore_null
1137 ) {
1138 continue;
1139 }
1140 // dont insert data into mysql timestamps
1141 // use query() if you really want to do this!!!!
1142 if ($v & DB_DATAOBJECT_MYSQLTIMESTAMP) {
1143 continue;
1144 }
1145
1146 if ($leftq) {
1147 $leftq .= ', ';
1148 $rightq .= ', ';
1149 }
1150
1151 $leftq .= ($quoteIdentifiers ? ($DB->quoteIdentifier($k) . ' ') : "$k ");
1152
1153 if (is_object($this->$k) && is_a($this->$k,'DB_DataObject_Cast')) {
1154 $value = $this->$k->toString($v,$DB);
1155 if (is_a($value, 'PEAR_Error')) {
1156 $this->raiseError($value->toString() ,DB_DATAOBJECT_ERROR_INVALIDARGS);
1157 return false;
1158 }
1159 $rightq .= $value;
1160 continue;
1161 }
1162
1163
1164 if (!($v & DB_DATAOBJECT_NOTNULL) && DB_DataObject::_is_null($this,$k)) {
1165 $rightq .= " NULL ";
1166 continue;
1167 }
1168 // DATE is empty... on a col. that can be null..
1169 // note: this may be usefull for time as well..
1170 if (!$this->$k &&
1171 (($v & DB_DATAOBJECT_DATE) || ($v & DB_DATAOBJECT_TIME)) &&
1172 !($v & DB_DATAOBJECT_NOTNULL)) {
1173
1174 $rightq .= " NULL ";
1175 continue;
1176 }
1177
1178
1179 if ($v & DB_DATAOBJECT_STR) {
1180 $rightq .= $this->_quote((string) (
1181 ($v & DB_DATAOBJECT_BOOL) ?
1182 // this is thanks to the braindead idea of postgres to
1183 // use t/f for boolean.
1184 (($this->$k === 'f') ? 0 : (int)(bool) $this->$k) :
1185 $this->$k
1186 )) . " ";
1187 continue;
1188 }
1189 if (is_numeric($this->$k)) {
1190 $rightq .=" {$this->$k} ";
1191 continue;
1192 }
1193 /* flag up string values - only at debug level... !!!??? */
1194 if (is_object($this->$k) || is_array($this->$k)) {
1195 $this->debug('ODD DATA: ' .$k . ' ' . print_r($this->$k,true),'ERROR');
1196 }
1197
1198 // at present we only cast to integers
1199 // - V2 may store additional data about float/int
1200 $rightq .= ' ' . intval($this->$k) . ' ';
1201
1202 }
1203
1204 // not sure why we let empty insert here.. - I guess to generate a blank row..
1205
1206
1207 if ($leftq || $useNative) {
1208 $table = ($quoteIdentifiers ? $DB->quoteIdentifier($this->tableName()) : $this->tableName());
1209
1210
1211 if (($dbtype == 'pgsql') && empty($leftq)) {
1212 $r = $this->_query("INSERT INTO {$table} DEFAULT VALUES");
1213 } else {
1214 $r = $this->_query("INSERT INTO {$table} ($leftq) VALUES ($rightq) ");
1215 }
1216
1217
1218
1219
1220 if (is_a($r, 'PEAR_Error')) {
1221 $this->raiseError($r);
1222 return false;
1223 }
1224
1225 if ($r < 1) {
1226 return 0;
1227 }
1228
1229
1230 // now do we have an integer key!
1231
1232 if ($key && $useNative) {
1233 switch ($dbtype) {
1234 case 'mysql':
1235 case 'mysqli':
1236 $method = "{$dbtype}_insert_id";
1237 $this->$key = $method(
1238 $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->connection
1239 );
1240 break;
1241
1242 case 'mssql':
1243 // note this is not really thread safe - you should wrapp it with
1244 // transactions = eg.
1245 // $db->query('BEGIN');
1246 // $db->insert();
1247 // $db->query('COMMIT');
1248 $db_driver = empty($options['db_driver']) ? 'DB' : $options['db_driver'];
1249 $method = ($db_driver == 'DB') ? 'getOne' : 'queryOne';
1250 $mssql_key = $DB->$method("SELECT @@IDENTITY");
1251 if (is_a($mssql_key, 'PEAR_Error')) {
1252 $this->raiseError($mssql_key);
1253 return false;
1254 }
1255 $this->$key = $mssql_key;
1256 break;
1257
1258 case 'pgsql':
1259 if (!$seq) {
1260 $seq = $DB->getSequenceName(strtolower($this->tableName()));
1261 }
1262 $db_driver = empty($options['db_driver']) ? 'DB' : $options['db_driver'];
1263 $method = ($db_driver == 'DB') ? 'getOne' : 'queryOne';
1264 $pgsql_key = $DB->$method("SELECT currval('".$seq . "')");
1265
1266
1267 if (is_a($pgsql_key, 'PEAR_Error')) {
1268 $this->raiseError($pgsql_key);
1269 return false;
1270 }
1271 $this->$key = $pgsql_key;
1272 break;
1273
1274 case 'ifx':
1275 $this->$key = array_shift (
1276 ifx_fetch_row (
1277 ifx_query(
1278 "select DBINFO('sqlca.sqlerrd1') FROM systables where tabid=1",
1279 $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->connection,
1280 IFX_SCROLL
1281 ),
1282 "FIRST"
1283 )
1284 );
1285 break;
1286
1287 }
1288
1289 }
1290
1291 if (isset($_DB_DATAOBJECT['CACHE'][strtolower(get_class($this))])) {
1292 $this->_clear_cache();
1293 }
1294 if ($key) {
1295 return $this->$key;
1296 }
1297 return true;
1298 }
1299 $this->raiseError("insert: No Data specifed for query", DB_DATAOBJECT_ERROR_NODATA);
1300 return false;
1301 }
1302
1303 /**
1304 * Updates current objects variables into the database
1305 * uses the keys() to decide how to update
1306 * Returns the true on success
1307 *
1308 * for example
1309 *
1310 * $object = DB_DataObject::factory('mytable');
1311 * $object->get("ID",234);
1312 * $object->email="testing@test.com";
1313 * if(!$object->update())
1314 * echo "UPDATE FAILED";
1315 *
1316 * to only update changed items :
1317 * $dataobject->get(132);
1318 * $original = $dataobject; // clone/copy it..
1319 * $dataobject->setFrom($_POST);
1320 * if ($dataobject->validate()) {
1321 * $dataobject->update($original);
1322 * } // otherwise an error...
1323 *
1324 * performing global updates:
1325 * $object = DB_DataObject::factory('mytable');
1326 * $object->status = "dead";
1327 * $object->whereAdd('age > 150');
1328 * $object->update(DB_DATAOBJECT_WHEREADD_ONLY);
1329 *
1330 * @param object dataobject (optional) | DB_DATAOBJECT_WHEREADD_ONLY - used to only update changed items.
1331 * @access public
1332 * @return int rows affected or false on failure
1333 */
1334 function update($dataObject = false)
1335 {
1336 global $_DB_DATAOBJECT;
1337 // connect will load the config!
1338 $this->_connect();
1339
1340
1341 $original_query = $this->_query;
1342
1343 $items = $this->table();
1344
1345 // only apply update against sequence key if it is set?????
1346
1347 $seq = $this->sequenceKey();
1348 if ($seq[0] !== false) {
1349 $keys = array($seq[0]);
1350 if (!isset($this->{$keys[0]}) && $dataObject !== true) {
1351 $this->raiseError("update: trying to perform an update without
1352 the key set, and argument to update is not
1353 DB_DATAOBJECT_WHEREADD_ONLY
1354 ". print_r(array('seq' => $seq , 'keys'=>$keys), true), DB_DATAOBJECT_ERROR_INVALIDARGS);
1355 return false;
1356 }
1357 } else {
1358 $keys = $this->keys();
1359 }
1360
1361
1362 if (!$items) {
1363 $this->raiseError("update:No table definition for {$this->tableName()}", DB_DATAOBJECT_ERROR_INVALIDCONFIG);
1364 return false;
1365 }
1366 $datasaved = 1;
1367 $settings = '';
1368 $this->_connect();
1369
1370 $DB = $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
1371 $dbtype = $DB->dsn["phptype"];
1372 $quoteIdentifiers = !empty($_DB_DATAOBJECT['CONFIG']['quote_identifiers']);
1373 $options = $_DB_DATAOBJECT['CONFIG'];
1374
1375
1376 $ignore_null = !isset($options['disable_null_strings'])
1377 || !is_string($options['disable_null_strings'])
1378 || strtolower($options['disable_null_strings']) !== 'full' ;
1379
1380
1381 foreach($items as $k => $v) {
1382
1383 // I think this is ignoring empty vlalues
1384 if ((!isset($this->$k) || ($v == 1 && $this->$k === ''))
1385 && $ignore_null
1386 ) {
1387 continue;
1388 }
1389 // ignore stuff thats
1390
1391 // dont write things that havent changed..
1392 if (($dataObject !== false) && isset($dataObject->$k) && ($dataObject->$k === $this->$k)) {
1393 continue;
1394 }
1395
1396 // - dont write keys to left.!!!
1397 if (in_array($k,$keys)) {
1398 continue;
1399 }
1400
1401 // dont insert data into mysql timestamps
1402 // use query() if you really want to do this!!!!
1403 if ($v & DB_DATAOBJECT_MYSQLTIMESTAMP) {
1404 continue;
1405 }
1406
1407
1408 if ($settings) {
1409 $settings .= ', ';
1410 }
1411
1412 $kSql = ($quoteIdentifiers ? $DB->quoteIdentifier($k) : $k);
1413
1414 if (is_object($this->$k) && is_a($this->$k,'DB_DataObject_Cast')) {
1415 $value = $this->$k->toString($v,$DB);
1416 if (is_a($value, 'PEAR_Error')) {
1417 $this->raiseError($value->getMessage() ,DB_DATAOBJECT_ERROR_INVALIDARG);
1418 return false;
1419 }
1420 $settings .= "$kSql = $value ";
1421 continue;
1422 }
1423
1424 // special values ... at least null is handled...
1425 if (!($v & DB_DATAOBJECT_NOTNULL) && DB_DataObject::_is_null($this,$k)) {
1426 $settings .= "$kSql = NULL ";
1427 continue;
1428 }
1429 // DATE is empty... on a col. that can be null..
1430 // note: this may be usefull for time as well..
1431 if (!$this->$k &&
1432 (($v & DB_DATAOBJECT_DATE) || ($v & DB_DATAOBJECT_TIME)) &&
1433 !($v & DB_DATAOBJECT_NOTNULL)) {
1434
1435 $settings .= "$kSql = NULL ";
1436 continue;
1437 }
1438
1439
1440 if ($v & DB_DATAOBJECT_STR) {
1441 $settings .= "$kSql = ". $this->_quote((string) (
1442 ($v & DB_DATAOBJECT_BOOL) ?
1443 // this is thanks to the braindead idea of postgres to
1444 // use t/f for boolean.
1445 (($this->$k === 'f') ? 0 : (int)(bool) $this->$k) :
1446 $this->$k
1447 )) . ' ';
1448 continue;
1449 }
1450 if (is_numeric($this->$k)) {
1451 $settings .= "$kSql = {$this->$k} ";
1452 continue;
1453 }
1454 // at present we only cast to integers
1455 // - V2 may store additional data about float/int
1456 $settings .= "$kSql = " . intval($this->$k) . ' ';
1457 }
1458
1459
1460 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
1461 $this->debug("got keys as ".serialize($keys),3);
1462 }
1463 if ($dataObject !== true) {
1464 $this->_build_condition($items,$keys);
1465 } else {
1466 // prevent wiping out of data!
1467 if (empty($this->_query['condition'])) {
1468 $this->raiseError("update: global table update not available
1469 do \$do->whereAdd('1=1'); if you really want to do that.
1470 ", DB_DATAOBJECT_ERROR_INVALIDARGS);
1471 return false;
1472 }
1473 }
1474
1475
1476
1477 // echo " $settings, $this->condition ";
1478 if ($settings && isset($this->_query) && $this->_query['condition']) {
1479
1480 $table = ($quoteIdentifiers ? $DB->quoteIdentifier($this->tableName()) : $this->tableName());
1481
1482 $r = $this->_query("UPDATE {$table} SET {$settings} {$this->_query['condition']} ");
1483
1484 // restore original query conditions.
1485 $this->_query = $original_query;
1486
1487 if (is_a($r, 'PEAR_Error')) {
1488 $this->raiseError($r);
1489 return false;
1490 }
1491 if ($r < 1) {
1492 return 0;
1493 }
1494
1495 $this->_clear_cache();
1496 return $r;
1497 }
1498 // restore original query conditions.
1499 $this->_query = $original_query;
1500
1501 // if you manually specified a dataobject, and there where no changes - then it's ok..
1502 if ($dataObject !== false) {
1503 return true;
1504 }
1505
1506 $this->raiseError(
1507 "update: No Data specifed for query $settings , {$this->_query['condition']}",
1508 DB_DATAOBJECT_ERROR_NODATA);
1509 return false;
1510 }
1511
1512 /**
1513 * Deletes items from table which match current objects variables
1514 *
1515 * Returns the true on success
1516 *
1517 * for example
1518 *
1519 * Designed to be extended
1520 *
1521 * $object = new mytable();
1522 * $object->ID=123;
1523 * echo $object->delete(); // builds a conditon
1524 *
1525 * $object = new mytable();
1526 * $object->whereAdd('age > 12');
1527 * $object->limit(1);
1528 * $object->orderBy('age DESC');
1529 * $object->delete(true); // dont use object vars, use the conditions, limit and order.
1530 *
1531 * @param bool $useWhere (optional) If DB_DATAOBJECT_WHEREADD_ONLY is passed in then
1532 * we will build the condition only using the whereAdd's. Default is to
1533 * build the condition only using the object parameters.
1534 *
1535 * @access public
1536 * @return mixed Int (No. of rows affected) on success, false on failure, 0 on no data affected
1537 */
1538 function delete($useWhere = false)
1539 {
1540 global $_DB_DATAOBJECT;
1541 // connect will load the config!
1542 $this->_connect();
1543 $DB = $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
1544 $quoteIdentifiers = !empty($_DB_DATAOBJECT['CONFIG']['quote_identifiers']);
1545
1546 $extra_cond = ' ' . (isset($this->_query['order_by']) ? $this->_query['order_by'] : '');
1547
1548 if (!$useWhere) {
1549
1550 $keys = $this->keys();
1551 $this->_query = array(); // as it's probably unset!
1552 $this->_query['condition'] = ''; // default behaviour not to use where condition
1553 $this->_build_condition($this->table(),$keys);
1554 // if primary keys are not set then use data from rest of object.
1555 if (!$this->_query['condition']) {
1556 $this->_build_condition($this->table(),array(),$keys);
1557 }
1558 $extra_cond = '';
1559 }
1560
1561
1562 // don't delete without a condition
1563 if (($this->_query !== false) && $this->_query['condition']) {
1564
1565 $table = ($quoteIdentifiers ? $DB->quoteIdentifier($this->tableName()) : $this->tableName());
1566 $sql = "DELETE ";
1567 // using a joined delete. - with useWhere..
1568 $sql .= (!empty($this->_join) && $useWhere) ?
1569 "{$table} FROM {$table} {$this->_join} " :
1570 "FROM {$table} ";
1571
1572 $sql .= $this->_query['condition']. $extra_cond;
1573
1574 // add limit..
1575
1576 if (isset($this->_query['limit_start']) && strlen($this->_query['limit_start'] . $this->_query['limit_count'])) {
1577
1578 if (!isset($_DB_DATAOBJECT['CONFIG']['db_driver']) ||
1579 ($_DB_DATAOBJECT['CONFIG']['db_driver'] == 'DB')) {
1580 // pear DB
1581 $sql = $DB->modifyLimitQuery($sql,$this->_query['limit_start'], $this->_query['limit_count']);
1582
1583 } else {
1584 // MDB2
1585 $DB->setLimit( $this->_query['limit_count'],$this->_query['limit_start']);
1586 }
1587
1588 }
1589
1590
1591 $r = $this->_query($sql);
1592
1593
1594 if (is_a($r, 'PEAR_Error')) {
1595 $this->raiseError($r);
1596 return false;
1597 }
1598 if ($r < 1) {
1599 return 0;
1600 }
1601 $this->_clear_cache();
1602 return $r;
1603 } else {
1604 $this->raiseError("delete: No condition specifed for query", DB_DATAOBJECT_ERROR_NODATA);
1605 return false;
1606 }
1607 }
1608
1609 /**
1610 * fetches a specific row into this object variables
1611 *
1612 * Not recommended - better to use fetch()
1613 *
1614 * Returens true on success
1615 *
1616 * @param int $row row
1617 * @access public
1618 * @return boolean true on success
1619 */
1620 function fetchRow($row = null)
1621 {
1622 global $_DB_DATAOBJECT;
1623 if (empty($_DB_DATAOBJECT['CONFIG'])) {
1624 $this->_loadConfig();
1625 }
1626 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
1627 $this->debug("{$this->tableName()} $row of {$this->N}", "fetchrow",3);
1628 }
1629 if (!$this->tableName()) {
1630 $this->raiseError("fetchrow: No table", DB_DATAOBJECT_ERROR_INVALIDCONFIG);
1631 return false;
1632 }
1633 if ($row === null) {
1634 $this->raiseError("fetchrow: No row specified", DB_DATAOBJECT_ERROR_INVALIDARGS);
1635 return false;
1636 }
1637 if (!$this->N) {
1638 $this->raiseError("fetchrow: No results avaiable", DB_DATAOBJECT_ERROR_NODATA);
1639 return false;
1640 }
1641 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
1642 $this->debug("{$this->tableName()} $row of {$this->N}", "fetchrow",3);
1643 }
1644
1645
1646 $result = $_DB_DATAOBJECT['RESULTS'][$this->_DB_resultid];
1647 $array = $result->fetchrow(DB_DATAOBJECT_FETCHMODE_ASSOC,$row);
1648 if (!is_array($array)) {
1649 $this->raiseError("fetchrow: No results available", DB_DATAOBJECT_ERROR_NODATA);
1650 return false;
1651 }
1652 $replace = array('.', ' ');
1653 foreach($array as $k => $v) {
1654 // use strpos as str_replace is slow.
1655 $kk = (strpos($k, '.') === false && strpos($k, ' ') === false) ?
1656 $k : str_replace($replace, '_', $k);
1657
1658 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
1659 $this->debug("$kk = ". $array[$k], "fetchrow LINE", 3);
1660 }
1661 $this->$kk = $array[$k];
1662 }
1663
1664 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
1665 $this->debug("{$this->tableName()} DONE", "fetchrow", 3);
1666 }
1667 return true;
1668 }
1669
1670 /**
1671 * Find the number of results from a simple query
1672 *
1673 * for example
1674 *
1675 * $object = new mytable();
1676 * $object->name = "fred";
1677 * echo $object->count();
1678 * echo $object->count(true); // dont use object vars.
1679 * echo $object->count('distinct mycol'); count distinct mycol.
1680 * echo $object->count('distinct mycol',true); // dont use object vars.
1681 * echo $object->count('distinct'); // count distinct id (eg. the primary key)
1682 *
1683 *
1684 * @param bool|string (optional)
1685 * (true|false => see below not on whereAddonly)
1686 * (string)
1687 * "DISTINCT" => does a distinct count on the tables 'key' column
1688 * otherwise => normally it counts primary keys - you can use
1689 * this to do things like $do->count('distinct mycol');
1690 *
1691 * @param bool $whereAddOnly (optional) If DB_DATAOBJECT_WHEREADD_ONLY is passed in then
1692 * we will build the condition only using the whereAdd's. Default is to
1693 * build the condition using the object parameters as well.
1694 *
1695 * @access public
1696 * @return int
1697 */
1698 function count($countWhat = false,$whereAddOnly = false)
1699 {
1700 global $_DB_DATAOBJECT;
1701
1702 if (is_bool($countWhat)) {
1703 $whereAddOnly = $countWhat;
1704 }
1705
1706 $t = clone($this);
1707 $items = $t->table();
1708
1709 $quoteIdentifiers = !empty($_DB_DATAOBJECT['CONFIG']['quote_identifiers']);
1710
1711
1712 if (!isset($t->_query)) {
1713 $this->raiseError(
1714 "You cannot do run count after you have run fetch()",
1715 DB_DATAOBJECT_ERROR_INVALIDARGS);
1716 return false;
1717 }
1718 $this->_connect();
1719 $DB = $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
1720
1721
1722 if (!$whereAddOnly && $items) {
1723 $t->_build_condition($items);
1724 }
1725 $keys = $this->keys();
1726
1727 if (empty($keys[0]) && (!is_string($countWhat) || (strtoupper($countWhat) == 'DISTINCT'))) {
1728 $this->raiseError(
1729 "You cannot do run count without keys - use \$do->count('id'), or use \$do->count('distinct id')';",
1730 DB_DATAOBJECT_ERROR_INVALIDARGS,PEAR_ERROR_DIE);
1731 return false;
1732
1733 }
1734 $table = ($quoteIdentifiers ? $DB->quoteIdentifier($this->tableName()) : $this->tableName());
1735 $key_col = empty($keys[0]) ? '' : (($quoteIdentifiers ? $DB->quoteIdentifier($keys[0]) : $keys[0]));
1736 $as = ($quoteIdentifiers ? $DB->quoteIdentifier('DATAOBJECT_NUM') : 'DATAOBJECT_NUM');
1737
1738 // support distinct on default keys.
1739 $countWhat = (strtoupper($countWhat) == 'DISTINCT') ?
1740 "DISTINCT {$table}.{$key_col}" : $countWhat;
1741
1742 $countWhat = is_string($countWhat) ? $countWhat : "{$table}.{$key_col}";
1743
1744 $r = $t->_query(
1745 "SELECT count({$countWhat}) as $as
1746 FROM $table {$t->_join} {$t->_query['condition']}");
1747 if (is_a($r, 'PEAR_Error')) {
1748 return false;
1749 }
1750
1751 $result = $_DB_DATAOBJECT['RESULTS'][$t->_DB_resultid];
1752 $l = $result->fetchRow(DB_DATAOBJECT_FETCHMODE_ORDERED);
1753 // free the results - essential on oracle.
1754 $t->free();
1755 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
1756 $this->debug('Count returned '. $l[0] ,1);
1757 }
1758 return (int) $l[0];
1759 }
1760
1761 /**
1762 * sends raw query to database
1763 *
1764 * Since _query has to be a private 'non overwriteable method', this is a relay
1765 *
1766 * @param string $string SQL Query
1767 * @access public
1768 * @return void or DB_Error
1769 */
1770 function query($string)
1771 {
1772 return $this->_query($string);
1773 }
1774
1775
1776 /**
1777 * an escape wrapper around DB->escapeSimple()
1778 * can be used when adding manual queries or clauses
1779 * eg.
1780 * $object->query("select * from xyz where abc like '". $object->escape($_GET['name']) . "'");
1781 *
1782 * @param string $string value to be escaped
1783 * @param bool $likeEscape escapes % and _ as well. - so like queries can be protected.
1784 * @access public
1785 * @return string
1786 */
1787 function escape($string, $likeEscape=false)
1788 {
1789 global $_DB_DATAOBJECT;
1790 $this->_connect();
1791 $DB = $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
1792 // mdb2 uses escape...
1793 $dd = empty($_DB_DATAOBJECT['CONFIG']['db_driver']) ? 'DB' : $_DB_DATAOBJECT['CONFIG']['db_driver'];
1794 $ret = ($dd == 'DB') ? $DB->escapeSimple($string) : $DB->escape($string);
1795 if ($likeEscape) {
1796 $ret = str_replace(array('_','%'), array('\_','\%'), $ret);
1797 }
1798 return $ret;
1799
1800 }
1801
1802 /* ==================================================== */
1803 /* Major Private Vars */
1804 /* ==================================================== */
1805
1806 /**
1807 * The Database connection dsn (as described in the PEAR DB)
1808 * only used really if you are writing a very simple application/test..
1809 * try not to use this - it is better stored in configuration files..
1810 *
1811 * @access private
1812 * @var string
1813 */
1814 var $_database_dsn = '';
1815
1816 /**
1817 * The Database connection id (md5 sum of databasedsn)
1818 *
1819 * @access private
1820 * @var string
1821 */
1822 var $_database_dsn_md5 = '';
1823
1824 /**
1825 * The Database name
1826 * created in __connection
1827 *
1828 * @access private
1829 * @var string
1830 */
1831 var $_database = '';
1832
1833
1834
1835 /**
1836 * The QUERY rules
1837 * This replaces alot of the private variables
1838 * used to build a query, it is unset after find() is run.
1839 *
1840 *
1841 *
1842 * @access private
1843 * @var array
1844 */
1845 var $_query = array(
1846 'condition' => '', // the WHERE condition
1847 'group_by' => '', // the GROUP BY condition
1848 'order_by' => '', // the ORDER BY condition
1849 'having' => '', // the HAVING condition
1850 'useindex' => '', // the USE INDEX condition
1851 'limit_start' => '', // the LIMIT condition
1852 'limit_count' => '', // the LIMIT condition
1853 'data_select' => '*', // the columns to be SELECTed
1854 'unions' => array(), // the added unions,
1855 'derive_table' => '', // derived table name (BETA)
1856 'derive_select' => '', // derived table select (BETA)
1857 );
1858
1859
1860
1861
1862 /**
1863 * Database result id (references global $_DB_DataObject[results]
1864 *
1865 * @access private
1866 * @var integer
1867 */
1868 var $_DB_resultid;
1869
1870 /**
1871 * ResultFields - on the last call to fetch(), resultfields is sent here,
1872 * so we can clean up the memory.
1873 *
1874 * @access public
1875 * @var array
1876 */
1877 var $_resultFields = false;
1878
1879
1880 /* ============================================================== */
1881 /* Table definition layer (started of very private but 'came out'*/
1882 /* ============================================================== */
1883
1884 /**
1885 * Autoload or manually load the table definitions
1886 *
1887 *
1888 * usage :
1889 * DB_DataObject::databaseStructure( 'databasename',
1890 * parse_ini_file('mydb.ini',true),
1891 * parse_ini_file('mydb.link.ini',true));
1892 *
1893 * obviously you dont have to use ini files.. (just return array similar to ini files..)
1894 *
1895 * It should append to the table structure array
1896 *
1897 *
1898 * @param optional string name of database to assign / read
1899 * @param optional array structure of database, and keys
1900 * @param optional array table links
1901 *
1902 * @access public
1903 * @return true or PEAR:error on wrong paramenters.. or false if no file exists..
1904 * or the array(tablename => array(column_name=>type)) if called with 1 argument.. (databasename)
1905 */
1906 function databaseStructure()
1907 {
1908
1909 global $_DB_DATAOBJECT;
1910
1911 // Assignment code
1912
1913 if ($args = func_get_args()) {
1914
1915 if (count($args) == 1) {
1916
1917 // this returns all the tables and their structure..
1918 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
1919 $this->debug("Loading Generator as databaseStructure called with args",1);
1920 }
1921
1922 $x = new DB_DataObject;
1923 $x->_database = $args[0];
1924 $this->_connect();
1925 $DB = $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
1926
1927 $tables = $DB->getListOf('tables');
1928 class_exists('DB_DataObject_Generator') ? '' :
1929 require_once 'DB/DataObject/Generator.php';
1930
1931 foreach($tables as $table) {
1932 $y = new DB_DataObject_Generator;
1933 $y->fillTableSchema($x->_database,$table);
1934 }
1935 return $_DB_DATAOBJECT['INI'][$x->_database];
1936 } else {
1937
1938 $_DB_DATAOBJECT['INI'][$args[0]] = isset($_DB_DATAOBJECT['INI'][$args[0]]) ?
1939 $_DB_DATAOBJECT['INI'][$args[0]] + $args[1] : $args[1];
1940
1941 if (isset($args[1])) {
1942 $_DB_DATAOBJECT['LINKS'][$args[0]] = isset($_DB_DATAOBJECT['LINKS'][$args[0]]) ?
1943 $_DB_DATAOBJECT['LINKS'][$args[0]] + $args[2] : $args[2];
1944 }
1945 return true;
1946 }
1947
1948 }
1949
1950
1951
1952 if (!$this->_database) {
1953 $this->_connect();
1954 }
1955
1956
1957 // if this table is already loaded this table..
1958 if (!empty($_DB_DATAOBJECT['INI'][$this->_database][$this->tableName()])) {
1959 return true;
1960 }
1961
1962 // initialize the ini data.. if empt..
1963 if (empty($_DB_DATAOBJECT['INI'][$this->_database])) {
1964 $_DB_DATAOBJECT['INI'][$this->_database] = array();
1965 }
1966
1967 if (empty($_DB_DATAOBJECT['CONFIG'])) {
1968 DB_DataObject::_loadConfig();
1969 }
1970
1971 // we do not have the data for this table yet...
1972
1973 // if we are configured to use the proxy..
1974
1975 if ( !empty($_DB_DATAOBJECT['CONFIG']['proxy']) ) {
1976 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
1977 $this->debug("Loading Generator to fetch Schema",1);
1978 }
1979 class_exists('DB_DataObject_Generator') ? '' :
1980 require_once 'DB/DataObject/Generator.php';
1981
1982
1983 $x = new DB_DataObject_Generator;
1984 $x->fillTableSchema($this->_database,$this->tableName());
1985 return true;
1986 }
1987
1988
1989
1990
1991 // if you supply this with arguments, then it will take those
1992 // as the database and links array...
1993
1994 $schemas = isset($_DB_DATAOBJECT['CONFIG']['schema_location']) ?
1995 array("{$_DB_DATAOBJECT['CONFIG']['schema_location']}/{$this->_database}.ini") :
1996 array() ;
1997
1998 if (isset($_DB_DATAOBJECT['CONFIG']["ini_{$this->_database}"])) {
1999 $schemas = is_array($_DB_DATAOBJECT['CONFIG']["ini_{$this->_database}"]) ?
2000 $_DB_DATAOBJECT['CONFIG']["ini_{$this->_database}"] :
2001 explode(PATH_SEPARATOR,$_DB_DATAOBJECT['CONFIG']["ini_{$this->_database}"]);
2002 }
2003
2004
2005 $_DB_DATAOBJECT['INI'][$this->_database] = array();
2006 foreach ($schemas as $ini) {
2007 if (file_exists($ini) && is_file($ini)) {
2008
2009 $_DB_DATAOBJECT['INI'][$this->_database] = array_merge(
2010 $_DB_DATAOBJECT['INI'][$this->_database],
2011 parse_ini_file($ini, true)
2012 );
2013
2014 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
2015 if (!is_readable ($ini)) {
2016 $this->debug("ini file is not readable: $ini","databaseStructure",1);
2017 } else {
2018 $this->debug("Loaded ini file: $ini","databaseStructure",1);
2019 }
2020 }
2021 } else {
2022 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
2023 $this->debug("Missing ini file: $ini","databaseStructure",1);
2024 }
2025 }
2026
2027 }
2028 // are table name lowecased..
2029 if (!empty($_DB_DATAOBJECT['CONFIG']['portability']) && $_DB_DATAOBJECT['CONFIG']['portability'] & 1) {
2030 foreach($_DB_DATAOBJECT['INI'][$this->_database] as $k=>$v) {
2031 // results in duplicate cols.. but not a big issue..
2032 $_DB_DATAOBJECT['INI'][$this->_database][strtolower($k)] = $v;
2033 }
2034 }
2035
2036
2037 // now have we loaded the structure..
2038
2039 if (!empty($_DB_DATAOBJECT['INI'][$this->_database][$this->tableName()])) {
2040 return true;
2041 }
2042 // - if not try building it..
2043 if (!empty($_DB_DATAOBJECT['CONFIG']['proxy'])) {
2044 class_exists('DB_DataObject_Generator') ? '' :
2045 require_once 'DB/DataObject/Generator.php';
2046
2047 $x = new DB_DataObject_Generator;
2048 $x->fillTableSchema($this->_database,$this->tableName());
2049 // should this fail!!!???
2050 return true;
2051 }
2052 $this->debug("Cant find database schema: {$this->_database}/{$this->tableName()} \n".
2053 "in links file data: " . print_r($_DB_DATAOBJECT['INI'],true),"databaseStructure",5);
2054 // we have to die here!! - it causes chaos if we dont (including looping forever!)
2055 $this->raiseError( "Unable to load schema for database and table (turn debugging up to 5 for full error message)", DB_DATAOBJECT_ERROR_INVALIDARGS, PEAR_ERROR_DIE);
2056 return false;
2057
2058
2059 }
2060
2061
2062
2063
2064 /**
2065 * Return or assign the name of the current table
2066 *
2067 *
2068 * @param string optinal table name to set
2069 * @access public
2070 * @return string The name of the current table
2071 */
2072 function tableName()
2073 {
2074 global $_DB_DATAOBJECT;
2075 $args = func_get_args();
2076 if (count($args)) {
2077 $this->__table = $args[0];
2078 }
2079 if (!empty($_DB_DATAOBJECT['CONFIG']['portability']) && $_DB_DATAOBJECT['CONFIG']['portability'] & 1) {
2080 return strtolower($this->__table);
2081 }
2082 return $this->__table;
2083 }
2084
2085 /**
2086 * Return or assign the name of the current database
2087 *
2088 * @param string optional database name to set
2089 * @access public
2090 * @return string The name of the current database
2091 */
2092 function database()
2093 {
2094 $args = func_get_args();
2095 if (count($args)) {
2096 $this->_database = $args[0];
2097 } else {
2098 $this->_connect();
2099 }
2100
2101 return $this->_database;
2102 }
2103
2104 /**
2105 * get/set an associative array of table columns
2106 *
2107 * @access public
2108 * @param array key=>type array
2109 * @return array (associative)
2110 */
2111 function table()
2112 {
2113
2114 // for temporary storage of database fields..
2115 // note this is not declared as we dont want to bloat the print_r output
2116 $args = func_get_args();
2117 if (count($args)) {
2118 $this->_database_fields = $args[0];
2119 }
2120 if (isset($this->_database_fields)) {
2121 return $this->_database_fields;
2122 }
2123
2124
2125 global $_DB_DATAOBJECT;
2126 if (!isset($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5])) {
2127 $this->_connect();
2128 }
2129
2130 if (isset($_DB_DATAOBJECT['INI'][$this->_database][$this->tableName()])) {
2131 return $_DB_DATAOBJECT['INI'][$this->_database][$this->tableName()];
2132 }
2133
2134 $this->databaseStructure();
2135
2136
2137 $ret = array();
2138 if (isset($_DB_DATAOBJECT['INI'][$this->_database][$this->tableName()])) {
2139 $ret = $_DB_DATAOBJECT['INI'][$this->_database][$this->tableName()];
2140 }
2141
2142 return $ret;
2143 }
2144
2145 /**
2146 * get/set an array of table primary keys
2147 *
2148 * set usage: $do->keys('id','code');
2149 *
2150 * This is defined in the table definition if it gets it wrong,
2151 * or you do not want to use ini tables, you can override this.
2152 * @param string optional set the key
2153 * @param * optional set more keys
2154 * @access public
2155 * @return array
2156 */
2157 function keys()
2158 {
2159 // for temporary storage of database fields..
2160 // note this is not declared as we dont want to bloat the print_r output
2161 $args = func_get_args();
2162 if (count($args)) {
2163 $this->_database_keys = $args;
2164 }
2165 if (isset($this->_database_keys)) {
2166 return $this->_database_keys;
2167 }
2168
2169 global $_DB_DATAOBJECT;
2170 if (!isset($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5])) {
2171 $this->_connect();
2172 }
2173 if (isset($_DB_DATAOBJECT['INI'][$this->_database][$this->tableName()."__keys"])) {
2174 return array_keys($_DB_DATAOBJECT['INI'][$this->_database][$this->tableName()."__keys"]);
2175 }
2176 $this->databaseStructure();
2177
2178 if (isset($_DB_DATAOBJECT['INI'][$this->_database][$this->tableName()."__keys"])) {
2179 return array_keys($_DB_DATAOBJECT['INI'][$this->_database][$this->tableName()."__keys"]);
2180 }
2181 return array();
2182 }
2183 /**
2184 * get/set an sequence key
2185 *
2186 * by default it returns the first key from keys()
2187 * set usage: $do->sequenceKey('id',true);
2188 *
2189 * override this to return array(false,false) if table has no real sequence key.
2190 *
2191 * @param string optional the key sequence/autoinc. key
2192 * @param boolean optional use native increment. default false
2193 * @param false|string optional native sequence name
2194 * @access public
2195 * @return array (column,use_native,sequence_name)
2196 */
2197 function sequenceKey()
2198 {
2199 global $_DB_DATAOBJECT;
2200
2201 // call setting
2202 if (!$this->_database) {
2203 $this->_connect();
2204 }
2205
2206 if (!isset($_DB_DATAOBJECT['SEQUENCE'][$this->_database])) {
2207 $_DB_DATAOBJECT['SEQUENCE'][$this->_database] = array();
2208 }
2209
2210
2211 $args = func_get_args();
2212 if (count($args)) {
2213 $args[1] = isset($args[1]) ? $args[1] : false;
2214 $args[2] = isset($args[2]) ? $args[2] : false;
2215 $_DB_DATAOBJECT['SEQUENCE'][$this->_database][$this->tableName()] = $args;
2216 }
2217 if (isset($_DB_DATAOBJECT['SEQUENCE'][$this->_database][$this->tableName()])) {
2218 return $_DB_DATAOBJECT['SEQUENCE'][$this->_database][$this->tableName()];
2219 }
2220 // end call setting (eg. $do->sequenceKeys(a,b,c); )
2221
2222
2223
2224
2225 $keys = $this->keys();
2226 if (!$keys) {
2227 return $_DB_DATAOBJECT['SEQUENCE'][$this->_database][$this->tableName()]
2228 = array(false,false,false);
2229 }
2230
2231
2232 $table = $this->table();
2233
2234 $dbtype = $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->dsn['phptype'];
2235
2236 $usekey = $keys[0];
2237
2238
2239
2240 $seqname = false;
2241
2242 if (!empty($_DB_DATAOBJECT['CONFIG']['sequence_'.$this->tableName()])) {
2243 $seqname = $_DB_DATAOBJECT['CONFIG']['sequence_'.$this->tableName()];
2244 if (strpos($seqname,':') !== false) {
2245 list($usekey,$seqname) = explode(':',$seqname);
2246 }
2247 }
2248
2249
2250 // if the key is not an integer - then it's not a sequence or native
2251 if (empty($table[$usekey]) || !($table[$usekey] & DB_DATAOBJECT_INT)) {
2252 return $_DB_DATAOBJECT['SEQUENCE'][$this->_database][$this->tableName()] = array(false,false,false);
2253 }
2254
2255
2256 if (!empty($_DB_DATAOBJECT['CONFIG']['ignore_sequence_keys'])) {
2257 $ignore = $_DB_DATAOBJECT['CONFIG']['ignore_sequence_keys'];
2258 if (is_string($ignore) && (strtoupper($ignore) == 'ALL')) {
2259 return $_DB_DATAOBJECT['SEQUENCE'][$this->_database][$this->tableName()] = array(false,false,$seqname);
2260 }
2261 if (is_string($ignore)) {
2262 $ignore = $_DB_DATAOBJECT['CONFIG']['ignore_sequence_keys'] = explode(',',$ignore);
2263 }
2264 if (in_array($this->tableName(),$ignore)) {
2265 return $_DB_DATAOBJECT['SEQUENCE'][$this->_database][$this->tableName()] = array(false,false,$seqname);
2266 }
2267 }
2268
2269
2270 $realkeys = $_DB_DATAOBJECT['INI'][$this->_database][$this->tableName()."__keys"];
2271
2272 // if you are using an old ini file - go back to old behaviour...
2273 if (is_numeric($realkeys[$usekey])) {
2274 $realkeys[$usekey] = 'N';
2275 }
2276
2277 // multiple unique primary keys without a native sequence...
2278 if (($realkeys[$usekey] == 'K') && (count($keys) > 1)) {
2279 return $_DB_DATAOBJECT['SEQUENCE'][$this->_database][$this->tableName()] = array(false,false,$seqname);
2280 }
2281 // use native sequence keys...
2282 // technically postgres native here...
2283 // we need to get the new improved tabledata sorted out first.
2284
2285 // support named sequence keys.. - currently postgres only..
2286
2287 if ( in_array($dbtype , array('pgsql')) &&
2288 ($table[$usekey] & DB_DATAOBJECT_INT) &&
2289 isset($realkeys[$usekey]) && strlen($realkeys[$usekey]) > 1) {
2290 return $_DB_DATAOBJECT['SEQUENCE'][$this->_database][$this->tableName()] = array($usekey,true, $realkeys[$usekey]);
2291 }
2292
2293 if ( in_array($dbtype , array('pgsql', 'mysql', 'mysqli', 'mssql', 'ifx')) &&
2294 ($table[$usekey] & DB_DATAOBJECT_INT) &&
2295 isset($realkeys[$usekey]) && ($realkeys[$usekey] == 'N')
2296 ) {
2297 return $_DB_DATAOBJECT['SEQUENCE'][$this->_database][$this->tableName()] = array($usekey,true,$seqname);
2298 }
2299
2300
2301 // if not a native autoinc, and we have not assumed all primary keys are sequence
2302 if (($realkeys[$usekey] != 'N') &&
2303 !empty($_DB_DATAOBJECT['CONFIG']['dont_use_pear_sequences'])) {
2304 return array(false,false,false);
2305 }
2306
2307
2308
2309 // I assume it's going to try and be a nextval DB sequence.. (not native)
2310 return $_DB_DATAOBJECT['SEQUENCE'][$this->_database][$this->tableName()] = array($usekey,false,$seqname);
2311 }
2312
2313
2314
2315 /* =========================================================== */
2316 /* Major Private Methods - the core part! */
2317 /* =========================================================== */
2318
2319
2320
2321 /**
2322 * clear the cache values for this class - normally done on insert/update etc.
2323 *
2324 * @access private
2325 * @return void
2326 */
2327 function _clear_cache()
2328 {
2329 global $_DB_DATAOBJECT;
2330
2331 $class = strtolower(get_class($this));
2332
2333 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
2334 $this->debug("Clearing Cache for ".$class,1);
2335 }
2336
2337 if (!empty($_DB_DATAOBJECT['CACHE'][$class])) {
2338 unset($_DB_DATAOBJECT['CACHE'][$class]);
2339 }
2340 }
2341
2342
2343 /**
2344 * backend wrapper for quoting, as MDB2 and DB do it differently...
2345 *
2346 * @access private
2347 * @return string quoted
2348 */
2349
2350 function _quote($str)
2351 {
2352 global $_DB_DATAOBJECT;
2353 return (empty($_DB_DATAOBJECT['CONFIG']['db_driver']) ||
2354 ($_DB_DATAOBJECT['CONFIG']['db_driver'] == 'DB'))
2355 ? $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->quoteSmart($str)
2356 : $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->quote($str);
2357 }
2358
2359
2360 /**
2361 * connects to the database
2362 *
2363 *
2364 * TODO: tidy this up - This has grown to support a number of connection options like
2365 * a) dynamic changing of ini file to change which database to connect to
2366 * b) multi data via the table_{$table} = dsn ini option
2367 * c) session based storage.
2368 *
2369 * @access private
2370 * @return true | PEAR::error
2371 */
2372 function _connect()
2373 {
2374 global $_DB_DATAOBJECT;
2375 if (empty($_DB_DATAOBJECT['CONFIG'])) {
2376 $this->_loadConfig();
2377 }
2378 // Set database driver for reference
2379 $db_driver = empty($_DB_DATAOBJECT['CONFIG']['db_driver']) ?
2380 'DB' : $_DB_DATAOBJECT['CONFIG']['db_driver'];
2381
2382 // is it already connected ?
2383 if ($this->_database_dsn_md5 && !empty($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5])) {
2384
2385 // connection is an error...
2386 if (is_a($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5],'PEAR_Error')) {
2387 return $this->raiseError(
2388 $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->message,
2389 $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->code, PEAR_ERROR_DIE
2390 );
2391
2392 }
2393
2394 if (empty($this->_database)) {
2395 $this->_database = $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->dsn['database'];
2396 $hasGetDatabase = method_exists($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5], 'getDatabase');
2397
2398 $this->_database = ($db_driver != 'DB' && $hasGetDatabase)
2399 ? $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->getDatabase()
2400 : $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->dsn['database'];
2401
2402
2403
2404 if (($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->dsn['phptype'] == 'sqlite')
2405 && is_file($this->_database)) {
2406 $this->_database = basename($this->_database);
2407 }
2408 if ($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->dsn['phptype'] == 'ibase') {
2409 $this->_database = substr(basename($this->_database), 0, -4);
2410 }
2411
2412 }
2413 // theoretically we have a md5, it's listed in connections and it's not an error.
2414 // so everything is ok!
2415 return true;
2416
2417 }
2418
2419 // it's not currently connected!
2420 // try and work out what to use for the dsn !
2421
2422 $options= $_DB_DATAOBJECT['CONFIG'];
2423 // if the databse dsn dis defined in the object..
2424 $dsn = isset($this->_database_dsn) ? $this->_database_dsn : null;
2425
2426 if (!$dsn) {
2427 if (!$this->_database && !empty($this->__table)) {
2428 $this->_database = isset($options["table_{$this->tableName()}"]) ? $options["table_{$this->tableName()}"] : null;
2429 }
2430 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
2431 $this->debug("Checking for database specific ini ('{$this->_database}') : database_{$this->_database} in options","CONNECT");
2432 }
2433
2434 if ($this->_database && !empty($options["database_{$this->_database}"])) {
2435 $dsn = $options["database_{$this->_database}"];
2436 } else if (!empty($options['database'])) {
2437 $dsn = $options['database'];
2438
2439 }
2440 }
2441
2442 // if still no database...
2443 if (!$dsn) {
2444 return $this->raiseError(
2445 "No database name / dsn found anywhere",
2446 DB_DATAOBJECT_ERROR_INVALIDCONFIG, PEAR_ERROR_DIE
2447 );
2448
2449 }
2450
2451
2452 if (is_string($dsn)) {
2453 $this->_database_dsn_md5 = md5($dsn);
2454 } else {
2455 /// support array based dsn's
2456 $this->_database_dsn_md5 = md5(serialize($dsn));
2457 }
2458
2459 if (!empty($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5])) {
2460 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
2461 $this->debug("USING CACHED CONNECTION", "CONNECT",3);
2462 }
2463
2464
2465
2466 if (!$this->_database) {
2467
2468 $hasGetDatabase = method_exists($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5], 'getDatabase');
2469 $this->_database = ($db_driver != 'DB' && $hasGetDatabase)
2470 ? $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->getDatabase()
2471 : $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->dsn['database'];
2472
2473 if (($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->dsn['phptype'] == 'sqlite')
2474 && is_file($this->_database))
2475 {
2476 $this->_database = basename($this->_database);
2477 }
2478 }
2479 return true;
2480 }
2481 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
2482 $this->debug("NEW CONNECTION TP DATABASE :" .$this->_database , "CONNECT",3);
2483 /* actualy make a connection */
2484 $this->debug(print_r($dsn,true) ." {$this->_database_dsn_md5}", "CONNECT",3);
2485 }
2486
2487 // Note this is verbose deliberatly!
2488
2489 if ($db_driver == 'DB') {
2490
2491 /* PEAR DB connect */
2492
2493 // this allows the setings of compatibility on DB
2494 $db_options = (new PEAR)->getStaticProperty('DB','options');
2495 require_once 'DB.php';
2496 if ($db_options) {
2497 $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5] = DB::connect($dsn,$db_options);
2498 } else {
2499 $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5] = DB::connect($dsn);
2500 }
2501
2502 } else {
2503 /* assumption is MDB2 */
2504 require_once 'MDB2.php';
2505 // this allows the setings of compatibility on MDB2
2506 $db_options = PEAR::getStaticProperty('MDB2','options');
2507 $db_options = is_array($db_options) ? $db_options : array();
2508 $db_options['portability'] = isset($db_options['portability'] )
2509 ? $db_options['portability'] : MDB2_PORTABILITY_ALL ^ MDB2_PORTABILITY_FIX_CASE;
2510 $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5] = MDB2::connect($dsn,$db_options);
2511
2512 }
2513
2514
2515 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
2516 $this->debug(print_r($_DB_DATAOBJECT['CONNECTIONS'],true), "CONNECT",5);
2517 }
2518 if (is_a($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5], 'PEAR_Error')) {
2519 $this->debug($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->toString(), "CONNECT FAILED",5);
2520 return $this->raiseError(
2521 "Connect failed, turn on debugging to 5 see why",
2522 $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->code, PEAR_ERROR_DIE
2523 );
2524
2525 }
2526
2527 if (empty($this->_database)) {
2528 $hasGetDatabase = method_exists($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5], 'getDatabase');
2529
2530 $this->_database = ($db_driver != 'DB' && $hasGetDatabase)
2531 ? $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->getDatabase()
2532 : $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->dsn['database'];
2533
2534
2535 if (($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->dsn['phptype'] == 'sqlite')
2536 && is_file($this->_database))
2537 {
2538 $this->_database = basename($this->_database);
2539 }
2540 }
2541
2542 // Oracle need to optimize for portibility - not sure exactly what this does though :)
2543
2544 return true;
2545 }
2546
2547 /**
2548 * sends query to database - this is the private one that must work
2549 * - internal functions use this rather than $this->query()
2550 *
2551 * @param string $string
2552 * @access private
2553 * @return mixed none or PEAR_Error
2554 */
2555 function _query($string)
2556 {
2557 global $_DB_DATAOBJECT;
2558 $this->_connect();
2559
2560
2561 $DB = $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
2562
2563 $options = $_DB_DATAOBJECT['CONFIG'];
2564
2565 $_DB_driver = empty($_DB_DATAOBJECT['CONFIG']['db_driver']) ?
2566 'DB': $_DB_DATAOBJECT['CONFIG']['db_driver'];
2567
2568 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
2569 $this->debug($string,$log="QUERY");
2570
2571 }
2572
2573 if (
2574 strtoupper($string) == 'BEGIN' ||
2575 strtoupper($string) == 'START TRANSACTION'
2576 ) {
2577 if ($_DB_driver == 'DB') {
2578 $DB->autoCommit(false);
2579 $DB->simpleQuery('BEGIN');
2580 } else {
2581 $DB->beginTransaction();
2582 }
2583 return true;
2584 }
2585
2586 if (strtoupper($string) == 'COMMIT') {
2587 $res = $DB->commit();
2588 if ($_DB_driver == 'DB') {
2589 $DB->autoCommit(true);
2590 }
2591 return $res;
2592 }
2593
2594 if (strtoupper($string) == 'ROLLBACK') {
2595 $DB->rollback();
2596 if ($_DB_driver == 'DB') {
2597 $DB->autoCommit(true);
2598 }
2599 return true;
2600 }
2601
2602
2603 if (!empty($options['debug_ignore_updates']) &&
2604 (strtolower(substr(trim($string), 0, 6)) != 'select') &&
2605 (strtolower(substr(trim($string), 0, 4)) != 'show') &&
2606 (strtolower(substr(trim($string), 0, 8)) != 'describe')) {
2607
2608 $this->debug('Disabling Update as you are in debug mode');
2609 return $this->raiseError("Disabling Update as you are in debug mode", null) ;
2610
2611 }
2612 //if (@$_DB_DATAOBJECT['CONFIG']['debug'] > 1) {
2613 // this will only work when PEAR:DB supports it.
2614 //$this->debug($DB->getAll('explain ' .$string,DB_DATAOBJECT_FETCHMODE_ASSOC), $log="sql",2);
2615 //}
2616
2617 // some sim
2618 $t= explode(' ',microtime());
2619 $_DB_DATAOBJECT['QUERYENDTIME'] = $time = $t[0]+$t[1];
2620
2621
2622 for ($tries = 0;$tries < 3;$tries++) {
2623
2624 if ($_DB_driver == 'DB') {
2625
2626 $result = $DB->query($string);
2627 } else {
2628 switch (strtolower(substr(trim($string),0,6))) {
2629
2630 case 'insert':
2631 case 'update':
2632 case 'delete':
2633 $result = $DB->exec($string);
2634 break;
2635
2636 default:
2637 $result = $DB->query($string);
2638 break;
2639 }
2640 }
2641
2642 // see if we got a failure.. - try again a few times..
2643 if (!is_object($result) || !is_a($result,'PEAR_Error')) {
2644 break;
2645 }
2646 if ($result->getCode() != -14) { // *DB_ERROR_NODBSELECTED
2647 break; // not a connection error..
2648 }
2649 sleep(1); // wait before retyring..
2650 $DB->connect($DB->dsn);
2651 }
2652
2653
2654 if (is_object($result) && is_a($result,'PEAR_Error')) {
2655 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
2656 $this->debug($result->toString(), "Query Error",1 );
2657 }
2658 $this->N = false;
2659 return $this->raiseError($result);
2660 }
2661 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
2662 $t= explode(' ',microtime());
2663 $_DB_DATAOBJECT['QUERYENDTIME'] = $t[0]+$t[1];
2664 $this->debug('QUERY DONE IN '.($t[0]+$t[1]-$time)." seconds", 'query',1);
2665 }
2666 switch (strtolower(substr(trim($string),0,6))) {
2667 case 'insert':
2668 case 'update':
2669 case 'delete':
2670 if ($_DB_driver == 'DB') {
2671 // pear DB specific
2672 return $DB->affectedRows();
2673 }
2674 return $result;
2675 }
2676 if (is_object($result)) {
2677 // lets hope that copying the result object is OK!
2678
2679 $_DB_resultid = $GLOBALS['_DB_DATAOBJECT']['RESULTSEQ']++;
2680 $_DB_DATAOBJECT['RESULTS'][$_DB_resultid] = $result;
2681 $this->_DB_resultid = $_DB_resultid;
2682 }
2683 $this->N = 0;
2684 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
2685 $this->debug(serialize($result), 'RESULT',5);
2686 }
2687 if (method_exists($result, 'numRows')) {
2688 if ($_DB_driver == 'DB') {
2689 $DB->expectError(DB_ERROR_UNSUPPORTED);
2690 } else {
2691 $DB->expectError(MDB2_ERROR_UNSUPPORTED);
2692 }
2693
2694 $this->N = $result->numRows();
2695 //var_dump($this->N);
2696
2697 if (is_object($this->N) && is_a($this->N,'PEAR_Error')) {
2698 $this->N = true;
2699 }
2700 $DB->popExpect();
2701 }
2702 }
2703
2704 /**
2705 * Builds the WHERE based on the values of of this object
2706 *
2707 * @param mixed $keys
2708 * @param array $filter (used by update to only uses keys in this filter list).
2709 * @param array $negative_filter (used by delete to prevent deleting using the keys mentioned..)
2710 * @access private
2711 * @return string
2712 */
2713 function _build_condition($keys, $filter = array(),$negative_filter=array())
2714 {
2715 global $_DB_DATAOBJECT;
2716 $this->_connect();
2717 $DB = $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
2718
2719 $quoteIdentifiers = !empty($_DB_DATAOBJECT['CONFIG']['quote_identifiers']);
2720 $options = $_DB_DATAOBJECT['CONFIG'];
2721
2722 // if we dont have query vars.. - reset them.
2723 if ($this->_query === false) {
2724 $x = new DB_DataObject;
2725 $this->_query= $x->_query;
2726 }
2727
2728
2729 foreach($keys as $k => $v) {
2730 // index keys is an indexed array
2731 /* these filter checks are a bit suspicious..
2732 - need to check that update really wants to work this way */
2733
2734 if ($filter) {
2735 if (!in_array($k, $filter)) {
2736 continue;
2737 }
2738 }
2739 if ($negative_filter) {
2740 if (in_array($k, $negative_filter)) {
2741 continue;
2742 }
2743 }
2744 if (!isset($this->$k)) {
2745 continue;
2746 }
2747
2748 $kSql = $quoteIdentifiers
2749 ? ( $DB->quoteIdentifier($this->tableName()) . '.' . $DB->quoteIdentifier($k) )
2750 : "{$this->tableName()}.{$k}";
2751
2752
2753
2754 if (is_object($this->$k) && is_a($this->$k,'DB_DataObject_Cast')) {
2755 $dbtype = $DB->dsn["phptype"];
2756 $value = $this->$k->toString($v,$DB);
2757 if (is_a($value, 'PEAR_Error')) {
2758 $this->raiseError($value->getMessage() ,DB_DATAOBJECT_ERROR_INVALIDARG);
2759 return false;
2760 }
2761 if ((strtolower($value) === 'null') && !($v & DB_DATAOBJECT_NOTNULL)) {
2762 $this->whereAdd(" $kSql IS NULL");
2763 continue;
2764 }
2765 $this->whereAdd(" $kSql = $value");
2766 continue;
2767 }
2768
2769 if (!($v & DB_DATAOBJECT_NOTNULL) && DB_DataObject::_is_null($this,$k)) {
2770 $this->whereAdd(" $kSql IS NULL");
2771 continue;
2772 }
2773
2774
2775 if ($v & DB_DATAOBJECT_STR) {
2776 $this->whereAdd(" $kSql = " . $this->_quote((string) (
2777 ($v & DB_DATAOBJECT_BOOL) ?
2778 // this is thanks to the braindead idea of postgres to
2779 // use t/f for boolean.
2780 (($this->$k === 'f') ? 0 : (int)(bool) $this->$k) :
2781 $this->$k
2782 )) );
2783 continue;
2784 }
2785 if (is_numeric($this->$k)) {
2786 $this->whereAdd(" $kSql = {$this->$k}");
2787 continue;
2788 }
2789 /* this is probably an error condition! */
2790 $this->whereAdd(" $kSql = ".intval($this->$k));
2791 }
2792 }
2793
2794
2795
2796 /**
2797 * classic factory method for loading a table class
2798 * usage: $do = DB_DataObject::factory('person')
2799 * WARNING - this may emit a include error if the file does not exist..
2800 * use @ to silence it (if you are sure it is acceptable)
2801 * eg. $do = @DB_DataObject::factory('person')
2802 *
2803 * table name can bedatabasename/table
2804 * - and allow modular dataobjects to be written..
2805 * (this also helps proxy creation)
2806 *
2807 * Experimental Support for Multi-Database factory eg. mydatabase.mytable
2808 *
2809 *
2810 * @param string $table tablename (use blank to create a new instance of the same class.)
2811 * @access private
2812 * @return DataObject|PEAR_Error
2813 */
2814
2815
2816
2817 static function factory($table = '')
2818 {
2819 global $_DB_DATAOBJECT;
2820
2821
2822 // multi-database support.. - experimental.
2823 $database = '';
2824
2825 if (strpos( $table,'/') !== false ) {
2826 list($database,$table) = explode('.',$table, 2);
2827
2828 }
2829
2830 if (empty($_DB_DATAOBJECT['CONFIG'])) {
2831 DB_DataObject::_loadConfig();
2832 }
2833 // no configuration available for database
2834 if (!empty($database) && empty($_DB_DATAOBJECT['CONFIG']['database_'.$database])) {
2835 $do = new DB_DataObject();
2836 $do->raiseError(
2837 "unable to find database_{$database} in Configuration, It is required for factory with database"
2838 , 0, PEAR_ERROR_DIE );
2839 }
2840
2841
2842 /*
2843 if ($table === '') {
2844 if (is_a($this,'DB_DataObject') && strlen($this->tableName())) {
2845 $table = $this->tableName();
2846 } else {
2847 return DB_DataObject::raiseError(
2848 "factory did not recieve a table name",
2849 DB_DATAOBJECT_ERROR_INVALIDARGS);
2850 }
2851 }
2852
2853 */
2854 // does this need multi db support??
2855 $cp = isset($_DB_DATAOBJECT['CONFIG']['class_prefix']) ?
2856 explode(PATH_SEPARATOR, $_DB_DATAOBJECT['CONFIG']['class_prefix']) : '';
2857
2858 //print_r($cp);
2859
2860 // multiprefix support.
2861 $tbl = preg_replace('/[^A-Z0-9]/i','_',ucfirst($table));
2862 if (is_array($cp)) {
2863 $class = array();
2864 foreach($cp as $cpr) {
2865 $ce = substr(phpversion(),0,1) > 4 ? class_exists($cpr . $tbl,false) : class_exists($cpr . $tbl);
2866 if ($ce) {
2867 $class = $cpr . $tbl;
2868 break;
2869 }
2870 $class[] = $cpr . $tbl;
2871 }
2872 } else {
2873 $class = $tbl;
2874 $ce = substr(phpversion(),0,1) > 4 ? class_exists($class,false) : class_exists($class);
2875 }
2876
2877
2878 $rclass = $ce ? $class : DB_DataObject::_autoloadClass($class, $table);
2879 // proxy = full|light
2880 if (!$rclass && isset($_DB_DATAOBJECT['CONFIG']['proxy'])) {
2881
2882 DB_DataObject::debug("FAILED TO Autoload $database.$table - using proxy.","FACTORY",1);
2883
2884
2885 $proxyMethod = 'getProxy'.$_DB_DATAOBJECT['CONFIG']['proxy'];
2886 // if you have loaded (some other way) - dont try and load it again..
2887 class_exists('DB_DataObject_Generator') ? '' :
2888 require_once 'DB/DataObject/Generator.php';
2889
2890 $d = new DB_DataObject;
2891
2892 $d->__table = $table;
2893
2894 $ret = $d->_connect();
2895 if (is_object($ret) && is_a($ret, 'PEAR_Error')) {
2896 return $ret;
2897 }
2898
2899 $x = new DB_DataObject_Generator;
2900 return $x->$proxyMethod( $d->_database, $table);
2901 }
2902
2903 if (!$rclass || !class_exists($rclass)) {
2904 $dor = new DB_DataObject();
2905 return $dor->raiseError(
2906 "factory could not find class " .
2907 (is_array($class) ? implode(PATH_SEPARATOR, $class) : $class ).
2908 "from $table",
2909 DB_DATAOBJECT_ERROR_INVALIDCONFIG);
2910 }
2911
2912 $ret = new $rclass();
2913
2914 if (!empty($database)) {
2915 DB_DataObject::debug("Setting database to $database","FACTORY",1);
2916 $ret->database($database);
2917 }
2918 return $ret;
2919 }
2920 /**
2921 * autoload Class
2922 *
2923 * @param string|array $class Class
2924 * @param string $table Table trying to load.
2925 * @access private
2926 * @return string classname on Success
2927 */
2928 function _autoloadClass($class, $table=false)
2929 {
2930 global $_DB_DATAOBJECT;
2931
2932 if (empty($_DB_DATAOBJECT['CONFIG'])) {
2933 DB_DataObject::_loadConfig();
2934 }
2935 $class_prefix = empty($_DB_DATAOBJECT['CONFIG']['class_prefix']) ?
2936 '' : $_DB_DATAOBJECT['CONFIG']['class_prefix'];
2937
2938 $table = $table ? $table : substr($class,strlen($class_prefix));
2939
2940 // only include the file if it exists - and barf badly if it has parse errors :)
2941 if (!empty($_DB_DATAOBJECT['CONFIG']['proxy']) || empty($_DB_DATAOBJECT['CONFIG']['class_location'])) {
2942 return false;
2943 }
2944 // support for:
2945 // class_location = mydir/ => maps to mydir/Tablename.php
2946 // class_location = mydir/myfile_%s.php => maps to mydir/myfile_Tablename
2947 // with directory sepr
2948 // class_location = mydir/:mydir2/: => tries all of thes locations.
2949 $cl = $_DB_DATAOBJECT['CONFIG']['class_location'];
2950
2951
2952 switch (true) {
2953 case (strpos($cl ,'%s') !== false):
2954 $file = sprintf($cl , preg_replace('/[^A-Z0-9]/i','_',ucfirst($table)));
2955 break;
2956
2957 case (strpos($cl , PATH_SEPARATOR) !== false):
2958 $file = array();
2959 foreach(explode(PATH_SEPARATOR, $cl ) as $p) {
2960 $file[] = $p .'/'.preg_replace('/[^A-Z0-9]/i','_',ucfirst($table)).".php";
2961 }
2962 break;
2963 default:
2964 $file = $cl .'/'.preg_replace('/[^A-Z0-9]/i','_',ucfirst($table)).".php";
2965 break;
2966 }
2967
2968 $cls = is_array($class) ? $class : array($class);
2969
2970 if (is_array($file) || !file_exists($file)) {
2971 $found = false;
2972
2973 $file = is_array($file) ? $file : array($file);
2974 $search = implode(PATH_SEPARATOR, $file);
2975 foreach($file as $f) {
2976 foreach(explode(PATH_SEPARATOR, '' . PATH_SEPARATOR . ini_get('include_path')) as $p) {
2977 $ff = empty($p) ? $f : "$p/$f";
2978
2979 if (file_exists($ff)) {
2980 $file = $ff;
2981 $found = true;
2982 break;
2983 }
2984 }
2985 if ($found) {
2986 break;
2987 }
2988 }
2989 if (!$found) {
2990 $dor = new DB_DataObject();
2991 $dor->raiseError(
2992 "autoload:Could not find class " . implode(',', $cls) .
2993 " using class_location value :" . $search .
2994 " using include_path value :" . ini_get('include_path'),
2995 DB_DATAOBJECT_ERROR_INVALIDCONFIG);
2996 return false;
2997 }
2998 }
2999
3000 include_once $file;
3001
3002
3003 $ce = false;
3004 foreach($cls as $c) {
3005 $ce = substr(phpversion(),0,1) > 4 ? class_exists($c,false) : class_exists($c);
3006 if ($ce) {
3007 $class = $c;
3008 break;
3009 }
3010 }
3011 if (!$ce) {
3012 $dor = new DB_DataObject();
3013 $dor->raiseError(
3014 "autoload:Could not autoload " . implode(',', $cls) ,
3015 DB_DATAOBJECT_ERROR_INVALIDCONFIG);
3016 return false;
3017 }
3018 return $class;
3019 }
3020
3021
3022
3023 /**
3024 * Have the links been loaded?
3025 * if they have it contains a array of those variables.
3026 *
3027 * @access private
3028 * @var boolean | array
3029 */
3030 var $_link_loaded = false;
3031
3032 /**
3033 * Get the links associate array as defined by the links.ini file.
3034 *
3035 *
3036 * Experimental... -
3037 * Should look a bit like
3038 * [local_col_name] => "related_tablename:related_col_name"
3039 *
3040 * @param array $new_links optional - force update of the links for this table
3041 * You probably want to restore it to it's original state after,
3042 * as modifying here does it for the whole PHP request.
3043 *
3044 * @return array|null
3045 * array = if there are links defined for this table.
3046 * empty array - if there is a links.ini file, but no links on this table
3047 * false - if no links.ini exists for this database (hence try auto_links).
3048 * @access public
3049 * @see DB_DataObject::getLinks(), DB_DataObject::getLink()
3050 */
3051
3052 function links()
3053 {
3054 global $_DB_DATAOBJECT;
3055 if (empty($_DB_DATAOBJECT['CONFIG'])) {
3056 $this->_loadConfig();
3057 }
3058 // have to connect.. -> otherwise things break later.
3059 $this->_connect();
3060
3061 // alias for shorter code..
3062 $lcfg = &$_DB_DATAOBJECT['LINKS'];
3063 $cfg = $_DB_DATAOBJECT['CONFIG'];
3064
3065 if ($args = func_get_args()) {
3066 // an associative array was specified, that updates the current
3067 // schema... - be careful doing this
3068 if (empty( $lcfg[$this->_database])) {
3069 $lcfg[$this->_database] = array();
3070 }
3071 $lcfg[$this->_database][$this->tableName()] = $args[0];
3072
3073 }
3074 // loaded and available.
3075 if (isset($lcfg[$this->_database][$this->tableName()])) {
3076 return $lcfg[$this->_database][$this->tableName()];
3077 }
3078
3079 // loaded
3080 if (isset($lcfg[$this->_database])) {
3081 // either no file, or empty..
3082 return $lcfg[$this->_database] === false ? null : array();
3083 }
3084
3085 // links are same place as schema by default.
3086 $schemas = isset($cfg['schema_location']) ?
3087 array("{$cfg['schema_location']}/{$this->_database}.ini") :
3088 array() ;
3089
3090 // if ini_* is set look there instead.
3091 // and support multiple locations.
3092 if (isset($cfg["ini_{$this->_database}"])) {
3093 $schemas = is_array($cfg["ini_{$this->_database}"]) ?
3094 $cfg["ini_{$this->_database}"] :
3095 explode(PATH_SEPARATOR,$cfg["ini_{$this->_database}"]);
3096 }
3097
3098 // default to not available.
3099 $lcfg[$this->_database] = false;
3100
3101 foreach ($schemas as $ini) {
3102
3103 $links = isset($cfg["links_{$this->_database}"]) ?
3104 $cfg["links_{$this->_database}"] :
3105 str_replace('.ini','.links.ini',$ini);
3106
3107 // file really exists..
3108 if (!file_exists($links) || !is_file($links)) {
3109 if (!empty($cfg['debug'])) {
3110 $this->debug("Missing links.ini file: $links","links",1);
3111 }
3112 continue;
3113 }
3114
3115 // set to empty array - as we have at least one file now..
3116 $lcfg[$this->_database] = empty($lcfg[$this->_database]) ? array() : $lcfg[$this->_database];
3117
3118 // merge schema file into lcfg..
3119 $lcfg[$this->_database] = array_merge(
3120 $lcfg[$this->_database],
3121 parse_ini_file($links, true)
3122 );
3123
3124
3125 if (!empty($cfg['debug'])) {
3126 $this->debug("Loaded links.ini file: $links","links",1);
3127 }
3128
3129 }
3130
3131 if (!empty($_DB_DATAOBJECT['CONFIG']['portability']) && $_DB_DATAOBJECT['CONFIG']['portability'] & 1) {
3132 foreach($lcfg[$this->_database] as $k=>$v) {
3133
3134 $nk = strtolower($k);
3135 // results in duplicate cols.. but not a big issue..
3136 $lcfg[$this->_database][$nk] = isset($lcfg[$this->_database][$nk])
3137 ? $lcfg[$this->_database][$nk] : array();
3138
3139 foreach($v as $kk =>$vv) {
3140 //var_Dump($vv);exit;
3141 $vv =explode(':', $vv);
3142 $vv[0] = strtolower($vv[0]);
3143 $lcfg[$this->_database][$nk][$kk] = implode(':', $vv);
3144 }
3145
3146
3147 }
3148 }
3149 //echo '<PRE>';print_r($lcfg);exit;
3150
3151 // if there is no link data at all on the file!
3152 // we return null.
3153 if ($lcfg[$this->_database] === false) {
3154 return null;
3155 }
3156
3157 if (isset($lcfg[$this->_database][$this->tableName()])) {
3158 return $lcfg[$this->_database][$this->tableName()];
3159 }
3160
3161 return array();
3162 }
3163
3164
3165 /**
3166 * generic getter/setter for links
3167 *
3168 * This is the new 'recommended' way to get get/set linked objects.
3169 * must be used with links.ini
3170 *
3171 * usage:
3172 * get:
3173 * $obj = $do->link('company_id');
3174 * $obj = $do->link(array('local_col', 'linktable:linked_col'));
3175 *
3176 * set:
3177 * $do->link('company_id',0);
3178 * $do->link('company_id',$obj);
3179 * $do->link('company_id', array($obj));
3180 *
3181 * example function
3182 *
3183 * function company() {
3184 * $this->link(array('company_id','company:id'), func_get_args());
3185 * }
3186 *
3187 *
3188 *
3189 * @param mixed $link_spec link specification (normally a string)
3190 * uses similar rules to joinAdd() array argument.
3191 * @param mixed $set_value (optional) int, DataObject, or array('set')
3192 * @author Alan Knowles
3193 * @access public
3194 * @return mixed true or false on setting, object on getting
3195 */
3196 function link($field, $set_args = array())
3197 {
3198 require_once 'DB/DataObject/Links.php';
3199 $l = new DB_DataObject_Links($this);
3200 return $l->link($field,$set_args) ;
3201
3202 }
3203
3204 /**
3205 * load related objects
3206 *
3207 * Generally not recommended to use this.
3208 * The generator should support creating getter_setter methods which are better suited.
3209 *
3210 * Relies on <dbname>.links.ini
3211 *
3212 * Sets properties on the calling dataobject you can change what
3213 * object vars the links are stored in by changeing the format parameter
3214 *
3215 *
3216 * @param string format (default _%s) where %s is the table name.
3217 * @author Tim White <tim@cyface.com>
3218 * @access public
3219 * @return boolean , true on success
3220 */
3221 function getLinks($format = '_%s')
3222 {
3223 require_once 'DB/DataObject/Links.php';
3224 $l = new DB_DataObject_Links($this);
3225 return $l->applyLinks($format);
3226
3227 }
3228
3229 /**
3230 * deprecited : @use link()
3231 */
3232 function getLink($row, $table = null, $link = false)
3233 {
3234 require_once 'DB/DataObject/Links.php';
3235 $l = new DB_DataObject_Links($this);
3236 return $l->getLink($row, $table === null ? false: $table, $link);
3237
3238
3239 }
3240
3241 /**
3242 * getLinkArray
3243 * Fetch an array of related objects. This should be used in conjunction with a <dbname>.links.ini file configuration (see the introduction on linking for details on this).
3244 * You may also use this with all parameters to specify, the column and related table.
3245 * This is highly dependant on naming columns 'correctly' :)
3246 * using colname = xxxxx_yyyyyy
3247 * xxxxxx = related table; (yyyyy = user defined..)
3248 * looks up table xxxxx, for value id=$this->xxxxx
3249 * stores it in $this->_xxxxx_yyyyy
3250 *
3251 * @access public
3252 * @param string $column - either column or column.xxxxx
3253 * @param string $table - name of table to look up value in
3254 * @return array - array of results (empty array on failure)
3255 *
3256 * Example - Getting the related objects
3257 *
3258 * $person = new DataObjects_Person;
3259 * $person->get(12);
3260 * $children = $person->getLinkArray('children');
3261 *
3262 * echo 'There are ', count($children), ' descendant(s):<br />';
3263 * foreach ($children as $child) {
3264 * echo $child->name, '<br />';
3265 * }
3266 *
3267 */
3268 function getLinkArray($row, $table = null)
3269 {
3270 require_once 'DB/DataObject/Links.php';
3271 $l = new DB_DataObject_Links($this);
3272 return $l->getLinkArray($row, $table === null ? false: $table);
3273
3274 }
3275
3276 /**
3277 * unionAdd - adds another dataobject to this, building a unioned query.
3278 *
3279 * usage:
3280 * $doTable1 = DB_DataObject::factory("table1");
3281 * $doTable2 = DB_DataObject::factory("table2");
3282 *
3283 * $doTable1->selectAdd();
3284 * $doTable1->selectAdd("col1,col2");
3285 * $doTable1->whereAdd("col1 > 100");
3286 * $doTable1->orderBy("col1");
3287 *
3288 * $doTable2->selectAdd();
3289 * $doTable2->selectAdd("col1, col2");
3290 * $doTable2->whereAdd("col2 = 'v'");
3291 *
3292 * $doTable1->unionAdd($doTable2);
3293 * $doTable1->find();
3294 *
3295 * Note: this model may be a better way to implement joinAdd?, eg. do the building in find?
3296 *
3297 *
3298 * @param $obj object|false the union object or false to reset
3299 * @param optional $is_all string 'ALL' to do all.
3300 * @returns $obj object|array the added object, or old list if reset.
3301 */
3302
3303 function unionAdd($obj,$is_all= '')
3304 {
3305 if ($obj === false) {
3306 $ret = $this->_query['unions'];
3307 $this->_query['unions'] = array();
3308 return $ret;
3309 }
3310 $this->_query['unions'][] = array($obj, 'UNION ' . $is_all . ' ') ;
3311 return $obj;
3312 }
3313
3314
3315
3316 /**
3317 * The JOIN condition
3318 *
3319 * @access private
3320 * @var string
3321 */
3322 var $_join = '';
3323
3324 /**
3325 * joinAdd - adds another dataobject to this, building a joined query.
3326 *
3327 * example (requires links.ini to be set up correctly)
3328 * // get all the images for product 24
3329 * $i = new DataObject_Image();
3330 * $pi = new DataObjects_Product_image();
3331 * $pi->product_id = 24; // set the product id to 24
3332 * $i->joinAdd($pi); // add the product_image connectoin
3333 * $i->find();
3334 * while ($i->fetch()) {
3335 * // do stuff
3336 * }
3337 * // an example with 2 joins
3338 * // get all the images linked with products or productgroups
3339 * $i = new DataObject_Image();
3340 * $pi = new DataObject_Product_image();
3341 * $pgi = new DataObject_Productgroup_image();
3342 * $i->joinAdd($pi);
3343 * $i->joinAdd($pgi);
3344 * $i->find();
3345 * while ($i->fetch()) {
3346 * // do stuff
3347 * }
3348 *
3349 *
3350 * @param optional $obj object |array the joining object (no value resets the join)
3351 * If you use an array here it should be in the format:
3352 * array('local_column','remotetable:remote_column');
3353 * if remotetable does not have a definition, you should
3354 * use @ to hide the include error message..
3355 * array('local_column', $dataobject , 'remote_column');
3356 * if array has 3 args, then second is assumed to be the linked dataobject.
3357 *
3358 * @param optional $joinType string | array
3359 * 'LEFT'|'INNER'|'RIGHT'|'' Inner is default, '' indicates
3360 * just select ... from a,b,c with no join and
3361 * links are added as where items.
3362 *
3363 * If second Argument is array, it is assumed to be an associative
3364 * array with arguments matching below = eg.
3365 * 'joinType' => 'INNER',
3366 * 'joinAs' => '...'
3367 * 'joinCol' => ....
3368 * 'useWhereAsOn' => false,
3369 *
3370 * @param optional $joinAs string if you want to select the table as anther name
3371 * useful when you want to select multiple columsn
3372 * from a secondary table.
3373
3374 * @param optional $joinCol string The column on This objects table to match (needed
3375 * if this table links to the child object in
3376 * multiple places eg.
3377 * user->friend (is a link to another user)
3378 * user->mother (is a link to another user..)
3379 *
3380 * optional 'useWhereAsOn' bool default false;
3381 * convert the where argments from the object being added
3382 * into ON arguments.
3383 *
3384 *
3385 * @return none
3386 * @access public
3387 * @author Stijn de Reede <sjr@gmx.co.uk>
3388 */
3389 function joinAdd($obj = false, $joinType='INNER', $joinAs=false, $joinCol=false)
3390 {
3391 global $_DB_DATAOBJECT;
3392 if ($obj === false) {
3393 $this->_join = '';
3394 return;
3395 }
3396
3397 //echo '<PRE>'; print_r(func_get_args());
3398 $useWhereAsOn = false;
3399 // support for 2nd argument as an array of options
3400 if (is_array($joinType)) {
3401 // new options can now go in here... (dont forget to document them)
3402 $useWhereAsOn = !empty($joinType['useWhereAsOn']);
3403 $joinCol = isset($joinType['joinCol']) ? $joinType['joinCol'] : $joinCol;
3404 $joinAs = isset($joinType['joinAs']) ? $joinType['joinAs'] : $joinAs;
3405 $joinType = isset($joinType['joinType']) ? $joinType['joinType'] : 'INNER';
3406 }
3407 // support for array as first argument
3408 // this assumes that you dont have a links.ini for the specified table.
3409 // and it doesnt exist as am extended dataobject!! - experimental.
3410
3411 $ofield = false; // object field
3412 $tfield = false; // this field
3413 $toTable = false;
3414 if (is_array($obj)) {
3415 $tfield = $obj[0];
3416
3417 if (count($obj) == 3) {
3418 $ofield = $obj[2];
3419 $obj = $obj[1];
3420 } else {
3421 list($toTable,$ofield) = explode(':',$obj[1]);
3422
3423 $obj = is_string($toTable) ? DB_DataObject::factory($toTable) : $toTable;
3424
3425 if (!$obj || !is_object($obj) || is_a($obj,'PEAR_Error')) {
3426 $obj = new DB_DataObject;
3427 $obj->__table = $toTable;
3428 }
3429 $obj->_connect();
3430 }
3431 // set the table items to nothing.. - eg. do not try and match
3432 // things in the child table...???
3433 $items = array();
3434 }
3435
3436 if (!is_object($obj) || !is_a($obj,'DB_DataObject')) {
3437 return $this->raiseError("joinAdd: called without an object", DB_DATAOBJECT_ERROR_NODATA,PEAR_ERROR_DIE);
3438 }
3439 /* make sure $this->_database is set. */
3440 $this->_connect();
3441 $DB = $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
3442
3443
3444 /// CHANGED 26 JUN 2009 - we prefer links from our local table over the remote one.
3445
3446 /* otherwise see if there are any links from this table to the obj. */
3447 //print_r($this->links());
3448 if (($ofield === false) && ($links = $this->links())) {
3449 // this enables for support for arrays of links in ini file.
3450 // link contains this_column[] = linked_table:linked_column
3451 // or standard way.
3452 // link contains this_column = linked_table:linked_column
3453 foreach ($links as $k => $linkVar) {
3454
3455 if (!is_array($linkVar)) {
3456 $linkVar = array($linkVar);
3457 }
3458 foreach($linkVar as $v) {
3459
3460
3461
3462 /* link contains {this column} = {linked table}:{linked column} */
3463 $ar = explode(':', $v);
3464 // Feature Request #4266 - Allow joins with multiple keys
3465 if (strpos($k, ',') !== false) {
3466 $k = explode(',', $k);
3467 }
3468 if (strpos($ar[1], ',') !== false) {
3469 $ar[1] = explode(',', $ar[1]);
3470 }
3471
3472 if ($ar[0] != $obj->tableName()) {
3473 continue;
3474 }
3475 if ($joinCol !== false) {
3476 if ($k == $joinCol) {
3477 // got it!?
3478 $tfield = $k;
3479 $ofield = $ar[1];
3480 break;
3481 }
3482 continue;
3483
3484 }
3485 $tfield = $k;
3486 $ofield = $ar[1];
3487 break;
3488
3489 }
3490 }
3491 }
3492 /* look up the links for obj table */
3493 //print_r($obj->links());
3494 if (!$ofield && ($olinks = $obj->links())) {
3495
3496 foreach ($olinks as $k => $linkVar) {
3497 /* link contains {this column} = array ( {linked table}:{linked column} )*/
3498 if (!is_array($linkVar)) {
3499 $linkVar = array($linkVar);
3500 }
3501 foreach($linkVar as $v) {
3502
3503 /* link contains {this column} = {linked table}:{linked column} */
3504 $ar = explode(':', $v);
3505
3506 // Feature Request #4266 - Allow joins with multiple keys
3507 $links_key_array = strpos($k,',');
3508 if ($links_key_array !== false) {
3509 $k = explode(',', $k);
3510 }
3511
3512 $ar_array = strpos($ar[1],',');
3513 if ($ar_array !== false) {
3514 $ar[1] = explode(',', $ar[1]);
3515 }
3516
3517 if ($ar[0] != $this->tableName()) {
3518 continue;
3519 }
3520
3521 // you have explictly specified the column
3522 // and the col is listed here..
3523 // not sure if 1:1 table could cause probs here..
3524
3525 if ($joinCol !== false) {
3526 $this->raiseError(
3527 "joinAdd: You cannot target a join column in the " .
3528 "'link from' table ({$obj->__table}). " .
3529 "Either remove the fourth argument to joinAdd() ".
3530 "({$joinCol}), or alter your links.ini file.",
3531 DB_DATAOBJECT_ERROR_NODATA);
3532 return false;
3533 }
3534
3535 $ofield = $k;
3536 $tfield = $ar[1];
3537 break;
3538
3539 }
3540 }
3541 }
3542
3543 // finally if these two table have column names that match do a join by default on them
3544
3545 if (($ofield === false) && $joinCol) {
3546 $ofield = $joinCol;
3547 $tfield = $joinCol;
3548
3549 }
3550 /* did I find a conneciton between them? */
3551
3552 if ($ofield === false) {
3553 $this->raiseError(
3554 "joinAdd: {$obj->tableName()} has no link with {$this->tableName()}",
3555 DB_DATAOBJECT_ERROR_NODATA);
3556 return false;
3557 }
3558 $joinType = strtoupper($joinType);
3559
3560 // we default to joining as the same name (this is remvoed later..)
3561
3562 if ($joinAs === false) {
3563 $joinAs = $obj->tableName();
3564 }
3565
3566 $quoteIdentifiers = !empty($_DB_DATAOBJECT['CONFIG']['quote_identifiers']);
3567 $options = $_DB_DATAOBJECT['CONFIG'];
3568
3569 // not sure how portable adding database prefixes is..
3570 $objTable = $quoteIdentifiers ?
3571 $DB->quoteIdentifier($obj->tableName()) :
3572 $obj->tableName() ;
3573
3574 $dbPrefix = '';
3575 if (strlen($obj->_database) && in_array($DB->dsn['phptype'],array('mysql','mysqli'))) {
3576 $dbPrefix = ($quoteIdentifiers
3577 ? $DB->quoteIdentifier($obj->_database)
3578 : $obj->_database) . '.';
3579 }
3580
3581 // if they are the same, then dont add a prefix...
3582 if ($obj->_database == $this->_database) {
3583 $dbPrefix = '';
3584 }
3585 // as far as we know only mysql supports database prefixes..
3586 // prefixing the database name is now the default behaviour,
3587 // as it enables joining mutiple columns from multiple databases...
3588
3589 // prefix database (quoted if neccessary..)
3590 $objTable = $dbPrefix . $objTable;
3591
3592 $cond = '';
3593
3594 // if obj only a dataobject - eg. no extended class has been defined..
3595 // it obvioulsy cant work out what child elements might exist...
3596 // until we get on the fly querying of tables..
3597 // note: we have already checked that it is_a(db_dataobject earlier)
3598 if ( strtolower(get_class($obj)) != 'db_dataobject') {
3599
3600 // now add where conditions for anything that is set in the object
3601
3602
3603
3604 $items = $obj->table();
3605 // will return an array if no items..
3606
3607 // only fail if we where expecting it to work (eg. not joined on a array)
3608
3609 if (!$items) {
3610 $this->raiseError(
3611 "joinAdd: No table definition for {$obj->__table}",
3612 DB_DATAOBJECT_ERROR_INVALIDCONFIG);
3613 return false;
3614 }
3615
3616 $ignore_null = !isset($options['disable_null_strings'])
3617 || !is_string($options['disable_null_strings'])
3618 || strtolower($options['disable_null_strings']) !== 'full' ;
3619
3620
3621 foreach($items as $k => $v) {
3622 if (!isset($obj->$k) && $ignore_null) {
3623 continue;
3624 }
3625
3626 $kSql = ($quoteIdentifiers ? $DB->quoteIdentifier($k) : $k);
3627
3628 if (DB_DataObject::_is_null($obj,$k)) {
3629 $obj->whereAdd("{$joinAs}.{$kSql} IS NULL");
3630 continue;
3631 }
3632
3633 if ($v & DB_DATAOBJECT_STR) {
3634 $obj->whereAdd("{$joinAs}.{$kSql} = " . $this->_quote((string) (
3635 ($v & DB_DATAOBJECT_BOOL) ?
3636 // this is thanks to the braindead idea of postgres to
3637 // use t/f for boolean.
3638 (($obj->$k === 'f') ? 0 : (int)(bool) $obj->$k) :
3639 $obj->$k
3640 )));
3641 continue;
3642 }
3643 if (is_numeric($obj->$k)) {
3644 $obj->whereAdd("{$joinAs}.{$kSql} = {$obj->$k}");
3645 continue;
3646 }
3647
3648 if (is_object($obj->$k) && is_a($obj->$k,'DB_DataObject_Cast')) {
3649 $value = $obj->$k->toString($v,$DB);
3650 if (is_a($value, 'PEAR_Error')) {
3651 $this->raiseError($value->getMessage() ,DB_DATAOBJECT_ERROR_INVALIDARG);
3652 return false;
3653 }
3654 $obj->whereAdd("{$joinAs}.{$kSql} = $value");
3655 continue;
3656 }
3657
3658
3659 /* this is probably an error condition! */
3660 $obj->whereAdd("{$joinAs}.{$kSql} = 0");
3661 }
3662 if ($this->_query === false) {
3663 $this->raiseError(
3664 "joinAdd can not be run from a object that has had a query run on it,
3665 clone the object or create a new one and use setFrom()",
3666 DB_DATAOBJECT_ERROR_INVALIDARGS);
3667 return false;
3668 }
3669 }
3670
3671 // and finally merge the whereAdd from the child..
3672 if ($obj->_query['condition']) {
3673 $cond = preg_replace('/^\sWHERE/i','',$obj->_query['condition']);
3674
3675 if (!$useWhereAsOn) {
3676 $this->whereAdd($cond);
3677 }
3678 }
3679
3680
3681
3682
3683 // nested (join of joined objects..)
3684 $appendJoin = '';
3685 if ($obj->_join) {
3686 // postgres allows nested queries, with ()'s
3687 // not sure what the results are with other databases..
3688 // may be unpredictable..
3689 if (in_array($DB->dsn["phptype"],array('pgsql'))) {
3690 $objTable = "($objTable {$obj->_join})";
3691 } else {
3692 $appendJoin = $obj->_join;
3693 }
3694 }
3695
3696
3697 // fix for #2216
3698 // add the joinee object's conditions to the ON clause instead of the WHERE clause
3699 if ($useWhereAsOn && strlen($cond)) {
3700 $appendJoin = ' AND ' . $cond . ' ' . $appendJoin;
3701 }
3702
3703
3704
3705 $table = $this->tableName();
3706
3707 if ($quoteIdentifiers) {
3708 $joinAs = $DB->quoteIdentifier($joinAs);
3709 $table = $DB->quoteIdentifier($table);
3710 $ofield = (is_array($ofield)) ? array_map(array($DB, 'quoteIdentifier'), $ofield) : $DB->quoteIdentifier($ofield);
3711 $tfield = (is_array($tfield)) ? array_map(array($DB, 'quoteIdentifier'), $tfield) : $DB->quoteIdentifier($tfield);
3712 }
3713 // add database prefix if they are different databases
3714
3715
3716 $fullJoinAs = '';
3717 $addJoinAs = ($quoteIdentifiers ? $DB->quoteIdentifier($obj->tableName()) : $obj->tableName()) != $joinAs;
3718 if ($addJoinAs) {
3719 // join table a AS b - is only supported by a few databases and is probably not needed
3720 // , however since it makes the whole Statement alot clearer we are leaving it in
3721 // for those databases.
3722 $fullJoinAs = in_array($DB->dsn["phptype"],array('mysql','mysqli','pgsql')) ? "AS {$joinAs}" : $joinAs;
3723 } else {
3724 // if
3725 $joinAs = $dbPrefix . $joinAs;
3726 }
3727
3728
3729 switch ($joinType) {
3730 case 'INNER':
3731 case 'LEFT':
3732 case 'RIGHT': // others??? .. cross, left outer, right outer, natural..?
3733
3734 // Feature Request #4266 - Allow joins with multiple keys
3735 $jadd = "\n {$joinType} JOIN {$objTable} {$fullJoinAs}";
3736 //$this->_join .= "\n {$joinType} JOIN {$objTable} {$fullJoinAs}";
3737 if (is_array($ofield)) {
3738 $key_count = count($ofield);
3739 for($i = 0; $i < $key_count; $i++) {
3740 if ($i == 0) {
3741 $jadd .= " ON ({$joinAs}.{$ofield[$i]}={$table}.{$tfield[$i]}) ";
3742 }
3743 else {
3744 $jadd .= " AND {$joinAs}.{$ofield[$i]}={$table}.{$tfield[$i]} ";
3745 }
3746 }
3747 $jadd .= ' ' . $appendJoin . ' ';
3748 } else {
3749 $jadd .= " ON ({$joinAs}.{$ofield}={$table}.{$tfield}) {$appendJoin} ";
3750 }
3751 // jadd avaliable for debugging join build.
3752 //echo $jadd ."\n";
3753 $this->_join .= $jadd;
3754 break;
3755
3756 case '': // this is just a standard multitable select..
3757 $this->_join .= "\n , {$objTable} {$fullJoinAs} {$appendJoin}";
3758 $this->whereAdd("{$joinAs}.{$ofield}={$table}.{$tfield}");
3759 }
3760
3761
3762 return true;
3763
3764 }
3765
3766 /**
3767 * autoJoin - using the links.ini file, it builds a query with all the joins
3768 * usage:
3769 * $x = DB_DataObject::factory('mytable');
3770 * $x->autoJoin();
3771 * $x->get(123);
3772 * will result in all of the joined data being added to the fetched object..
3773 *
3774 * $x = DB_DataObject::factory('mytable');
3775 * $x->autoJoin();
3776 * $ar = $x->fetchAll();
3777 * will result in an array containing all the data from the table, and any joined tables..
3778 *
3779 * $x = DB_DataObject::factory('mytable');
3780 * $jdata = $x->autoJoin();
3781 * $x->selectAdd(); //reset..
3782 * foreach($_REQUEST['requested_cols'] as $c) {
3783 * if (!isset($jdata[$c])) continue; // ignore columns not available..
3784 * $x->selectAdd( $jdata[$c] . ' as ' . $c);
3785 * }
3786 * $ar = $x->fetchAll();
3787 * will result in only the columns requested being fetched...
3788 *
3789 *
3790 *
3791 * @param array Configuration
3792 * exclude Array of columns to exclude from results (eg. modified_by_id)
3793 * links The equivilant links.ini data for this table eg.
3794 * array( 'person_id' => 'person:id', .... )
3795 * include Array of columns to include
3796 * distinct Array of distinct columns.
3797 *
3798 * @return array info about joins
3799 * cols => map of resulting {joined_tablename}.{joined_table_column_name}
3800 * join_names => map of resulting {join_name_as}.{joined_table_column_name}
3801 * count => the column to count on.
3802 * @access public
3803 */
3804 function autoJoin($cfg = array())
3805 {
3806 //var_Dump($cfg);exit;
3807 $pre_links = $this->links();
3808 if (!empty($cfg['links'])) {
3809 $this->links(array_merge( $pre_links , $cfg['links']));
3810 }
3811 $map = $this->links( );
3812
3813
3814 //print_r($map);
3815 $tabdef = $this->table();
3816
3817 // we need this as normally it's only cleared by an empty selectAs call.
3818
3819
3820 $keys = array_keys($tabdef);
3821 if (!empty($cfg['exclude'])) {
3822 $keys = array_intersect($keys, array_diff($keys, $cfg['exclude']));
3823 }
3824 if (!empty($cfg['include'])) {
3825
3826 $keys = array_intersect($keys, $cfg['include']);
3827 }
3828
3829 $selectAs = array();
3830
3831 if (!empty($keys)) {
3832 $selectAs = array(array( $keys , '%s', false));
3833 }
3834
3835 $ret = array(
3836 'cols' => array(),
3837 'join_names' => array(),
3838 'count' => false,
3839 );
3840
3841
3842
3843 $has_distinct = false;
3844 if (!empty($cfg['distinct']) && $keys) {
3845
3846 // reset the columsn?
3847 $cols = array();
3848
3849 //echo '<PRE>' ;print_r($xx);exit;
3850 foreach($keys as $c) {
3851 //var_dump($c);
3852
3853 if ( $cfg['distinct'] == $c) {
3854 $has_distinct = 'DISTINCT( ' . $this->tableName() .'.'. $c .') as ' . $c;
3855 $ret['count'] = 'DISTINCT ' . $this->tableName() .'.'. $c .'';
3856 continue;
3857 }
3858 // cols is in our filtered keys...
3859 $cols = $c;
3860
3861 }
3862 // apply our filtered version, which excludes the distinct column.
3863
3864 $selectAs = empty($cols) ? array() : array(array(array( $cols) , '%s', false)) ;
3865
3866
3867
3868 }
3869
3870 foreach($keys as $k) {
3871 $ret['cols'][$k] = $this->tableName(). '.' . $k;
3872 }
3873
3874
3875
3876 foreach($map as $ocl=>$info) {
3877
3878 list($tab,$col) = explode(':', $info);
3879 // what about multiple joins on the same table!!!
3880 $xx = DB_DataObject::factory($tab);
3881 if (!is_object($xx) || !is_a($xx, 'DB_DataObject')) {
3882 continue;
3883 }
3884 // skip columns that are excluded.
3885
3886 // we ignore include here... - as
3887
3888 // this is borked ... for multiple jions..
3889 $this->joinAdd($xx, 'LEFT', 'join_'.$ocl.'_'. $col, $ocl);
3890
3891 if (!empty($cfg['exclude']) && in_array($ocl, $cfg['exclude'])) {
3892 continue;
3893 }
3894
3895 $tabdef = $xx->table();
3896 $table = $xx->tableName();
3897
3898 $keys = array_keys($tabdef);
3899
3900
3901 if (!empty($cfg['exclude'])) {
3902 $keys = array_intersect($keys, array_diff($keys, $cfg['exclude']));
3903
3904 foreach($keys as $k) {
3905 if (in_array($ocl.'_'.$k, $cfg['exclude'])) {
3906 $keys = array_diff($keys, $k); // removes the k..
3907 }
3908 }
3909
3910 }
3911
3912 if (!empty($cfg['include'])) {
3913 // include will basically be BASECOLNAME_joinedcolname
3914 $nkeys = array();
3915 foreach($keys as $k) {
3916 if (in_array( sprintf($ocl.'_%s', $k), $cfg['include'])) {
3917 $nkeys[] = $k;
3918 }
3919 }
3920 $keys = $nkeys;
3921 }
3922
3923 if (empty($keys)) {
3924 continue;
3925 }
3926 // got distinct, and not yet found it..
3927 if (!$has_distinct && !empty($cfg['distinct'])) {
3928 $cols = array();
3929 foreach($keys as $c) {
3930 $tn = sprintf($ocl.'_%s', $c);
3931
3932 if ( $tn == $cfg['distinct']) {
3933
3934 $has_distinct = 'DISTINCT( ' . 'join_'.$ocl.'_'.$col.'.'.$c .') as ' . $tn ;
3935 $ret['count'] = 'DISTINCT join_'.$ocl.'_'.$col.'.'.$c;
3936 // var_dump($this->countWhat );
3937 continue;
3938 }
3939 $cols[] = $c;
3940
3941 }
3942
3943 if (!empty($cols)) {
3944 $selectAs[] = array($cols, $ocl.'_%s', 'join_'.$ocl.'_'. $col);
3945 }
3946
3947 } else {
3948 $selectAs[] = array($keys, $ocl.'_%s', 'join_'.$ocl.'_'. $col);
3949 }
3950
3951 foreach($keys as $k) {
3952 $ret['cols'][sprintf('%s_%s', $ocl, $k)] = $tab.'.'.$k;
3953 $ret['join_names'][sprintf('%s_%s', $ocl, $k)] = sprintf('join_%s_%s.%s',$ocl, $col, $k);
3954 }
3955
3956 }
3957
3958 // fill in the select details..
3959 $this->selectAdd();
3960
3961 if ($has_distinct) {
3962 $this->selectAdd($has_distinct);
3963 }
3964
3965 foreach($selectAs as $ar) {
3966 $this->selectAs($ar[0], $ar[1], $ar[2]);
3967 }
3968 // restore links..
3969 $this->links( $pre_links );
3970
3971 return $ret;
3972
3973 }
3974
3975 /**
3976 * Factory method for calling DB_DataObject_Cast
3977 *
3978 * if used with 1 argument DB_DataObject_Cast::sql($value) is called
3979 *
3980 * if used with 2 arguments DB_DataObject_Cast::$value($callvalue) is called
3981 * valid first arguments are: blob, string, date, sql
3982 *
3983 * eg. $member->updated = $member->sqlValue('NOW()');
3984 *
3985 *
3986 * might handle more arguments for escaping later...
3987 *
3988 *
3989 * @param string $value (or type if used with 2 arguments)
3990 * @param string $callvalue (optional) used with date/null etc..
3991 */
3992
3993 function sqlValue($value)
3994 {
3995 $method = 'sql';
3996 if (func_num_args() == 2) {
3997 $method = $value;
3998 $value = func_get_arg(1);
3999 }
4000 require_once 'DB/DataObject/Cast.php';
4001 return call_user_func(array('DB_DataObject_Cast', $method), $value);
4002
4003 }
4004
4005
4006 /**
4007 * Copies items that are in the table definitions from an
4008 * array or object into the current object
4009 * will not override key values.
4010 *
4011 *
4012 * @param array | object $from
4013 * @param string $format eg. map xxxx_name to $object->name using 'xxxx_%s' (defaults to %s - eg. name -> $object->name
4014 * @param boolean $skipEmpty (dont assign empty values if a column is empty (eg. '' / 0 etc...)
4015 * @access public
4016 * @return true on success or array of key=>setValue error message
4017 */
4018 function setFrom($from, $format = '%s', $skipEmpty=false)
4019 {
4020 global $_DB_DATAOBJECT;
4021 $keys = $this->keys();
4022 $items = $this->table();
4023
4024 if (!$items) {
4025 $this->raiseError(
4026 "setFrom:Could not find table definition for {$this->tableName()}",
4027 DB_DATAOBJECT_ERROR_INVALIDCONFIG);
4028 return;
4029 }
4030 $overload_return = array();
4031 foreach (array_keys($items) as $k) {
4032 if (in_array($k,$keys)) {
4033 continue; // dont overwrite keys
4034 }
4035 if (!$k) {
4036 continue; // ignore empty keys!!! what
4037 }
4038
4039 $chk = is_object($from) &&
4040 (version_compare(phpversion(), "5.1.0" , ">=") ?
4041 property_exists($from, sprintf($format,$k)) : // php5.1
4042 array_key_exists( sprintf($format,$k), get_class_vars($from)) //older
4043 );
4044 // if from has property ($format($k)
4045 if ($chk) {
4046 $kk = (strtolower($k) == 'from') ? '_from' : $k;
4047 if (method_exists($this,'set'.$kk)) {
4048 $ret = $this->{'set'.$kk}($from->{sprintf($format,$k)});
4049 if (is_string($ret)) {
4050 $overload_return[$k] = $ret;
4051 }
4052 continue;
4053 }
4054 $this->$k = $from->{sprintf($format,$k)};
4055 continue;
4056 }
4057
4058 if (is_object($from)) {
4059 continue;
4060 }
4061
4062 if (empty($from[sprintf($format,$k)]) && $skipEmpty) {
4063 continue;
4064 }
4065
4066 if (!isset($from[sprintf($format,$k)]) && !DB_DataObject::_is_null($from, sprintf($format,$k))) {
4067 continue;
4068 }
4069
4070 $kk = (strtolower($k) == 'from') ? '_from' : $k;
4071 if (method_exists($this,'set'. $kk)) {
4072 $ret = $this->{'set'.$kk}($from[sprintf($format,$k)]);
4073 if (is_string($ret)) {
4074 $overload_return[$k] = $ret;
4075 }
4076 continue;
4077 }
4078 $val = $from[sprintf($format,$k)];
4079 if (is_a($val, 'DB_DataObject_Cast')) {
4080 $this->$k = $val;
4081 continue;
4082 }
4083 if (is_object($val) || is_array($val)) {
4084 continue;
4085 }
4086 $ret = $this->fromValue($k,$val);
4087 if ($ret !== true) {
4088 $overload_return[$k] = 'Not A Valid Value';
4089 }
4090 //$this->$k = $from[sprintf($format,$k)];
4091 }
4092 if ($overload_return) {
4093 return $overload_return;
4094 }
4095 return true;
4096 }
4097
4098 /**
4099 * Returns an associative array from the current data
4100 * (kind of oblivates the idea behind DataObjects, but
4101 * is usefull if you use it with things like QuickForms.
4102 *
4103 * you can use the format to return things like user[key]
4104 * by sending it $object->toArray('user[%s]')
4105 *
4106 * will also return links converted to arrays.
4107 *
4108 * @param string sprintf format for array
4109 * @param bool||number [true = elemnts that have a value set],
4110 * [false = table + returned colums] ,
4111 * [0 = returned columsn only]
4112 *
4113 * @access public
4114 * @return array of key => value for row
4115 */
4116
4117 function toArray($format = '%s', $hideEmpty = false)
4118 {
4119 global $_DB_DATAOBJECT;
4120
4121 // we use false to ignore sprintf.. (speed up..)
4122 $format = $format == '%s' ? false : $format;
4123
4124 $ret = array();
4125 $rf = ($this->_resultFields !== false) ? $this->_resultFields :
4126 (isset($_DB_DATAOBJECT['RESULTFIELDS'][$this->_DB_resultid]) ?
4127 $_DB_DATAOBJECT['RESULTFIELDS'][$this->_DB_resultid] : false);
4128
4129 $ar = ($rf !== false) ?
4130 (($hideEmpty === 0) ? $rf : array_merge($rf, $this->table())) :
4131 $this->table();
4132
4133 foreach($ar as $k=>$v) {
4134
4135 if (!isset($this->$k)) {
4136 if (!$hideEmpty) {
4137 $ret[$format === false ? $k : sprintf($format,$k)] = '';
4138 }
4139 continue;
4140 }
4141 // call the overloaded getXXXX() method. - except getLink and getLinks
4142 if (method_exists($this,'get'.$k) && !in_array(strtolower($k),array('links','link'))) {
4143 $ret[$format === false ? $k : sprintf($format,$k)] = $this->{'get'.$k}();
4144 continue;
4145 }
4146 // should this call toValue() ???
4147 $ret[$format === false ? $k : sprintf($format,$k)] = $this->$k;
4148 }
4149 if (!$this->_link_loaded) {
4150 return $ret;
4151 }
4152 foreach($this->_link_loaded as $k) {
4153 $ret[$format === false ? $k : sprintf($format,$k)] = $this->$k->toArray();
4154
4155 }
4156
4157 return $ret;
4158 }
4159
4160 /**
4161 * validate the values of the object (usually prior to inserting/updating..)
4162 *
4163 * Note: This was always intended as a simple validation routine.
4164 * It lacks understanding of field length, whether you are inserting or updating (and hence null key values)
4165 *
4166 * This should be moved to another class: DB_DataObject_Validate
4167 * FEEL FREE TO SEND ME YOUR VERSION FOR CONSIDERATION!!!
4168 *
4169 * Usage:
4170 * if (is_array($ret = $obj->validate())) { ... there are problems with the data ... }
4171 *
4172 * Logic:
4173 * - defaults to only testing strings/numbers if numbers or strings are the correct type and null values are correct
4174 * - validate Column methods : "validate{ROWNAME}()" are called if they are defined.
4175 * These methods should return
4176 * true = everything ok
4177 * false|object = something is wrong!
4178 *
4179 * - This method loads and uses the PEAR Validate Class.
4180 *
4181 *
4182 * @access public
4183 * @return array of validation results (where key=>value, value=false|object if it failed) or true (if they all succeeded)
4184 */
4185 function validate()
4186 {
4187 global $_DB_DATAOBJECT;
4188 require_once 'Validate.php';
4189 $table = $this->table();
4190 $ret = array();
4191 $seq = $this->sequenceKey();
4192 $options = $_DB_DATAOBJECT['CONFIG'];
4193 foreach($table as $key => $val) {
4194
4195
4196 // call user defined validation always...
4197 $method = "Validate" . ucfirst($key);
4198 if (method_exists($this, $method)) {
4199 $ret[$key] = $this->$method();
4200 continue;
4201 }
4202
4203 // if not null - and it's not set.......
4204
4205 if ($val & DB_DATAOBJECT_NOTNULL && DB_DataObject::_is_null($this, $key)) {
4206 // dont check empty sequence key values..
4207 if (($key == $seq[0]) && ($seq[1] == true)) {
4208 continue;
4209 }
4210 $ret[$key] = false;
4211 continue;
4212 }
4213
4214
4215 if (DB_DataObject::_is_null($this, $key)) {
4216 if ($val & DB_DATAOBJECT_NOTNULL) {
4217 $this->debug("'null' field used for '$key', but it is defined as NOT NULL", 'VALIDATION', 4);
4218 $ret[$key] = false;
4219 continue;
4220 }
4221 continue;
4222 }
4223
4224 // ignore things that are not set. ?
4225
4226 if (!isset($this->$key)) {
4227 continue;
4228 }
4229
4230 // if the string is empty.. assume it is ok..
4231 if (!is_object($this->$key) && !is_array($this->$key) && !strlen((string) $this->$key)) {
4232 continue;
4233 }
4234
4235 // dont try and validate cast objects - assume they are problably ok..
4236 if (is_object($this->$key) && is_a($this->$key,'DB_DataObject_Cast')) {
4237 continue;
4238 }
4239 // at this point if you have set something to an object, and it's not expected
4240 // the Validate will probably break!!... - rightly so! (your design is broken,
4241 // so issuing a runtime error like PEAR_Error is probably not appropriate..
4242
4243 switch (true) {
4244 // todo: date time.....
4245 case ($val & DB_DATAOBJECT_STR):
4246 $ret[$key] = Validate::string($this->$key, VALIDATE_PUNCTUATION . VALIDATE_NAME);
4247 continue;
4248 case ($val & DB_DATAOBJECT_INT):
4249 $ret[$key] = Validate::number($this->$key, array('decimal'=>'.'));
4250 continue;
4251 }
4252 }
4253 // if any of the results are false or an object (eg. PEAR_Error).. then return the array..
4254 foreach ($ret as $key => $val) {
4255 if ($val !== true) {
4256 return $ret;
4257 }
4258 }
4259 return true; // everything is OK.
4260 }
4261
4262 /**
4263 * Gets the DB object related to an object - so you can use funky peardb stuf with it :)
4264 *
4265 * @access public
4266 * @return object The DB connection
4267 */
4268 function getDatabaseConnection()
4269 {
4270 global $_DB_DATAOBJECT;
4271
4272 if (($e = $this->_connect()) !== true) {
4273 return $e;
4274 }
4275 if (!isset($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5])) {
4276 $r = false;
4277 return $r;
4278 }
4279 return $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
4280 }
4281
4282
4283 /**
4284 * Gets the DB result object related to the objects active query
4285 * - so you can use funky pear stuff with it - like pager for example.. :)
4286 *
4287 * @access public
4288 * @return object The DB result object
4289 */
4290
4291 function getDatabaseResult()
4292 {
4293 global $_DB_DATAOBJECT;
4294 $this->_connect();
4295 if (!isset($_DB_DATAOBJECT['RESULTS'][$this->_DB_resultid])) {
4296 $r = false;
4297 return $r;
4298 }
4299 return $_DB_DATAOBJECT['RESULTS'][$this->_DB_resultid];
4300 }
4301
4302 /**
4303 * Overload Extension support
4304 * - enables setCOLNAME/getCOLNAME
4305 * if you define a set/get method for the item it will be called.
4306 * otherwise it will just return/set the value.
4307 * NOTE this currently means that a few Names are NO-NO's
4308 * eg. links,link,linksarray, from, Databaseconnection,databaseresult
4309 *
4310 * note
4311 * - set is automatically called by setFrom.
4312 * - get is automatically called by toArray()
4313 *
4314 * setters return true on success. = strings on failure
4315 * getters return the value!
4316 *
4317 * this fires off trigger_error - if any problems.. pear_error,
4318 * has problems with 4.3.2RC2 here
4319 *
4320 * @access public
4321 * @return true?
4322 * @see overload
4323 */
4324
4325
4326 function _call($method,$params,&$return) {
4327
4328 //$this->debug("ATTEMPTING OVERLOAD? $method");
4329 // ignore constructors : - mm
4330 if (strtolower($method) == strtolower(get_class($this))) {
4331 return true;
4332 }
4333 $type = strtolower(substr($method,0,3));
4334 $class = get_class($this);
4335 if (($type != 'set') && ($type != 'get')) {
4336 return false;
4337 }
4338
4339
4340
4341 // deal with naming conflick of setFrom = this is messy ATM!
4342
4343 if (strtolower($method) == 'set_from') {
4344 $return = $this->toValue('from',isset($params[0]) ? $params[0] : null);
4345 return true;
4346 }
4347
4348 $element = substr($method,3);
4349
4350 // dont you just love php's case insensitivity!!!!
4351
4352 $array = array_keys(get_class_vars($class));
4353 /* php5 version which segfaults on 5.0.3 */
4354 if (class_exists('ReflectionClass')) {
4355 $reflection = new ReflectionClass($class);
4356 $array = array_keys($reflection->getdefaultProperties());
4357 }
4358
4359 if (!in_array($element,$array)) {
4360 // munge case
4361 foreach($array as $k) {
4362 $case[strtolower($k)] = $k;
4363 }
4364 if ((substr(phpversion(),0,1) == 5) && isset($case[strtolower($element)])) {
4365 trigger_error("PHP5 set/get calls should match the case of the variable",E_USER_WARNING);
4366 $element = strtolower($element);
4367 }
4368
4369 // does it really exist?
4370 if (!isset($case[$element])) {
4371 return false;
4372 }
4373 // use the mundged case
4374 $element = $case[$element]; // real case !
4375 }
4376
4377
4378 if ($type == 'get') {
4379 $return = $this->toValue($element,isset($params[0]) ? $params[0] : null);
4380 return true;
4381 }
4382
4383
4384 $return = $this->fromValue($element, $params[0]);
4385
4386 return true;
4387
4388
4389 }
4390
4391
4392 /**
4393 * standard set* implementation.
4394 *
4395 * takes data and uses it to set dates/strings etc.
4396 * normally called from __call..
4397 *
4398 * Current supports
4399 * date = using (standard time format, or unixtimestamp).... so you could create a method :
4400 * function setLastread($string) { $this->fromValue('lastread',strtotime($string)); }
4401 *
4402 * time = using strtotime
4403 * datetime = using same as date - accepts iso standard or unixtimestamp.
4404 * string = typecast only..
4405 *
4406 * TODO: add formater:: eg. d/m/Y for date! ???
4407 *
4408 * @param string column of database
4409 * @param mixed value to assign
4410 *
4411 * @return true| false (False on error)
4412 * @access public
4413 * @see DB_DataObject::_call
4414 */
4415
4416
4417 function fromValue($col,$value)
4418 {
4419 global $_DB_DATAOBJECT;
4420 $options = $_DB_DATAOBJECT['CONFIG'];
4421 $cols = $this->table();
4422 // dont know anything about this col..
4423 if (!isset($cols[$col]) || is_a($value, 'DB_DataObject_Cast')) {
4424 $this->$col = $value;
4425 return true;
4426 }
4427 //echo "FROM VALUE $col, {$cols[$col]}, $value\n";
4428 switch (true) {
4429 // set to null and column is can be null...
4430 case ((!($cols[$col] & DB_DATAOBJECT_NOTNULL)) && DB_DataObject::_is_null($value, false)):
4431 case (is_object($value) && is_a($value,'DB_DataObject_Cast')):
4432 $this->$col = $value;
4433 return true;
4434
4435 // fail on setting null on a not null field..
4436 case (($cols[$col] & DB_DATAOBJECT_NOTNULL) && DB_DataObject::_is_null($value,false)):
4437
4438 return false;
4439
4440 case (($cols[$col] & DB_DATAOBJECT_DATE) && ($cols[$col] & DB_DATAOBJECT_TIME)):
4441 // empty values get set to '' (which is inserted/updated as NULl
4442 if (!$value) {
4443 $this->$col = '';
4444 }
4445
4446 if (is_numeric($value)) {
4447 $this->$col = date('Y-m-d H:i:s', $value);
4448 return true;
4449 }
4450
4451 // eak... - no way to validate date time otherwise...
4452 $this->$col = (string) $value;
4453 return true;
4454
4455 case ($cols[$col] & DB_DATAOBJECT_DATE):
4456 // empty values get set to '' (which is inserted/updated as NULl
4457
4458 if (!$value) {
4459 $this->$col = '';
4460 return true;
4461 }
4462
4463 if (is_numeric($value)) {
4464 $this->$col = date('Y-m-d',$value);
4465 return true;
4466 }
4467
4468 // try date!!!!
4469 require_once 'Date.php';
4470 $x = new Date($value);
4471 $this->$col = $x->format("%Y-%m-%d");
4472 return true;
4473
4474 case ($cols[$col] & DB_DATAOBJECT_TIME):
4475 // empty values get set to '' (which is inserted/updated as NULl
4476 if (!$value) {
4477 $this->$col = '';
4478 }
4479
4480 $guess = strtotime($value);
4481 if ($guess != -1) {
4482 $this->$col = date('H:i:s', $guess);
4483 return $return = true;
4484 }
4485 // otherwise an error in type...
4486 return false;
4487
4488 case ($cols[$col] & DB_DATAOBJECT_STR):
4489
4490 $this->$col = (string) $value;
4491 return true;
4492
4493 // todo : floats numerics and ints...
4494 default:
4495 $this->$col = $value;
4496 return true;
4497 }
4498
4499
4500
4501 }
4502 /**
4503 * standard get* implementation.
4504 *
4505 * with formaters..
4506 * supported formaters:
4507 * date/time : %d/%m/%Y (eg. php strftime) or pear::Date
4508 * numbers : %02d (eg. sprintf)
4509 * NOTE you will get unexpected results with times like 0000-00-00 !!!
4510 *
4511 *
4512 *
4513 * @param string column of database
4514 * @param format foramt
4515 *
4516 * @return true Description
4517 * @access public
4518 * @see DB_DataObject::_call(),strftime(),Date::format()
4519 */
4520 function toValue($col,$format = null)
4521 {
4522 if (is_null($format)) {
4523 return $this->$col;
4524 }
4525 $cols = $this->table();
4526 switch (true) {
4527 case (($cols[$col] & DB_DATAOBJECT_DATE) && ($cols[$col] & DB_DATAOBJECT_TIME)):
4528 if (!$this->$col) {
4529 return '';
4530 }
4531 $guess = strtotime($this->$col);
4532 if ($guess != -1) {
4533 return strftime($format, $guess);
4534 }
4535 // eak... - no way to validate date time otherwise...
4536 return $this->$col;
4537 case ($cols[$col] & DB_DATAOBJECT_DATE):
4538 if (!$this->$col) {
4539 return '';
4540 }
4541 $guess = strtotime($this->$col);
4542 if ($guess != -1) {
4543 return strftime($format,$guess);
4544 }
4545 // try date!!!!
4546 require_once 'Date.php';
4547 $x = new Date($this->$col);
4548 return $x->format($format);
4549
4550 case ($cols[$col] & DB_DATAOBJECT_TIME):
4551 if (!$this->$col) {
4552 return '';
4553 }
4554 $guess = strtotime($this->$col);
4555 if ($guess > -1) {
4556 return strftime($format, $guess);
4557 }
4558 // otherwise an error in type...
4559 return $this->$col;
4560
4561 case ($cols[$col] & DB_DATAOBJECT_MYSQLTIMESTAMP):
4562 if (!$this->$col) {
4563 return '';
4564 }
4565 require_once 'Date.php';
4566
4567 $x = new Date($this->$col);
4568
4569 return $x->format($format);
4570
4571
4572 case ($cols[$col] & DB_DATAOBJECT_BOOL):
4573
4574 if ($cols[$col] & DB_DATAOBJECT_STR) {
4575 // it's a 't'/'f' !
4576 return ($this->$col === 't');
4577 }
4578 return (bool) $this->$col;
4579
4580
4581 default:
4582 return sprintf($format,$this->col);
4583 }
4584
4585
4586 }
4587
4588
4589 /* ----------------------- Debugger ------------------ */
4590
4591 /**
4592 * Debugger. - use this in your extended classes to output debugging information.
4593 *
4594 * Uses DB_DataObject::DebugLevel(x) to turn it on
4595 *
4596 * @param string $message - message to output
4597 * @param string $logtype - bold at start
4598 * @param string $level - output level
4599 * @access public
4600 * @return none
4601 */
4602 function debug($message, $logtype = 0, $level = 1)
4603 {
4604 global $_DB_DATAOBJECT;
4605
4606 if (empty($_DB_DATAOBJECT['CONFIG']['debug']) ||
4607 (is_numeric($_DB_DATAOBJECT['CONFIG']['debug']) && $_DB_DATAOBJECT['CONFIG']['debug'] < $level)) {
4608 return;
4609 }
4610 // this is a bit flaky due to php's wonderfull class passing around crap..
4611 // but it's about as good as it gets..
4612 $class = (isset($this) && is_a($this,'DB_DataObject')) ? get_class($this) : 'DB_DataObject';
4613
4614 if (!is_string($message)) {
4615 $message = print_r($message,true);
4616 }
4617 if (!is_numeric( $_DB_DATAOBJECT['CONFIG']['debug']) && is_callable( $_DB_DATAOBJECT['CONFIG']['debug'])) {
4618 return call_user_func($_DB_DATAOBJECT['CONFIG']['debug'], $class, $message, $logtype, $level);
4619 }
4620
4621 if (!ini_get('html_errors')) {
4622 echo "$class : $logtype : $message\n";
4623 flush();
4624 return;
4625 }
4626 if (!is_string($message)) {
4627 $message = print_r($message,true);
4628 }
4629 $colorize = ($logtype == 'ERROR') ? '<font color="red">' : '<font>';
4630 echo "<code>{$colorize}<B>$class: $logtype:</B> ". nl2br(htmlspecialchars($message)) . "</font></code><BR>\n";
4631 }
4632
4633 /**
4634 * sets and returns debug level
4635 * eg. DB_DataObject::debugLevel(4);
4636 *
4637 * @param int $v level
4638 * @access public
4639 * @return none
4640 */
4641 static function debugLevel($v = null)
4642 {
4643 global $_DB_DATAOBJECT;
4644 if (empty($_DB_DATAOBJECT['CONFIG'])) {
4645 DB_DataObject::_loadConfig();
4646 }
4647 if ($v !== null) {
4648 $r = isset($_DB_DATAOBJECT['CONFIG']['debug']) ? $_DB_DATAOBJECT['CONFIG']['debug'] : 0;
4649 $_DB_DATAOBJECT['CONFIG']['debug'] = $v;
4650 return $r;
4651 }
4652 return isset($_DB_DATAOBJECT['CONFIG']['debug']) ? $_DB_DATAOBJECT['CONFIG']['debug'] : 0;
4653 }
4654
4655 /**
4656 * Last Error that has occured
4657 * - use $this->_lastError or
4658 * $last_error = PEAR::getStaticProperty('DB_DataObject','lastError');
4659 *
4660 * @access public
4661 * @var object PEAR_Error (or false)
4662 */
4663 var $_lastError = false;
4664
4665 /**
4666 * Default error handling is to create a pear error, but never return it.
4667 * if you need to handle errors you should look at setting the PEAR_Error callback
4668 * this is due to the fact it would wreck havoc on the internal methods!
4669 *
4670 * @param int $message message
4671 * @param int $type type
4672 * @param int $behaviour behaviour (die or continue!);
4673 * @access public
4674 * @return error object
4675 */
4676 function raiseError($message, $type = null, $behaviour = null)
4677 {
4678 global $_DB_DATAOBJECT;
4679
4680 if ($behaviour == PEAR_ERROR_DIE && !empty($_DB_DATAOBJECT['CONFIG']['dont_die'])) {
4681 $behaviour = null;
4682 }
4683
4684 $error = &PEAR::getStaticProperty('DB_DataObject','lastError');
4685
4686
4687 // no checks for production here?....... - we log errors before we throw them.
4688 DB_DataObject::debug($message,'ERROR',1);
4689
4690
4691 if (is_a($message, 'PEAR_Error')) {
4692 $error = $message;
4693 } else {
4694 require_once 'DB/DataObject/Error.php';
4695 $dor = new PEAR();
4696 $error = $dor->raiseError($message, $type, $behaviour,
4697 $opts=null, $userinfo=null, 'DB_DataObject_Error'
4698 );
4699 }
4700 // this will never work totally with PHP's object model.
4701 // as this is passed on static calls (like staticGet in our case)
4702
4703 $_DB_DATAOBJECT['LASTERROR'] = $error;
4704
4705 if (isset($this) && is_object($this) && is_subclass_of($this,'db_dataobject')) {
4706 $this->_lastError = $error;
4707 }
4708
4709 return $error;
4710 }
4711
4712 /**
4713 * Define the global $_DB_DATAOBJECT['CONFIG'] as an alias to PEAR::getStaticProperty('DB_DataObject','options');
4714 *
4715 * After Profiling DB_DataObject, I discoved that the debug calls where taking
4716 * considerable time (well 0.1 ms), so this should stop those calls happening. as
4717 * all calls to debug are wrapped with direct variable queries rather than actually calling the funciton
4718 * THIS STILL NEEDS FURTHER INVESTIGATION
4719 *
4720 * @access public
4721 * @return object an error object
4722 */
4723 function _loadConfig()
4724 {
4725 global $_DB_DATAOBJECT;
4726
4727 $_DB_DATAOBJECT['CONFIG'] = (new PEAR)->getStaticProperty('DB_DataObject','options');
4728
4729
4730 }
4731 /**
4732 * Free global arrays associated with this object.
4733 *
4734 *
4735 * @access public
4736 * @return none
4737 */
4738 function free()
4739 {
4740 global $_DB_DATAOBJECT;
4741
4742 if (isset($_DB_DATAOBJECT['RESULTFIELDS'][$this->_DB_resultid])) {
4743 unset($_DB_DATAOBJECT['RESULTFIELDS'][$this->_DB_resultid]);
4744 }
4745 if (isset($_DB_DATAOBJECT['RESULTS'][$this->_DB_resultid])) {
4746 unset($_DB_DATAOBJECT['RESULTS'][$this->_DB_resultid]);
4747 }
4748 // clear the staticGet cache as well.
4749 $this->_clear_cache();
4750 // this is a huge bug in DB!
4751 if (isset($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5])) {
4752 $_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]->num_rows = array();
4753 }
4754
4755 if (is_array($this->_link_loaded)) {
4756 foreach ($this->_link_loaded as $do) {
4757 if (
4758 !empty($this->{$do}) &&
4759 is_object($this->{$do}) &&
4760 method_exists($this->{$do}, 'free')
4761 ) {
4762 $this->{$do}->free();
4763 }
4764 }
4765 }
4766
4767
4768 }
4769 /**
4770 * Evaluate whether or not a value is set to null, taking the 'disable_null_strings' option into account.
4771 * If the value is a string set to "null" and the "disable_null_strings" option is not set to
4772 * true, then the value is considered to be null.
4773 * If the value is actually a PHP NULL value, and "disable_null_strings" has been set to
4774 * the value "full", then it will also be considered null. - this can not differenticate between not set
4775 *
4776 *
4777 * @param object|array $obj_or_ar
4778 * @param string|false $prop prperty
4779
4780 * @access private
4781 * @return bool object
4782 */
4783 function _is_null($obj_or_ar , $prop)
4784 {
4785 global $_DB_DATAOBJECT;
4786
4787
4788 $isset = $prop === false ? isset($obj_or_ar) :
4789 (is_array($obj_or_ar) ? isset($obj_or_ar[$prop]) : isset($obj_or_ar->$prop));
4790
4791 $value = $isset ?
4792 ($prop === false ? $obj_or_ar :
4793 (is_array($obj_or_ar) ? $obj_or_ar[$prop] : $obj_or_ar->$prop))
4794 : null;
4795
4796
4797
4798 $options = $_DB_DATAOBJECT['CONFIG'];
4799
4800 $null_strings = !isset($options['disable_null_strings'])
4801 || $options['disable_null_strings'] === false;
4802
4803 $crazy_null = isset($options['disable_null_strings'])
4804 && is_string($options['disable_null_strings'])
4805 && strtolower($options['disable_null_strings'] === 'full');
4806
4807 if ( $null_strings && $isset && is_string($value) && (strtolower($value) === 'null') ) {
4808 return true;
4809 }
4810
4811 if ( $crazy_null && !$isset ) {
4812 return true;
4813 }
4814
4815 return false;
4816
4817
4818 }
4819
4820 /**
4821 * (deprecated - use ::get / and your own caching method)
4822 */
4823 static function staticGet($class, $k, $v = null)
4824 {
4825 $lclass = strtolower($class);
4826 global $_DB_DATAOBJECT;
4827 if (empty($_DB_DATAOBJECT['CONFIG'])) {
4828 DB_DataObject::_loadConfig();
4829 }
4830
4831
4832
4833 $key = "$k:$v";
4834 if ($v === null) {
4835 $key = $k;
4836 }
4837 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
4838 DB_DataObject::debug("$class $key","STATIC GET - TRY CACHE");
4839 }
4840 if (!empty($_DB_DATAOBJECT['CACHE'][$lclass][$key])) {
4841 return $_DB_DATAOBJECT['CACHE'][$lclass][$key];
4842 }
4843 if (!empty($_DB_DATAOBJECT['CONFIG']['debug'])) {
4844 DB_DataObject::debug("$class $key","STATIC GET - NOT IN CACHE");
4845 }
4846
4847 $obj = DB_DataObject::factory(substr($class,strlen($_DB_DATAOBJECT['CONFIG']['class_prefix'])));
4848 if (is_a($obj, 'PEAR_Error')) {
4849 $dor = new DB_DataObject();
4850 $dor->raiseError("could not autoload $class", DB_DATAOBJECT_ERROR_NOCLASS);
4851 $r = false;
4852 return $r;
4853 }
4854
4855 if (!isset($_DB_DATAOBJECT['CACHE'][$lclass])) {
4856 $_DB_DATAOBJECT['CACHE'][$lclass] = array();
4857 }
4858 if (!$obj->get($k,$v)) {
4859 $dor = new DB_DataObject();
4860 $dor->raiseError("No Data return from get $k $v", DB_DATAOBJECT_ERROR_NODATA);
4861
4862 $r = false;
4863 return $r;
4864 }
4865 $_DB_DATAOBJECT['CACHE'][$lclass][$key] = $obj;
4866 return $_DB_DATAOBJECT['CACHE'][$lclass][$key];
4867 }
4868
4869 /**
4870 * autoload Class relating to a table
4871 * (deprecited - use ::factory)
4872 *
4873 * @param string $table table
4874 * @access private
4875 * @return string classname on Success
4876 */
4877 function staticAutoloadTable($table)
4878 {
4879 global $_DB_DATAOBJECT;
4880 if (empty($_DB_DATAOBJECT['CONFIG'])) {
4881 DB_DataObject::_loadConfig();
4882 }
4883 $p = isset($_DB_DATAOBJECT['CONFIG']['class_prefix']) ?
4884 $_DB_DATAOBJECT['CONFIG']['class_prefix'] : '';
4885 $class = $p . preg_replace('/[^A-Z0-9]/i','_',ucfirst($table));
4886
4887 $ce = substr(phpversion(),0,1) > 4 ? class_exists($class,false) : class_exists($class);
4888 $class = $ce ? $class : DB_DataObject::_autoloadClass($class);
4889 return $class;
4890 }
4891
4892 /* ---- LEGACY BC METHODS - NOT DOCUMENTED - See Documentation on New Methods. ---*/
4893
4894 function _get_table() { return $this->table(); }
4895 function _get_keys() { return $this->keys(); }
4896
4897
4898
4899
4900}
4901// technially 4.3.2RC1 was broken!!
4902// looks like 4.3.3 may have problems too....
4903if (!defined('DB_DATAOBJECT_NO_OVERLOAD')) {
4904
4905 if ((phpversion() != '4.3.2-RC1') && (version_compare( phpversion(), "4.3.1") > 0)) {
4906 if (version_compare( phpversion(), "5") < 0) {
4907 overload('DB_DataObject');
4908 }
4909 $GLOBALS['_DB_DATAOBJECT']['OVERLOADED'] = true;
4910 }
4911}