carono /
yii2-migrate
| Total Complexity | 110 |
| Total Lines | 555 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like MigrationTrait 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.
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 MigrationTrait, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 21 | trait MigrationTrait |
||
| 22 | { |
||
| 23 | |||
| 24 | /** |
||
| 25 | * @param $refTable |
||
| 26 | * @param null $refColumn |
||
| 27 | * |
||
| 28 | * @param string $type |
||
| 29 | * @param null $length |
||
| 30 | * @return ForeignKeyColumn |
||
| 31 | */ |
||
| 32 | public function foreignKey($refTable = null, $refColumn = null, $type = Schema::TYPE_INTEGER, $length = null) |
||
| 33 | { |
||
| 34 | return (new ForeignKeyColumn($type, $length))->refTable($refTable)->refColumn($refColumn)->setMigrate($this); |
||
| 35 | } |
||
| 36 | |||
| 37 | |||
| 38 | /** |
||
| 39 | * @param null $refTable |
||
| 40 | * @param null $refColumn |
||
| 41 | * |
||
| 42 | * @return PivotColumn |
||
| 43 | */ |
||
| 44 | public function pivot($refTable = null, $refColumn = null) |
||
| 45 | { |
||
| 46 | return (new PivotColumn())->refTable($refTable)->refColumn($refColumn)->setMigrate($this); |
||
| 47 | } |
||
| 48 | |||
| 49 | /** |
||
| 50 | * @param string $name |
||
| 51 | * @param string $table |
||
| 52 | * @param array|string $columns |
||
| 53 | * @param bool $unique |
||
| 54 | */ |
||
| 55 | public function createIndex($name, $table, $columns, $unique = false) |
||
| 56 | { |
||
| 57 | $suffix = $unique ? "unq" : "idx"; |
||
| 58 | if (is_null($name)) { |
||
| 59 | $name = self::formIndexName($table, $columns, $suffix); |
||
| 60 | $name = $this->expandTablePrefix($name); |
||
| 61 | } |
||
| 62 | $name = self::truncateName($name, 64, '_' . $suffix); |
||
| 63 | return parent::createIndex($name, $table, $columns, $unique); |
||
| 64 | } |
||
| 65 | |||
| 66 | /** |
||
| 67 | * @param ColumnSchema $column |
||
| 68 | * @return $this|ColumnSchemaBuilder |
||
| 69 | * @throws \Exception |
||
| 70 | */ |
||
| 71 | public function columnSchemaToBuilder(ColumnSchema $column) |
||
| 72 | { |
||
| 73 | $size = $column->size; |
||
| 74 | $precision = $column->precision; |
||
| 75 | $default = $column->defaultValue; |
||
| 76 | $scale = $column->scale; |
||
| 77 | if ($column->isPrimaryKey && $column->autoIncrement) { |
||
| 78 | return $this->primaryKey(); |
||
| 79 | } |
||
| 80 | switch ($column->type) { |
||
| 81 | case "string": |
||
| 82 | $builder = $this->string($size); |
||
| 83 | break; |
||
| 84 | case "integer": |
||
| 85 | $builder = $this->integer($size); |
||
| 86 | break; |
||
| 87 | case "datetime": |
||
| 88 | $builder = $this->dateTime($precision); |
||
| 89 | break; |
||
| 90 | case "text": |
||
| 91 | $builder = $this->text(); |
||
| 92 | break; |
||
| 93 | case "smallint": |
||
| 94 | if ($size === 1) { |
||
| 95 | $default = (boolean)$default; |
||
| 96 | $builder = $this->boolean(); |
||
| 97 | } else { |
||
| 98 | $builder = $this->smallInteger($size); |
||
| 99 | } |
||
| 100 | break; |
||
| 101 | case "binary": |
||
| 102 | $builder = $this->binary()->defaultValue($default); |
||
| 103 | break; |
||
| 104 | case "decimal": |
||
| 105 | $builder = $this->decimal($precision, $scale); |
||
| 106 | break; |
||
| 107 | case "double": |
||
| 108 | $builder = $this->double($precision)->defaultValue($default); |
||
| 109 | break; |
||
| 110 | default: |
||
| 111 | throw new \Exception("Column ($column->name) type '$column->type' not recognized"); |
||
| 112 | } |
||
| 113 | $builder->defaultValue($default); |
||
| 114 | if (!$column->allowNull) { |
||
| 115 | $builder->notNull(); |
||
| 116 | } |
||
| 117 | $builder->comment($column->comment); |
||
| 118 | return $builder; |
||
| 119 | } |
||
| 120 | |||
| 121 | /** |
||
| 122 | * @param $name |
||
| 123 | * @return mixed |
||
| 124 | */ |
||
| 125 | public function expandTablePrefix($name) |
||
| 126 | { |
||
| 127 | return self::setTablePrefix($name, $this->db->tablePrefix); |
||
| 128 | } |
||
| 129 | |||
| 130 | /** |
||
| 131 | * @param $name |
||
| 132 | * @param $prefix |
||
| 133 | * @return mixed |
||
| 134 | * @internal param $prefix |
||
| 135 | */ |
||
| 136 | public static function setTablePrefix($name, $prefix) |
||
| 137 | { |
||
| 138 | return preg_replace('#{{%([\w\d\-_]+)}}#', $prefix . "$1", $name); |
||
| 139 | } |
||
| 140 | |||
| 141 | /** |
||
| 142 | * @param string $table |
||
| 143 | * @param array $columns |
||
| 144 | * @param null $options |
||
| 145 | */ |
||
| 146 | public function createTable($table, $columns, $options = null) |
||
| 147 | { |
||
| 148 | /** |
||
| 149 | * @var PivotColumn[] $pvs |
||
| 150 | * @var ForeignKeyColumn[] $fks |
||
| 151 | */ |
||
| 152 | echo " > create table $table ..."; |
||
| 153 | $time = microtime(true); |
||
| 154 | $pvs = []; |
||
| 155 | $fks = []; |
||
| 156 | $pks = []; |
||
| 157 | foreach ($columns as $column => &$type) { |
||
| 158 | if ($type instanceof ColumnSchema) { |
||
| 159 | $column = is_numeric($column) ? $type->name : $column; |
||
| 160 | $type = $this->columnSchemaToBuilder($type); |
||
| 161 | } |
||
| 162 | if ((string)$type == (string)$this->primaryKey()) { |
||
| 163 | $pks[] = $column; |
||
| 164 | } |
||
| 165 | if ($type instanceof ForeignKeyColumn) { |
||
| 166 | $type->sourceTable($table)->sourceColumn($column); |
||
| 167 | $fks[] = $type; |
||
| 168 | } |
||
| 169 | |||
| 170 | if ($type instanceof PivotColumn) { |
||
| 171 | $type->setName($column)->sourceTable($table); |
||
| 172 | $pvs[] = $type; |
||
| 173 | unset($columns[$column]); |
||
| 174 | } |
||
| 175 | } |
||
| 176 | if (count($pks) > 1) { |
||
| 177 | foreach ($columns as $column => &$type) { |
||
| 178 | $type = $this->integer(); |
||
| 179 | } |
||
| 180 | } |
||
| 181 | $this->db->createCommand()->createTable($table, $columns, $options)->execute(); |
||
| 182 | foreach ($columns as $column => $type) { |
||
| 183 | if ($type instanceof ColumnSchemaBuilder && $type->comment !== null) { |
||
| 184 | $this->db->createCommand()->addCommentOnColumn($table, $column, $type->comment)->execute(); |
||
| 185 | } |
||
| 186 | } |
||
| 187 | foreach ($fks as $fk) { |
||
| 188 | $fk->apply(); |
||
| 189 | } |
||
| 190 | if (count($pks) > 1) { |
||
| 191 | $this->addPrimaryKey(null, $table, $pks); |
||
| 192 | } |
||
| 193 | foreach ($pvs as $pv) { |
||
| 194 | $pv->apply(); |
||
| 195 | } |
||
| 196 | echo " done (time: " . sprintf('%.3f', microtime(true) - $time) . "s)\n"; |
||
| 197 | } |
||
| 198 | |||
| 199 | /** |
||
| 200 | * @param string $name |
||
| 201 | * @param string $table |
||
| 202 | * @param array|string $columns |
||
| 203 | * @param string $refTable |
||
| 204 | * @param array|string $refColumns |
||
| 205 | * @param null $delete |
||
| 206 | * @param null $update |
||
| 207 | */ |
||
| 208 | public function addForeignKey($name, $table, $columns, $refTable, $refColumns, $delete = null, $update = null) |
||
| 209 | { |
||
| 210 | if (is_null($name)) { |
||
| 211 | $name = self::formFkName($table, $columns, $refTable, $refColumns); |
||
| 212 | $name = $this->expandTablePrefix($name); |
||
| 213 | } |
||
| 214 | $name = self::truncateName($name, 64, '_fk'); |
||
| 215 | return parent::addForeignKey($name, $table, $columns, $refTable, $refColumns, $delete, $update); |
||
| 216 | } |
||
| 217 | |||
| 218 | /** |
||
| 219 | * @inheritdoc |
||
| 220 | */ |
||
| 221 | public function alterColumn($table, $column, $type) |
||
| 229 | } |
||
| 230 | } |
||
| 231 | |||
| 232 | /** |
||
| 233 | * @param string $table |
||
| 234 | * @param string $column |
||
| 235 | * @param string $type |
||
| 236 | * @return void |
||
| 237 | */ |
||
| 238 | public function addColumn($table, $column, $type) |
||
| 239 | { |
||
| 240 | if ($type instanceof ForeignKeyColumn) { |
||
| 241 | parent::addColumn($table, $column, $type); |
||
| 242 | $type->sourceTable($table); |
||
| 243 | $type->sourceColumn($column); |
||
| 244 | $type->apply(); |
||
| 245 | } else { |
||
| 246 | parent::addColumn($table, $column, $type); |
||
| 247 | } |
||
| 248 | } |
||
| 249 | |||
| 250 | /** |
||
| 251 | * @param string $name |
||
| 252 | * @param string $table |
||
| 253 | * @param array|string $columns |
||
| 254 | */ |
||
| 255 | public function addPrimaryKey($name, $table, $columns) |
||
| 256 | { |
||
| 257 | if (is_null($name)) { |
||
| 258 | $name = self::formIndexName($table, $columns, 'pk'); |
||
| 259 | $name = $this->expandTablePrefix($name); |
||
| 260 | } |
||
| 261 | $name = self::truncateName($name, 64, '_pk'); |
||
| 262 | return parent::addPrimaryKey($name, $table, $columns); |
||
| 263 | } |
||
| 264 | |||
| 265 | /** |
||
| 266 | * @return array |
||
| 267 | */ |
||
| 268 | public function newColumns() |
||
| 269 | { |
||
| 270 | return []; |
||
| 271 | } |
||
| 272 | |||
| 273 | /** |
||
| 274 | * @param array $array |
||
| 275 | */ |
||
| 276 | public function downNewColumns($array = []) |
||
| 277 | { |
||
| 278 | $this->_applyNewColumns($array ? $array : $this->newColumns(), true); |
||
| 279 | } |
||
| 280 | |||
| 281 | /** |
||
| 282 | * @param array $array |
||
| 283 | */ |
||
| 284 | public function upNewColumns($array = []) |
||
| 285 | { |
||
| 286 | $this->_applyNewColumns($array ? $array : $this->newColumns(), false); |
||
| 287 | } |
||
| 288 | |||
| 289 | /** |
||
| 290 | * @param array $columns |
||
| 291 | * @param bool $revert |
||
| 292 | */ |
||
| 293 | protected function _applyNewColumns($columns = [], $revert = false) |
||
| 294 | { |
||
| 295 | $columns = $revert ? array_reverse($columns) : $columns; |
||
| 296 | |||
| 297 | $result = []; |
||
| 298 | foreach ($columns as $key => $column) { |
||
| 299 | if (is_numeric($key)) { |
||
| 300 | $result[] = $column; |
||
| 301 | } else { |
||
| 302 | foreach ($column as $columnName => $value) { |
||
| 303 | $result[] = [$key, $columnName, $value]; |
||
| 304 | } |
||
| 305 | } |
||
| 306 | } |
||
| 307 | |||
| 308 | foreach ($result as $column) { |
||
| 309 | if ($column[2] instanceof PivotColumn) { |
||
| 310 | $column[2]->setName($column[1])->sourceTable($column[0]); |
||
| 311 | } |
||
| 312 | if ($revert) { |
||
| 313 | if ($column[2] instanceof PivotColumn) { |
||
| 314 | $column[2]->remove(); |
||
| 315 | continue; |
||
| 316 | } |
||
| 317 | $this->dropColumn($column[0], $column[1], $column[2]); |
||
| 318 | } else { |
||
| 319 | if ($column[2] instanceof PivotColumn) { |
||
| 320 | $column[2]->apply(); |
||
| 321 | continue; |
||
| 322 | } |
||
| 323 | $this->addColumn($column[0], $column[1], $column[2]); |
||
| 324 | } |
||
| 325 | } |
||
| 326 | } |
||
| 327 | |||
| 328 | /** |
||
| 329 | * @param string $table |
||
| 330 | * @param string $column |
||
| 331 | * @param null $type |
||
| 332 | */ |
||
| 333 | public function dropColumn($table, $column, $type = null) |
||
| 334 | { |
||
| 335 | if ($type instanceof ForeignKeyColumn) { |
||
| 336 | $type->sourceTable($table); |
||
| 337 | $type->sourceColumn($column); |
||
| 338 | $type->remove(); |
||
| 339 | } |
||
| 340 | return parent::dropColumn($table, $column); |
||
| 341 | } |
||
| 342 | |||
| 343 | /** |
||
| 344 | * @return array |
||
| 345 | */ |
||
| 346 | public function newTables() |
||
| 347 | { |
||
| 348 | return []; |
||
| 349 | } |
||
| 350 | |||
| 351 | /** |
||
| 352 | * @param array $array |
||
| 353 | * @param null $tableOptions |
||
| 354 | */ |
||
| 355 | public function upNewTables($array = [], $tableOptions = null) |
||
| 358 | } |
||
| 359 | |||
| 360 | /** |
||
| 361 | * @param array $array |
||
| 362 | */ |
||
| 363 | public function upNewIndex($array = []) |
||
| 364 | { |
||
| 365 | $this->_applyNewIndex($array ? $array : $this->newIndex()); |
||
| 366 | } |
||
| 367 | |||
| 368 | /** |
||
| 369 | * @param array $array |
||
| 370 | */ |
||
| 371 | public function downNewIndex($array = []) |
||
| 372 | { |
||
| 373 | $this->_applyNewIndex($array ? $array : $this->newIndex(), true); |
||
| 374 | } |
||
| 375 | |||
| 376 | /** |
||
| 377 | * @return array |
||
| 378 | */ |
||
| 379 | public function newIndex() |
||
| 380 | { |
||
| 381 | return []; |
||
| 382 | } |
||
| 383 | |||
| 384 | /** |
||
| 385 | * @param array $array |
||
| 386 | */ |
||
| 387 | public function downNewTables($array = []) |
||
| 388 | { |
||
| 389 | $this->_applyNewTables($array ? $array : $this->newTables(), true); |
||
| 390 | } |
||
| 391 | |||
| 392 | /** |
||
| 393 | * @param $indexes |
||
| 394 | * @param bool $revert |
||
| 395 | */ |
||
| 396 | protected function _applyNewIndex($indexes, $revert = false) |
||
| 397 | { |
||
| 398 | /** |
||
| 399 | * @var ForeignKeyColumn $fk |
||
| 400 | */ |
||
| 401 | $indexes = $revert ? array_reverse($indexes) : $indexes; |
||
| 402 | foreach ($indexes as $key => $data) { |
||
| 403 | $unq = isset($data[2]) && $data[2]; |
||
| 404 | $columns = is_array($data[1]) ? $data[1] : explode(',', $data[1]); |
||
| 405 | $table = $data[0]; |
||
| 406 | $fk = null; |
||
| 407 | if (isset($data[2]) && $data[2] instanceof ForeignKeyColumn) { |
||
| 408 | $fk = $data[2]; |
||
| 409 | $fk->sourceTable($table); |
||
| 410 | $fk->sourceColumn($columns[0]); |
||
| 411 | } |
||
| 412 | |||
| 413 | $name = self::expandTablePrefix(self::formIndexName($data[0], $columns, $unq ? "unq" : "idx")); |
||
| 414 | if ($revert) { |
||
| 415 | if ($fk) { |
||
| 416 | $fk->remove(); |
||
| 417 | } else { |
||
| 418 | $this->dropIndex($name, $data[0]); |
||
| 419 | } |
||
| 420 | } else { |
||
| 421 | if ($fk) { |
||
| 422 | $fk->apply(); |
||
| 423 | } else { |
||
| 424 | $this->createIndex($name, $data[0], join(',', $columns), $unq); |
||
| 425 | } |
||
| 426 | } |
||
| 427 | } |
||
| 428 | } |
||
| 429 | |||
| 430 | protected function _applyNewTables($tables, $revert = false, $tableOptions = null) |
||
| 431 | { |
||
| 432 | $tables = $revert ? array_reverse($tables) : $tables; |
||
| 433 | foreach ($tables as $table => $columns) { |
||
| 434 | if ($revert) { |
||
| 435 | foreach ($columns as $column => $type) { |
||
| 436 | if ($type instanceof PivotColumn) { |
||
| 437 | $type->setName($column)->sourceTable($table); |
||
| 438 | $type->remove(); |
||
| 439 | } |
||
| 440 | } |
||
| 441 | $this->dropTable($table); |
||
| 442 | } else { |
||
| 443 | $tableOptions = ArrayHelper::remove($columns, 'tableOptions', $tableOptions); |
||
| 444 | $this->createTable($table, $columns, $tableOptions); |
||
| 445 | } |
||
| 446 | } |
||
| 447 | } |
||
| 448 | |||
| 449 | public static function formFkName($table, $column, $refTable, $refColumn) |
||
| 450 | { |
||
| 451 | $table = count(($t = explode('.', $table))) > 1 ? $t[1] : $t[0]; |
||
| 452 | $refTable = count(($t = explode('.', $refTable))) > 1 ? $t[1] : $t[0]; |
||
| 453 | return "{$table}[{$column}]_{$refTable}[{$refColumn}]_fk"; |
||
| 454 | } |
||
| 455 | |||
| 456 | public static function formPkIndexName($table, $columns, $suffix = "pk") |
||
| 457 | { |
||
| 458 | return self::formIndexName($table, $columns, $suffix); |
||
| 459 | } |
||
| 460 | |||
| 461 | public static function formIndexName($table, $columns, $suffix = "idx") |
||
| 462 | { |
||
| 463 | $table = self::removeSchema($table); |
||
| 464 | $column = join(':', array_map('trim', (array)$columns)); |
||
| 465 | return "{$table}:{$column}_$suffix"; |
||
| 466 | } |
||
| 467 | |||
| 468 | public function insertTo($table, $rows, $idStart = 1, $updateSeq = 'id') |
||
| 469 | { |
||
| 470 | $c = $idStart; |
||
| 471 | foreach ($rows as $row) { |
||
| 472 | if (!isset($row["id"]) && !is_null($idStart)) { |
||
| 473 | $row += ["id" => $c++]; |
||
| 474 | } |
||
| 475 | $this->insert($table, $row); |
||
| 476 | } |
||
| 477 | if ($updateSeq) { |
||
| 478 | $c = (int)\Yii::$app->db->createCommand("SELECT count(*) FROM {{$table}}")->queryScalar() + 1; |
||
| 479 | $this->execute("ALTER SEQUENCE {$table}_{$updateSeq}_seq RESTART WITH $c;"); |
||
| 480 | } |
||
| 481 | } |
||
| 482 | |||
| 483 | public static function removeSchema($str) |
||
| 490 | } |
||
| 491 | } |
||
| 492 | |||
| 493 | /** |
||
| 494 | * @param $table |
||
| 495 | * @param $column |
||
| 496 | * @return false|null|string |
||
| 497 | */ |
||
| 498 | protected function getForeignKey($table, $column) |
||
| 506 | } |
||
| 507 | |||
| 508 | protected function getIndexName($table, $column) |
||
| 509 | { |
||
| 510 | $condition = [':t' => $this->expandTablePrefix($table), ':c' => $column]; |
||
| 511 | |||
| 512 | if ($this->db->driverName == 'pgsql') { |
||
| 513 | $sql = <<<SQL |
||
| 514 | SELECT |
||
| 515 | i.relname |
||
| 516 | FROM |
||
| 517 | pg_class T, |
||
| 518 | pg_class i, |
||
| 519 | pg_index ix, |
||
| 520 | pg_attribute A |
||
| 521 | WHERE |
||
| 522 | T .oid = ix.indrelid |
||
| 523 | AND i.oid = ix.indexrelid |
||
| 524 | AND A .attrelid = T .oid |
||
| 525 | AND A .attnum = ANY (ix.indkey) |
||
| 526 | AND T .relname = :t |
||
| 527 | AND A .attname = :c |
||
| 528 | SQL; |
||
| 529 | } else { |
||
| 530 | $sql = "SELECT DISTINCT CONSTRAINT_NAME FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE WHERE TABLE_NAME=:t AND COLUMN_NAME=:c AND CONSTRAINT_SCHEMA=DATABASE()"; |
||
| 531 | } |
||
| 532 | return $this->db->createCommand($sql, $condition)->queryScalar(); |
||
| 533 | } |
||
| 534 | |||
| 535 | /** |
||
| 536 | * @param $table |
||
| 537 | * @param $column |
||
| 538 | */ |
||
| 539 | public function dropIndexByColumn($table, $column) |
||
| 540 | { |
||
| 541 | if ($key = $this->getIndexName($table, $column)) { |
||
| 542 | $this->dropIndex($key, $table); |
||
| 543 | } |
||
| 544 | } |
||
| 545 | |||
| 546 | /** |
||
| 547 | * @param $table |
||
| 548 | * @param $column |
||
| 549 | */ |
||
| 550 | public function dropForeignKeyByColumn($table, $column) |
||
| 554 | } |
||
| 555 | } |
||
| 556 | |||
| 557 | /** |
||
| 558 | * Принудительно обрезаем названия ключей, если они получаются больше чем $length, т.к. базы могут вылететь с ошибкой |
||
| 559 | * |
||
| 560 | * @see https://dev.mysql.com/doc/refman/5.7/en/identifiers.html |
||
| 561 | * |
||
| 562 | * @param $name |
||
| 563 | * @param int $length |
||
| 564 | * @param null $suffix |
||
| 565 | * @return bool|string |
||
| 566 | */ |
||
| 567 | public static function truncateName($name, $length = 64, $suffix = null) |
||
| 568 | { |
||
| 569 | if (strlen($name) > $length) { |
||
| 570 | if (StringHelper::endsWith($name, $suffix)) { |
||
| 571 | $name = substr($name, 0, strlen($suffix) * -1); |
||
| 572 | } |
||
| 573 | return dechex(crc32($name)) . $suffix; |
||
| 574 | } else { |
||
| 575 | return $name; |
||
| 578 | } |
Loading history...