fwolf /
fwlib
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Adodb often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Adodb, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 38 | class Adodb extends Fwolflib { |
||
|
|
|||
| 39 | |||
| 40 | /** |
||
| 41 | * Real ADODB connection object |
||
| 42 | * @var object |
||
| 43 | */ |
||
| 44 | protected $__conn = null; |
||
| 45 | |||
| 46 | /** |
||
| 47 | * Db profile |
||
| 48 | * @var array |
||
| 49 | */ |
||
| 50 | public $aDbProfile = null; |
||
| 51 | |||
| 52 | /** |
||
| 53 | * Table schema |
||
| 54 | * |
||
| 55 | * array( |
||
| 56 | * col -> // ADOFieldObject Object, not Array ! |
||
| 57 | * [name] => ts |
||
| 58 | * [max_length] => -1 |
||
| 59 | * [type] => timestamp |
||
| 60 | * [scale] => |
||
| 61 | * [not_null] => 1 |
||
| 62 | * [primary_key] => |
||
| 63 | * [auto_increment] => |
||
| 64 | * [binary] => |
||
| 65 | * [unsigned] => |
||
| 66 | * [zerofill] => |
||
| 67 | * [has_default] => 1 |
||
| 68 | * [default_value] => CURRENT_TIMESTAMP |
||
| 69 | * ) |
||
| 70 | * ) |
||
| 71 | * @var array |
||
| 72 | */ |
||
| 73 | public $aMetaColumn = array(); |
||
| 74 | |||
| 75 | /** |
||
| 76 | * Table column name array, index is upper case of column name |
||
| 77 | * |
||
| 78 | * eg: array( |
||
| 79 | * 'COLUMN' => 'column', |
||
| 80 | * ) |
||
| 81 | * @var array |
||
| 82 | */ |
||
| 83 | public $aMetaColumnName = array(); |
||
| 84 | |||
| 85 | /** |
||
| 86 | * Primary key columns of table |
||
| 87 | * |
||
| 88 | * array( |
||
| 89 | * tbl_name -> 'col_pk', |
||
| 90 | * tbl_name -> array(pk_col1, pk_col2), |
||
| 91 | * ) |
||
| 92 | * @var array |
||
| 93 | */ |
||
| 94 | public $aMetaPrimaryKey = array(); |
||
| 95 | |||
| 96 | /** |
||
| 97 | * Sql generator object |
||
| 98 | * @var object |
||
| 99 | */ |
||
| 100 | protected $oSg; |
||
| 101 | |||
| 102 | /** |
||
| 103 | * Error msg |
||
| 104 | * @var string |
||
| 105 | */ |
||
| 106 | public $sErrorMsg = ''; |
||
| 107 | |||
| 108 | /** |
||
| 109 | * System charset |
||
| 110 | * |
||
| 111 | * In common, this is your php script/operation system charset |
||
| 112 | * @var string |
||
| 113 | */ |
||
| 114 | public $sSysCharset = 'utf8'; |
||
| 115 | |||
| 116 | |||
| 117 | /** |
||
| 118 | * construct |
||
| 119 | * |
||
| 120 | * <code> |
||
| 121 | * $dbprofile = array(type, host, user, pass, name, lang); |
||
| 122 | * type is mysql/sybase_ase etc, |
||
| 123 | * name is dbname to select, |
||
| 124 | * lang is db server charset. |
||
| 125 | * </code> |
||
| 126 | * @var param array $dbprofile |
||
| 127 | * @var param string $path_adodb Include path of original ADODB |
||
| 128 | */ |
||
| 129 | public function __construct ($dbprofile, $path_adodb = '') { |
||
| 143 | |||
| 144 | |||
| 145 | /** |
||
| 146 | * Overload __call, redirect method call to adodb |
||
| 147 | * |
||
| 148 | * @var string $name Method name |
||
| 149 | * @var array $arg Method argument |
||
| 150 | * @global int $i_db_query_times |
||
| 151 | * @return mixed |
||
| 152 | */ |
||
| 153 | public function __call ($name, $arg) { |
||
| 202 | |||
| 203 | |||
| 204 | /** |
||
| 205 | * Overload __get, redirect method call to adodb |
||
| 206 | * |
||
| 207 | * @param string $name |
||
| 208 | * @return mixed |
||
| 209 | */ |
||
| 210 | public function __get ($name) { |
||
| 213 | |||
| 214 | |||
| 215 | /** |
||
| 216 | * Overload __set, redirect method call to adodb |
||
| 217 | * |
||
| 218 | * @param string $name |
||
| 219 | * @param mixed $val |
||
| 220 | */ |
||
| 221 | public function __set ($name, $val) { |
||
| 224 | |||
| 225 | |||
| 226 | /** |
||
| 227 | } |
||
| 228 | * Connect, Add mysql 'set names utf8' |
||
| 229 | * |
||
| 230 | * <code> |
||
| 231 | * Obmit params(dbprofile was set in __construct): |
||
| 232 | * param $argHostname Host to connect to |
||
| 233 | * param $argUsername Userid to login |
||
| 234 | * param $argPassword Associated password |
||
| 235 | * param $argDatabaseName database |
||
| 236 | * </code> |
||
| 237 | * @param $forcenew Force new connection |
||
| 238 | * @return boolean |
||
| 239 | */ |
||
| 240 | public function Connect ($forcenew = false) { |
||
| 340 | |||
| 341 | |||
| 342 | /** |
||
| 343 | * Count how many db query have executed |
||
| 344 | * |
||
| 345 | * This function can be extend by subclass if you want to count on multi db objects. |
||
| 346 | * |
||
| 347 | * Can't count in Adodb::property, because need display is done by Controler, |
||
| 348 | * which will call View, but Adodb is property of Module, |
||
| 349 | * so we can only use global vars to save this value. |
||
| 350 | * @global int $i_db_query_times |
||
| 351 | */ |
||
| 352 | protected function CountDbQueryTimes () { |
||
| 356 | |||
| 357 | |||
| 358 | /** |
||
| 359 | * Delete rows by condition user given |
||
| 360 | * |
||
| 361 | * @param string $tbl |
||
| 362 | * @param string $cond Condition, can be where, having etc, raw sql string, not null. |
||
| 363 | * @return int -1 error/0 not found/N > 0 number of rows |
||
| 364 | */ |
||
| 365 | View Code Duplication | public function DelRow ($tbl, $cond) { |
|
| 378 | |||
| 379 | |||
| 380 | /** |
||
| 381 | * Convert recordset(simple array) or other string |
||
| 382 | * from db encoding to system encoding |
||
| 383 | * |
||
| 384 | * Use recursive mechanism, beware of loop hole. |
||
| 385 | * @param mixed &$s Source to convert |
||
| 386 | * @return mixed |
||
| 387 | */ |
||
| 388 | View Code Duplication | public function EncodingConvert (&$s) { |
|
| 401 | |||
| 402 | |||
| 403 | /** |
||
| 404 | * Convert data encoding |
||
| 405 | * from system(usually utf-8) to db |
||
| 406 | * |
||
| 407 | * Use recursive mechanism, beware of loop hole. |
||
| 408 | * @param mixed &$s Source to convert |
||
| 409 | * @return mixed |
||
| 410 | */ |
||
| 411 | View Code Duplication | public function EncodingConvertReverse (&$s) { |
|
| 424 | |||
| 425 | |||
| 426 | /** |
||
| 427 | * Generate SQL then exec it |
||
| 428 | * |
||
| 429 | * @param array $ar_sql Same as GenSql() |
||
| 430 | * @return object |
||
| 431 | * @see GenSql() |
||
| 432 | */ |
||
| 433 | public function ExecuteGenSql ($ar_sql) { |
||
| 436 | |||
| 437 | |||
| 438 | /** |
||
| 439 | * Find name of timestamp column of a table |
||
| 440 | * |
||
| 441 | * @param $tbl Table name |
||
| 442 | * @return string |
||
| 443 | */ |
||
| 444 | public function FindColTs ($tbl) { |
||
| 502 | |||
| 503 | |||
| 504 | /** |
||
| 505 | * Generate SQL statement |
||
| 506 | * |
||
| 507 | * User should avoid use SELECT/UPDATE/INSERT/DELETE simultaneously. |
||
| 508 | * |
||
| 509 | * Generate order by SQL statement format order. |
||
| 510 | * |
||
| 511 | * UPDATE/INSERT/DELETE is followed by [TBL_NAME], |
||
| 512 | * so need not use FROM. |
||
| 513 | * @param array $ar_sql Array(select=>..., from=>...) |
||
| 514 | * @return string |
||
| 515 | * @see SqlGenerator |
||
| 516 | */ |
||
| 517 | public function GenSql ($ar_sql) { |
||
| 525 | |||
| 526 | |||
| 527 | /** |
||
| 528 | * Generate SQL statement for Prepare |
||
| 529 | * |
||
| 530 | * value -> ? or :name, and quote chars removed |
||
| 531 | * @param array $ar_sql Same as GenSql() |
||
| 532 | * @return string |
||
| 533 | * @see GenSql() |
||
| 534 | * @see SqlGenerator |
||
| 535 | */ |
||
| 536 | public function GenSqlPrepare ($ar_sql) { |
||
| 542 | |||
| 543 | |||
| 544 | /** |
||
| 545 | * Get data from single table using PK |
||
| 546 | * |
||
| 547 | * $m_pk, $col, $col_pk support string split by ',' or array, like: |
||
| 548 | * 1. 'val' |
||
| 549 | * 2. 'val1, val2' |
||
| 550 | * 3. array('val1', 'val2') |
||
| 551 | * |
||
| 552 | * '*' can be used for $col, means all cols in table, this way can't use |
||
| 553 | * cache, not recommend. |
||
| 554 | * |
||
| 555 | * Notice: $col must indexed by number start from 0. |
||
| 556 | * |
||
| 557 | * Also, this function can be used to retrieve data from a table with |
||
| 558 | * single unique index, by assigning $col_pk to non-PK column. |
||
| 559 | * |
||
| 560 | * @param string $s_tbl |
||
| 561 | * @param mixed $m_pk PK value |
||
| 562 | * @param mixed $col Cols need to retrieve. |
||
| 563 | * @param mixed $col_pk PK column name, NULL to auto get. |
||
| 564 | * @return mixed Single/array, NULL if error occur. |
||
| 565 | */ |
||
| 566 | public function GetDataByPk ($s_tbl, $m_pk, $col = NULL, $col_pk = NULL) { |
||
| 636 | |||
| 637 | |||
| 638 | /** |
||
| 639 | * Get table schema |
||
| 640 | * |
||
| 641 | * @param string $table |
||
| 642 | * @param boolean $forcenew Force to retrieve instead of read from cache |
||
| 643 | * @return array |
||
| 644 | * @see $aMetaColumn |
||
| 645 | */ |
||
| 646 | public function GetMetaColumn ($table, $forcenew = false) { |
||
| 667 | |||
| 668 | |||
| 669 | /** |
||
| 670 | * Get table column name |
||
| 671 | * |
||
| 672 | * @param string $table |
||
| 673 | * @param boolean $forcenew Force to retrieve instead of read from cache |
||
| 674 | * @return array |
||
| 675 | * @see $aMetaColumnName |
||
| 676 | */ |
||
| 677 | public function GetMetaColumnName ($table, $forcenew = false) { |
||
| 683 | |||
| 684 | |||
| 685 | /** |
||
| 686 | * Get primary key column of a table |
||
| 687 | * |
||
| 688 | * @param string $table |
||
| 689 | * @param boolean $forcenew Force to retrieve instead of read from cache |
||
| 690 | * @return mixed Single string value or array when primary key contain multi columns. |
||
| 691 | * @see $aMetaPrimaryKey |
||
| 692 | */ |
||
| 693 | public function GetMetaPrimaryKey ($table, $forcenew = false) { |
||
| 779 | |||
| 780 | |||
| 781 | /** |
||
| 782 | * Get rows count by condition user given |
||
| 783 | * |
||
| 784 | * @param string $tbl |
||
| 785 | * @param string $cond Condition, can be where, having etc, raw sql string. |
||
| 786 | * @return int -1: error/N >= 0: number of rows |
||
| 787 | */ |
||
| 788 | View Code Duplication | public function GetRowCount ($tbl, $cond = '') { |
|
| 800 | |||
| 801 | |||
| 802 | /** |
||
| 803 | * Get delimiter between SQL for various db |
||
| 804 | * |
||
| 805 | * @return string |
||
| 806 | */ |
||
| 807 | public function GetSqlDelimiter () { |
||
| 818 | |||
| 819 | |||
| 820 | /** |
||
| 821 | * Get SQL: begin transaction |
||
| 822 | * |
||
| 823 | * @return string |
||
| 824 | */ |
||
| 825 | public function GetSqlTransBegin () { |
||
| 831 | |||
| 832 | |||
| 833 | /** |
||
| 834 | * Get SQL: commit transaction |
||
| 835 | * |
||
| 836 | * @return string |
||
| 837 | */ |
||
| 838 | public function GetSqlTransCommit () { |
||
| 841 | |||
| 842 | |||
| 843 | /** |
||
| 844 | * Get SQL: rollback transaction |
||
| 845 | * |
||
| 846 | * @return string |
||
| 847 | */ |
||
| 848 | public function GetSqlTransRollback () { |
||
| 851 | |||
| 852 | |||
| 853 | /** |
||
| 854 | * If current db is a mysql db. |
||
| 855 | * |
||
| 856 | * @return boolean |
||
| 857 | */ |
||
| 858 | public function IsDbMysql () { |
||
| 861 | |||
| 862 | |||
| 863 | /** |
||
| 864 | * If current db is a sybase db. |
||
| 865 | * |
||
| 866 | * @return boolean |
||
| 867 | */ |
||
| 868 | public function IsDbSybase () { |
||
| 872 | |||
| 873 | |||
| 874 | /** |
||
| 875 | * Is timestamp column's value is unique |
||
| 876 | * |
||
| 877 | * @return boolean |
||
| 878 | */ |
||
| 879 | public function IsTsUnique () { |
||
| 886 | |||
| 887 | |||
| 888 | /** |
||
| 889 | * Prepare and execute sql |
||
| 890 | * |
||
| 891 | * @param string $sql |
||
| 892 | * @param array $inputarr Optional parameters in sql |
||
| 893 | * @return object |
||
| 894 | */ |
||
| 895 | public function PExecute ($sql, $inputarr = false) { |
||
| 910 | |||
| 911 | |||
| 912 | /** |
||
| 913 | * Generate, prepare and exec SQL |
||
| 914 | * |
||
| 915 | * @param array $ar_sql Same as GenSql() |
||
| 916 | * @param array $inputarr Optional parameters in sql |
||
| 917 | * @return object |
||
| 918 | * @see GenSql() |
||
| 919 | */ |
||
| 920 | public function PExecuteGenSql ($ar_sql, $inputarr = false) { |
||
| 923 | |||
| 924 | |||
| 925 | /** |
||
| 926 | * Smarty quote string in sql, by check columns type |
||
| 927 | * |
||
| 928 | * @param string $table |
||
| 929 | * @param string $column |
||
| 930 | * @param mixed $val |
||
| 931 | * @return string |
||
| 932 | */ |
||
| 933 | View Code Duplication | public function QuoteValue ($table, $column, $val) { |
|
| 972 | |||
| 973 | |||
| 974 | /** |
||
| 975 | * If a table exists in db ? |
||
| 976 | * |
||
| 977 | * @param string $tbl |
||
| 978 | * @return boolean |
||
| 979 | */ |
||
| 980 | View Code Duplication | public function TblExists ($tbl) { |
|
| 998 | |||
| 999 | |||
| 1000 | /** |
||
| 1001 | * Smart write data row(s) to table |
||
| 1002 | * |
||
| 1003 | * Will auto check row existence, and decide to use INSERT or UPDATE, |
||
| 1004 | * so PRIMARY KEY column must include in $data array. |
||
| 1005 | * Also, table must have primary key defined. |
||
| 1006 | * @param string $tbl Table which rows to write to |
||
| 1007 | * @param array $data Row(s) data, only one row(1-dim array, index is column name) |
||
| 1008 | * or some rows(2-dim array, index layer 1 MUST be number and |
||
| 1009 | * will not write to db). |
||
| 1010 | * @param string $mode A auto detect/U update/I insert, ignore case. |
||
| 1011 | * If you assign some rows, it's better not to set this to 0, |
||
| 1012 | * because it will only detect by the FIRST row data. |
||
| 1013 | * @return int Number of inserted or updated rows, -1 means some error, |
||
| 1014 | * 0 and upper are normal result. |
||
| 1015 | */ |
||
| 1016 | public function Write ($tbl, $data, $mode = 'A') { |
||
| 1147 | |||
| 1148 | |||
| 1149 | } // end of class Adodb |
||
| 1150 | ?> |
||
| 1151 |
Loading history...
This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.
The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.