vanilla /
garden-db
Complex classes like MySqlDb 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 MySqlDb, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 18 | class MySqlDb extends Db { |
||
| 19 | const MYSQL_DATE_FORMAT = 'Y-m-d H:i:s'; |
||
| 20 | |||
| 21 | /** |
||
| 22 | * @var string |
||
| 23 | */ |
||
| 24 | protected $dbname; |
||
| 25 | |||
| 26 | protected static $map = [ |
||
| 27 | Db::OP_GT => '>', |
||
| 28 | Db::OP_GTE => '>=', |
||
| 29 | Db::OP_LT => '<', |
||
| 30 | Db::OP_LTE => '<=', |
||
| 31 | Db::OP_LIKE => 'like', |
||
| 32 | Db::OP_AND => 'and', |
||
| 33 | Db::OP_OR => 'or', |
||
| 34 | ]; |
||
| 35 | |||
| 36 | /** |
||
| 37 | * {@inheritdoc} |
||
| 38 | */ |
||
| 39 | 6 | protected function dropTableDb($table, array $options = []) { |
|
| 46 | |||
| 47 | /** |
||
| 48 | * {@inheritdoc} |
||
| 49 | */ |
||
| 50 | 8 | protected function fetchTableDefDb($table) { |
|
| 68 | |||
| 69 | /** |
||
| 70 | * {@inheritdoc} |
||
| 71 | */ |
||
| 72 | 5 | protected function fetchColumnDefsDb($table) { |
|
| 73 | 5 | $rows = $this->get( |
|
| 74 | 5 | new Identifier('information_schema', 'COLUMNS'), |
|
| 75 | [ |
||
| 76 | 5 | 'TABLE_SCHEMA' => $this->getDbName(), |
|
| 77 | 5 | 'TABLE_NAME' => $this->prefixTable($table, false) |
|
| 78 | 5 | ], |
|
| 79 | [ |
||
| 80 | 5 | Db::OPTION_FETCH_MODE => PDO::FETCH_ASSOC, |
|
| 81 | 5 | 'order' => ['TABLE_NAME', 'ORDINAL_POSITION'] |
|
| 82 | 5 | ] |
|
| 83 | 5 | ); |
|
| 84 | |||
| 85 | 5 | $columns = []; |
|
| 86 | 5 | foreach ($rows as $row) { |
|
| 87 | 5 | $columnType = $row['COLUMN_TYPE']; |
|
| 88 | 5 | if ($columnType === 'tinyint(1)') { |
|
| 89 | 1 | $columnType = 'bool'; |
|
| 90 | 1 | } |
|
| 91 | 5 | $column = Db::typeDef($columnType); |
|
| 92 | 5 | if ($column === null) { |
|
| 93 | throw new \Exception("Unknown type '$columnType'.", 500); |
||
| 94 | } |
||
| 95 | |||
| 96 | 5 | $column['allowNull'] = strcasecmp($row['IS_NULLABLE'], 'YES') === 0; |
|
| 97 | |||
| 98 | 5 | if (($default = $row['COLUMN_DEFAULT']) !== null) { |
|
| 99 | 4 | $column['default'] = $this->forceType($default, $column['type']); |
|
| 100 | 4 | } |
|
| 101 | |||
| 102 | 5 | if ($row['EXTRA'] === 'auto_increment') { |
|
| 103 | 1 | $column['autoIncrement'] = true; |
|
| 104 | 1 | } |
|
| 105 | |||
| 106 | 5 | if ($row['COLUMN_KEY'] === 'PRI') { |
|
| 107 | 3 | $column['primary'] = true; |
|
| 108 | 3 | } |
|
| 109 | |||
| 110 | 5 | $columns[$row['COLUMN_NAME']] = $column; |
|
| 111 | 5 | } |
|
| 112 | |||
| 113 | 5 | return $columns; |
|
| 114 | } |
||
| 115 | |||
| 116 | /** |
||
| 117 | * {@inheritdoc} |
||
| 118 | */ |
||
| 119 | 76 | public function get($table, array $where, array $options = []) { |
|
| 124 | |||
| 125 | /** |
||
| 126 | * Build a sql select statement. |
||
| 127 | * |
||
| 128 | * @param string|Identifier $table The name of the main table. |
||
| 129 | * @param array $where The where filter. |
||
| 130 | * @param array $options An array of additional query options. |
||
| 131 | * @return string Returns the select statement as a string. |
||
| 132 | * @see Db::get() |
||
| 133 | */ |
||
| 134 | 80 | protected function buildSelect($table, array $where, array $options = []) { |
|
| 135 | 80 | $options += ['limit' => 0]; |
|
| 136 | |||
| 137 | 80 | $sql = ''; |
|
| 138 | |||
| 139 | // Build the select clause. |
||
| 140 | 80 | if (!empty($options['columns'])) { |
|
| 141 | 13 | $columns = array(); |
|
| 142 | 13 | foreach ($options['columns'] as $value) { |
|
| 143 | 13 | $columns[] = $this->escape($value); |
|
| 144 | 13 | } |
|
| 145 | 13 | $sql .= 'select '.implode(', ', $columns); |
|
| 146 | 13 | } else { |
|
| 147 | 76 | $sql .= "select *"; |
|
| 148 | } |
||
| 149 | |||
| 150 | // Build the from clause. |
||
| 151 | 80 | if ($table instanceof Literal) { |
|
| 152 | $table = $table->getValue($this); |
||
| 153 | } else { |
||
| 154 | 80 | $table = $this->prefixTable($table); |
|
| 155 | } |
||
| 156 | 80 | $sql .= "\nfrom $table"; |
|
| 157 | |||
| 158 | // Build the where clause. |
||
| 159 | 80 | $whereString = $this->buildWhere($where, Db::OP_AND); |
|
| 160 | 80 | if ($whereString) { |
|
| 161 | 51 | $sql .= "\nwhere ".$whereString; |
|
| 162 | 51 | } |
|
| 163 | |||
| 164 | // Build the order. |
||
| 165 | 80 | if (!empty($options['order'])) { |
|
| 166 | 40 | $orders = []; |
|
| 167 | 40 | foreach ($options['order'] as $column) { |
|
| 168 | 40 | if ($column[0] === '-') { |
|
| 169 | 2 | $order = $this->escape(substr($column, 1)).' desc'; |
|
| 170 | 2 | } else { |
|
| 171 | 40 | $order = $this->escape($column); |
|
| 172 | } |
||
| 173 | 40 | $orders[] = $order; |
|
| 174 | 40 | } |
|
| 175 | 40 | $sql .= "\norder by ".implode(', ', $orders); |
|
| 176 | 40 | } |
|
| 177 | |||
| 178 | // Build the limit, offset. |
||
| 179 | 80 | if (!empty($options['limit'])) { |
|
| 180 | 16 | $limit = (int)$options['limit']; |
|
| 181 | 16 | $sql .= "\nlimit $limit"; |
|
|
1 ignored issue
–
show
|
|||
| 182 | 16 | } |
|
| 183 | |||
| 184 | 80 | if (!empty($options['offset'])) { |
|
| 185 | 1 | $sql .= ' offset '.((int)$options['offset']); |
|
| 186 | 80 | } elseif (isset($options['page'])) { |
|
| 187 | $offset = $options['limit'] * ($options['page'] - 1); |
||
| 188 | $sql .= ' offset '.$offset; |
||
| 189 | } |
||
| 190 | |||
| 191 | 80 | return $sql; |
|
| 192 | } |
||
| 193 | |||
| 194 | /** |
||
| 195 | * Build a where clause from a where array. |
||
| 196 | * |
||
| 197 | * @param array $where There where string. |
||
| 198 | * This is an array in the form `['column' => 'value']` with more advanced options for non-equality comparisons. |
||
| 199 | * @param string $op The logical operator to join multiple field comparisons. |
||
| 200 | * @return string The where string. |
||
| 201 | */ |
||
| 202 | 82 | protected function buildWhere($where, $op = Db::OP_AND) { |
|
| 203 | 82 | $map = static::$map; |
|
| 204 | 82 | $strop = $map[$op]; |
|
| 205 | |||
| 206 | 82 | $result = ''; |
|
| 207 | 82 | foreach ($where as $column => $value) { |
|
| 208 | 53 | $btcolumn = $this->escape($column); |
|
| 209 | |||
| 210 | 53 | if (is_array($value)) { |
|
| 211 | 30 | if (is_numeric($column)) { |
|
| 212 | // This is a bracketed expression. |
||
| 213 | 4 | $result .= (empty($result) ? '' : "\n $strop "). |
|
| 214 | 4 | "(\n ". |
|
| 215 | 4 | $this->buildWhere($value, $op). |
|
| 216 | 4 | "\n )"; |
|
| 217 | 30 | } elseif (in_array($column, [Db::OP_AND, Db::OP_OR])) { |
|
| 218 | // This is an AND/OR expression. |
||
| 219 | 4 | $result .= (empty($result) ? '' : "\n $strop "). |
|
| 220 | 4 | "(\n ". |
|
| 221 | 4 | $this->buildWhere($value, $column). |
|
| 222 | 4 | "\n )"; |
|
| 223 | 4 | } else { |
|
| 224 | 26 | if (isset($value[0])) { |
|
| 225 | // This is a short in syntax. |
||
| 226 | 2 | $value = [Db::OP_IN => $value]; |
|
| 227 | 2 | } |
|
| 228 | |||
| 229 | 26 | foreach ($value as $vop => $rval) { |
|
| 230 | 26 | if ($result) { |
|
| 231 | 4 | $result .= "\n $strop "; |
|
| 232 | 4 | } |
|
| 233 | |||
| 234 | switch ($vop) { |
||
| 235 | 26 | case Db::OP_AND: |
|
| 236 | 26 | case Db::OP_OR: |
|
| 237 | 4 | if (is_numeric($column)) { |
|
| 238 | $innerWhere = $rval; |
||
| 239 | } else { |
||
| 240 | 4 | $innerWhere = [$column => $rval]; |
|
| 241 | } |
||
| 242 | $result .= "(\n ". |
||
| 243 | 4 | $this->buildWhere($innerWhere, $vop). |
|
| 244 | 4 | "\n )"; |
|
| 245 | 4 | break; |
|
| 246 | 26 | case Db::OP_EQ: |
|
| 247 | 6 | if ($rval === null) { |
|
| 248 | $result .= "$btcolumn is null"; |
||
| 249 | 6 | } elseif (is_array($rval)) { |
|
| 250 | 2 | $result .= "$btcolumn in ".$this->bracketList($rval); |
|
| 251 | 2 | } else { |
|
| 252 | 4 | $result .= "$btcolumn = ".$this->quote($rval); |
|
| 253 | } |
||
| 254 | 6 | break; |
|
| 255 | 22 | case Db::OP_GT: |
|
| 256 | 22 | case Db::OP_GTE: |
|
| 257 | 22 | case Db::OP_LT: |
|
| 258 | 22 | case Db::OP_LTE: |
|
| 259 | 12 | $result .= "$btcolumn {$map[$vop]} ".$this->quote($rval); |
|
| 260 | 12 | break; |
|
| 261 | 10 | case Db::OP_LIKE: |
|
| 262 | $result .= $this->buildLike($btcolumn, $rval); |
||
| 263 | break; |
||
| 264 | 10 | case Db::OP_IN: |
|
| 265 | // Quote the in values. |
||
| 266 | 4 | $rval = array_map([$this, 'quote'], (array)$rval); |
|
| 267 | 4 | $result .= "$btcolumn in (".implode(', ', $rval).')'; |
|
| 268 | 4 | break; |
|
| 269 | 6 | case Db::OP_NEQ: |
|
| 270 | 6 | if ($rval === null) { |
|
| 271 | 2 | $result .= "$btcolumn is not null"; |
|
| 272 | 6 | } elseif (is_array($rval)) { |
|
| 273 | 2 | $result .= "$btcolumn not in ".$this->bracketList($rval); |
|
| 274 | 2 | } else { |
|
| 275 | 2 | $result .= "$btcolumn <> ".$this->quote($rval); |
|
| 276 | } |
||
| 277 | 6 | break; |
|
| 278 | } |
||
| 279 | 26 | } |
|
| 280 | } |
||
| 281 | 30 | } else { |
|
| 282 | 27 | if ($result) { |
|
| 283 | 9 | $result .= "\n $strop "; |
|
| 284 | 9 | } |
|
| 285 | |||
| 286 | // This is just an equality operator. |
||
| 287 | 27 | if ($value === null) { |
|
| 288 | 2 | $result .= "$btcolumn is null"; |
|
| 289 | 2 | } else { |
|
| 290 | 25 | $result .= "$btcolumn = ".$this->quote($value); |
|
| 291 | } |
||
| 292 | } |
||
| 293 | 82 | } |
|
| 294 | 82 | return $result; |
|
| 295 | } |
||
| 296 | |||
| 297 | /** |
||
| 298 | * Build a like expression. |
||
| 299 | * |
||
| 300 | * @param string $column The column name. |
||
| 301 | * @param mixed $value The right-hand value. |
||
| 302 | * @return string Returns the like expression. |
||
| 303 | * @internal param bool $quotevals Whether or not to quote the values. |
||
| 304 | */ |
||
| 305 | protected function buildLike($column, $value) { |
||
| 306 | return "$column like ".$this->quote($value); |
||
| 307 | } |
||
| 308 | |||
| 309 | /** |
||
| 310 | * Convert an array into a bracketed list suitable for MySQL clauses. |
||
| 311 | * |
||
| 312 | * @param array $row The row to expand. |
||
| 313 | * @param string $quote The quotes to surroud the items with. There are two special cases. |
||
| 314 | * ' (single quote) |
||
| 315 | * : The row will be passed through {@link PDO::quote()}. |
||
| 316 | * ` (backticks) |
||
| 317 | * : The row will be passed through {@link MySqlDb::backtick()}. |
||
| 318 | * @return string Returns the bracket list. |
||
| 319 | */ |
||
| 320 | 74 | public function bracketList($row, $quote = "'") { |
|
| 334 | |||
| 335 | |||
| 336 | /** |
||
| 337 | * Get the current database name. |
||
| 338 | * |
||
| 339 | * @return mixed |
||
| 340 | */ |
||
| 341 | 5 | private function getDbName() { |
|
| 347 | |||
| 348 | /** |
||
| 349 | * {@inheritdoc} |
||
| 350 | */ |
||
| 351 | 17 | protected function nativeDbType(array $type) { |
|
| 367 | |||
| 368 | /** |
||
| 369 | * Parse a column type string and return it in a way that is suitable for a create/alter table statement. |
||
| 370 | * |
||
| 371 | * @param string $typeString The string to parse. |
||
| 372 | * @return string Returns a canonical string. |
||
| 373 | */ |
||
| 374 | protected function columnTypeString($typeString) { |
||
| 417 | |||
| 418 | /** |
||
| 419 | * Get the indexes from the database. |
||
| 420 | * |
||
| 421 | * @param string $table The name of the table to get the indexes for. |
||
| 422 | * @return array|null |
||
| 423 | */ |
||
| 424 | 4 | protected function fetchIndexesDb($table = '') { |
|
| 460 | |||
| 461 | /** |
||
| 462 | * {@inheritdoc} |
||
| 463 | */ |
||
| 464 | protected function fetchTableNamesDb() { |
||
| 480 | |||
| 481 | /** |
||
| 482 | * {@inheritdoc} |
||
| 483 | */ |
||
| 484 | 17 | public function insert($table, array $row, array $options = []) { |
|
| 493 | |||
| 494 | /** |
||
| 495 | * Build an insert statement. |
||
| 496 | * |
||
| 497 | * @param string|Identifier $table The name of the table to insert to. |
||
| 498 | * @param array $row The row to insert. |
||
| 499 | * @param array $options An array of options for the insert. See {@link Db::insert} for the options. |
||
| 500 | * @return string Returns the the sql string of the insert statement. |
||
| 501 | */ |
||
| 502 | 33 | protected function buildInsert($table, array $row, $options = []) { |
|
| 521 | |||
| 522 | /** |
||
| 523 | * Build an upsert statement. |
||
| 524 | * |
||
| 525 | * An upsert statement is an insert on duplicate key statement in MySQL. |
||
| 526 | * |
||
| 527 | * @param string $table The name of the table to update. |
||
| 528 | * @param array $row The row to insert or update. |
||
| 529 | * @param array $options An array of additional query options. |
||
| 530 | * @return string Returns the upsert statement as a string. |
||
| 531 | */ |
||
| 532 | 2 | protected function buildUpsert($table, array $row, $options = []) { |
|
| 546 | |||
| 547 | /** |
||
| 548 | * {@inheritdoc} |
||
| 549 | */ |
||
| 550 | 54 | public function load($table, $rows, array $options = []) { |
|
| 551 | 54 | $count = 0; |
|
| 552 | 54 | $first = true; |
|
| 553 | 54 | $spec = []; |
|
|
1 ignored issue
–
show
|
|||
| 554 | 54 | $stmt = null; |
|
|
1 ignored issue
–
show
|
|||
| 555 | |||
| 556 | // Loop over the rows and insert them with the statement. |
||
| 557 | 54 | foreach ($rows as $row) { |
|
| 558 | 44 | if ($first) { |
|
| 559 | // Build the insert statement from the first row. |
||
| 560 | 44 | foreach ($row as $key => $value) { |
|
| 561 | 44 | $spec[$key] = new Literal($this->paramName($key)); |
|
| 562 | 44 | } |
|
| 563 | |||
| 564 | 44 | $sql = $this->buildInsert($table, $spec, $options); |
|
| 565 | 44 | $stmt = $this->getPDO()->prepare($sql); |
|
|
1 ignored issue
–
show
|
|||
| 566 | 44 | $first = false; |
|
| 567 | 44 | } |
|
| 568 | |||
| 569 | 44 | $args = array_map([$this, 'argValue'], $row); |
|
| 570 | 44 | $stmt->execute($args); |
|
| 571 | 44 | $count += $stmt->rowCount(); |
|
| 572 | 54 | } |
|
| 573 | |||
| 574 | 54 | return $count; |
|
| 575 | } |
||
| 576 | |||
| 577 | /** |
||
| 578 | * Make a valid PDO parameter name from a string. |
||
| 579 | * |
||
| 580 | * This method replaces invalid placeholder characters with underscores. |
||
| 581 | * |
||
| 582 | * @param string $name The name to replace. |
||
| 583 | * @return string |
||
| 584 | */ |
||
| 585 | 44 | protected function paramName($name) { |
|
| 589 | |||
| 590 | /** |
||
| 591 | * {@inheritdoc} |
||
| 592 | */ |
||
| 593 | 8 | public function update($table, array $set, array $where, array $options = []) { |
|
| 599 | |||
| 600 | /** |
||
| 601 | * Build a sql update statement. |
||
| 602 | * |
||
| 603 | * @param string|Identifier $table The name of the table to update. |
||
| 604 | * @param array $set An array of columns to set. |
||
| 605 | * @param array $where The where filter. |
||
| 606 | * @param array $options Additional options for the query. |
||
| 607 | * @return string Returns the update statement as a string. |
||
| 608 | */ |
||
| 609 | 3 | protected function buildUpdate($table, array $set, array $where, array $options = []) { |
|
| 629 | |||
| 630 | /** |
||
| 631 | * {@inheritdoc} |
||
| 632 | */ |
||
| 633 | 30 | public function delete($table, array $where, array $options = []) { |
|
| 648 | |||
| 649 | /** |
||
| 650 | * {@inheritdoc} |
||
| 651 | */ |
||
| 652 | 17 | protected function createTableDb(array $tableDef, array $options = []) { |
|
| 679 | |||
| 680 | /** |
||
| 681 | * Construct a column definition string from an array defintion. |
||
| 682 | * |
||
| 683 | * @param string $name The name of the column. |
||
| 684 | * @param array $cdef The column definition. |
||
| 685 | * @return string Returns a string representing the column definition. |
||
| 686 | */ |
||
| 687 | 17 | protected function columnDefString($name, array $cdef) { |
|
| 704 | |||
| 705 | /** |
||
| 706 | * Return the SDL string that defines an index. |
||
| 707 | * |
||
| 708 | * @param string $table The name of the table that the index is on. |
||
| 709 | * @param array $def The index definition. This definition should have the following keys. |
||
| 710 | * |
||
| 711 | * columns |
||
| 712 | * : An array of columns in the index. |
||
| 713 | * type |
||
| 714 | * : One of "index", "unique", or "primary". |
||
| 715 | * @return null|string Returns the index string or null if the index is not correct. |
||
| 716 | */ |
||
| 717 | 17 | protected function indexDefString($table, array $def) { |
|
| 729 | |||
| 730 | /** |
||
| 731 | * {@inheritdoc} |
||
| 732 | */ |
||
| 733 | 4 | protected function alterTableDb(array $alterDef, array $options = []) { |
|
| 772 | |||
| 773 | /** |
||
| 774 | * Get an array of column orders so that added columns can be slotted into their correct spot. |
||
| 775 | * |
||
| 776 | * @param array $cdefs An array of column definitions. |
||
| 777 | * @return array Returns an array of column orders suitable for an `alter table` statement. |
||
| 778 | */ |
||
| 779 | 4 | private function getColumnOrders($cdefs) { |
|
| 789 | |||
| 790 | /** |
||
| 791 | * Force a value into the appropriate php type based on its SQL type. |
||
| 792 | * |
||
| 793 | * @param mixed $value The value to force. |
||
| 794 | * @param string $type The sqlite type name. |
||
| 795 | * @return mixed Returns $value cast to the appropriate type. |
||
| 796 | */ |
||
| 797 | 4 | protected function forceType($value, $type) { |
|
| 814 | |||
| 815 | 41 | public function quote($value, $column = '') { |
|
| 824 | |||
| 825 | /** |
||
| 826 | * Convert a value into something usable as a PDO parameter. |
||
| 827 | * |
||
| 828 | * @param mixed $value The value to convert. |
||
| 829 | * @return mixed Returns the converted value or the value itself if it's fine. |
||
| 830 | */ |
||
| 831 | 44 | private function argValue($value) { |
|
| 840 | } |
||
| 841 |
Loading history...
This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.
To visualize
will produce issues in the first and second line, while this second example
will produce no issues.