yiisoft /
yii2
Complex classes like Migration 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 Migration, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 46 | class Migration extends Component implements MigrationInterface |
||
| 47 | { |
||
| 48 | use SchemaBuilderTrait; |
||
| 49 | |||
| 50 | /** |
||
| 51 | * @var Connection|array|string the DB connection object or the application component ID of the DB connection |
||
| 52 | * that this migration should work with. Starting from version 2.0.2, this can also be a configuration array |
||
| 53 | * for creating the object. |
||
| 54 | * |
||
| 55 | * Note that when a Migration object is created by the `migrate` command, this property will be overwritten |
||
| 56 | * by the command. If you do not want to use the DB connection provided by the command, you may override |
||
| 57 | * the [[init()]] method like the following: |
||
| 58 | * |
||
| 59 | * ```php |
||
| 60 | * public function init() |
||
| 61 | * { |
||
| 62 | * $this->db = 'db2'; |
||
| 63 | * parent::init(); |
||
| 64 | * } |
||
| 65 | * ``` |
||
| 66 | */ |
||
| 67 | public $db = 'db'; |
||
| 68 | |||
| 69 | /** |
||
| 70 | * @var int max number of characters of the SQL outputted. Useful for reduction of long statements and making |
||
| 71 | * console output more compact. |
||
| 72 | * @since 2.0.13 |
||
| 73 | */ |
||
| 74 | public $maxSqlOutputLength; |
||
| 75 | |||
| 76 | /** |
||
| 77 | * Initializes the migration. |
||
| 78 | * This method will set [[db]] to be the 'db' application component, if it is `null`. |
||
| 79 | */ |
||
| 80 | 20 | public function init() |
|
| 81 | { |
||
| 82 | 20 | parent::init(); |
|
| 83 | 20 | $this->db = Instance::ensure($this->db, Connection::class); |
|
| 84 | 20 | $this->db->getSchema()->refresh(); |
|
| 85 | 20 | $this->db->enableSlaves = false; |
|
| 86 | 20 | } |
|
| 87 | |||
| 88 | /** |
||
| 89 | * @inheritdoc |
||
| 90 | * @since 2.0.6 |
||
| 91 | */ |
||
| 92 | 7 | protected function getDb() |
|
| 93 | { |
||
| 94 | 7 | return $this->db; |
|
| 95 | } |
||
| 96 | |||
| 97 | /** |
||
| 98 | * This method contains the logic to be executed when applying this migration. |
||
| 99 | * Child classes may override this method to provide actual migration logic. |
||
| 100 | * @return bool return a false value to indicate the migration fails |
||
| 101 | * and should not proceed further. All other return values mean the migration succeeds. |
||
| 102 | */ |
||
| 103 | 1 | public function up() |
|
| 104 | { |
||
| 105 | 1 | $transaction = $this->db->beginTransaction(); |
|
| 106 | try { |
||
| 107 | 1 | if ($this->safeUp() === false) { |
|
| 108 | $transaction->rollBack(); |
||
| 109 | return false; |
||
| 110 | } |
||
| 111 | 1 | $transaction->commit(); |
|
| 112 | } catch (\Throwable $e) { |
||
|
|
|||
| 113 | $this->printException($e); |
||
| 114 | $transaction->rollBack(); |
||
| 115 | return false; |
||
| 116 | } |
||
| 117 | |||
| 118 | 1 | return null; |
|
| 119 | } |
||
| 120 | |||
| 121 | /** |
||
| 122 | * This method contains the logic to be executed when removing this migration. |
||
| 123 | * The default implementation throws an exception indicating the migration cannot be removed. |
||
| 124 | * Child classes may override this method if the corresponding migrations can be removed. |
||
| 125 | * @return bool return a false value to indicate the migration fails |
||
| 126 | * and should not proceed further. All other return values mean the migration succeeds. |
||
| 127 | */ |
||
| 128 | public function down() |
||
| 129 | { |
||
| 130 | $transaction = $this->db->beginTransaction(); |
||
| 131 | try { |
||
| 132 | if ($this->safeDown() === false) { |
||
| 133 | $transaction->rollBack(); |
||
| 134 | return false; |
||
| 135 | } |
||
| 136 | $transaction->commit(); |
||
| 137 | } catch (\Throwable $e) { |
||
| 138 | $this->printException($e); |
||
| 139 | $transaction->rollBack(); |
||
| 140 | return false; |
||
| 141 | } |
||
| 142 | |||
| 143 | return null; |
||
| 144 | } |
||
| 145 | |||
| 146 | /** |
||
| 147 | * @param \Throwable $e |
||
| 148 | */ |
||
| 149 | private function printException($e) |
||
| 150 | { |
||
| 151 | echo 'Exception: ' . $e->getMessage() . ' (' . $e->getFile() . ':' . $e->getLine() . ")\n"; |
||
| 152 | echo $e->getTraceAsString() . "\n"; |
||
| 153 | } |
||
| 154 | |||
| 155 | /** |
||
| 156 | * This method contains the logic to be executed when applying this migration. |
||
| 157 | * This method differs from [[up()]] in that the DB logic implemented here will |
||
| 158 | * be enclosed within a DB transaction. |
||
| 159 | * Child classes may implement this method instead of [[up()]] if the DB logic |
||
| 160 | * needs to be within a transaction. |
||
| 161 | * |
||
| 162 | * Note: Not all DBMS support transactions. And some DB queries cannot be put into a transaction. For some examples, |
||
| 163 | * please refer to [implicit commit](http://dev.mysql.com/doc/refman/5.7/en/implicit-commit.html). If this is the case, |
||
| 164 | * you should still implement `up()` and `down()`, instead. |
||
| 165 | * |
||
| 166 | * @return bool return a false value to indicate the migration fails |
||
| 167 | * and should not proceed further. All other return values mean the migration succeeds. |
||
| 168 | */ |
||
| 169 | public function safeUp() |
||
| 170 | { |
||
| 171 | } |
||
| 172 | |||
| 173 | /** |
||
| 174 | * This method contains the logic to be executed when removing this migration. |
||
| 175 | * This method differs from [[down()]] in that the DB logic implemented here will |
||
| 176 | * be enclosed within a DB transaction. |
||
| 177 | * Child classes may implement this method instead of [[down()]] if the DB logic |
||
| 178 | * needs to be within a transaction. |
||
| 179 | * |
||
| 180 | * Note: Not all DBMS support transactions. And some DB queries cannot be put into a transaction. For some examples, |
||
| 181 | * please refer to [implicit commit](http://dev.mysql.com/doc/refman/5.7/en/implicit-commit.html). If this is the case, |
||
| 182 | * you should still implement `up()` and `down()`, instead. |
||
| 183 | * |
||
| 184 | * @return bool return a false value to indicate the migration fails |
||
| 185 | * and should not proceed further. All other return values mean the migration succeeds. |
||
| 186 | */ |
||
| 187 | public function safeDown() |
||
| 190 | |||
| 191 | /** |
||
| 192 | * Executes a SQL statement. |
||
| 193 | * This method executes the specified SQL statement using [[db]]. |
||
| 194 | * @param string $sql the SQL statement to be executed |
||
| 195 | * @param array $params input parameters (name => value) for the SQL execution. |
||
| 196 | * See [[Command::execute()]] for more details. |
||
| 197 | */ |
||
| 198 | public function execute($sql, $params = []) |
||
| 199 | { |
||
| 200 | $sqlOutput = $sql; |
||
| 201 | if ($this->maxSqlOutputLength !== null) { |
||
| 202 | $sqlOutput = StringHelper::truncate($sql, $this->maxSqlOutputLength, '[... hidden]'); |
||
| 203 | } |
||
| 204 | |||
| 205 | echo " > execute SQL: $sqlOutput ..."; |
||
| 206 | $time = microtime(true); |
||
| 207 | $this->db->createCommand($sql)->bindValues($params)->execute(); |
||
| 208 | echo ' done (time: ' . sprintf('%.3f', microtime(true) - $time) . "s)\n"; |
||
| 209 | } |
||
| 210 | |||
| 211 | /** |
||
| 212 | * Creates and executes an INSERT SQL statement. |
||
| 213 | * The method will properly escape the column names, and bind the values to be inserted. |
||
| 214 | * @param string $table the table that new rows will be inserted into. |
||
| 215 | * @param array $columns the column data (name => value) to be inserted into the table. |
||
| 216 | */ |
||
| 217 | public function insert($table, $columns) |
||
| 218 | { |
||
| 219 | echo " > insert into $table ..."; |
||
| 220 | $time = microtime(true); |
||
| 221 | $this->db->createCommand()->insert($table, $columns)->execute(); |
||
| 222 | echo ' done (time: ' . sprintf('%.3f', microtime(true) - $time) . "s)\n"; |
||
| 223 | } |
||
| 224 | |||
| 225 | /** |
||
| 226 | * Creates and executes an batch INSERT SQL statement. |
||
| 227 | * The method will properly escape the column names, and bind the values to be inserted. |
||
| 228 | * @param string $table the table that new rows will be inserted into. |
||
| 229 | * @param array $columns the column names. |
||
| 230 | * @param array $rows the rows to be batch inserted into the table |
||
| 231 | */ |
||
| 232 | public function batchInsert($table, $columns, $rows) |
||
| 239 | |||
| 240 | /** |
||
| 241 | * Creates and executes an UPDATE SQL statement. |
||
| 242 | * The method will properly escape the column names and bind the values to be updated. |
||
| 243 | * @param string $table the table to be updated. |
||
| 244 | * @param array $columns the column data (name => value) to be updated. |
||
| 245 | * @param array|string $condition the conditions that will be put in the WHERE part. Please |
||
| 246 | * refer to [[Query::where()]] on how to specify conditions. |
||
| 247 | * @param array $params the parameters to be bound to the query. |
||
| 248 | */ |
||
| 249 | public function update($table, $columns, $condition = '', $params = []) |
||
| 256 | |||
| 257 | /** |
||
| 258 | * Creates and executes a DELETE SQL statement. |
||
| 259 | * @param string $table the table where the data will be deleted from. |
||
| 260 | * @param array|string $condition the conditions that will be put in the WHERE part. Please |
||
| 261 | * refer to [[Query::where()]] on how to specify conditions. |
||
| 262 | * @param array $params the parameters to be bound to the query. |
||
| 263 | */ |
||
| 264 | public function delete($table, $condition = '', $params = []) |
||
| 271 | |||
| 272 | /** |
||
| 273 | * Builds and executes a SQL statement for creating a new DB table. |
||
| 274 | * |
||
| 275 | * The columns in the new table should be specified as name-definition pairs (e.g. 'name' => 'string'), |
||
| 276 | * where name stands for a column name which will be properly quoted by the method, and definition |
||
| 277 | * stands for the column type which can contain an abstract DB type. |
||
| 278 | * |
||
| 279 | * The [[QueryBuilder::getColumnType()]] method will be invoked to convert any abstract type into a physical one. |
||
| 280 | * |
||
| 281 | * If a column is specified with definition only (e.g. 'PRIMARY KEY (name, type)'), it will be directly |
||
| 282 | * put into the generated SQL. |
||
| 283 | * |
||
| 284 | * @param string $table the name of the table to be created. The name will be properly quoted by the method. |
||
| 285 | * @param array $columns the columns (name => definition) in the new table. |
||
| 286 | * @param string $options additional SQL fragment that will be appended to the generated SQL. |
||
| 287 | */ |
||
| 288 | 7 | public function createTable($table, $columns, $options = null) |
|
| 300 | |||
| 301 | /** |
||
| 302 | * Builds and executes a SQL statement for renaming a DB table. |
||
| 303 | * @param string $table the table to be renamed. The name will be properly quoted by the method. |
||
| 304 | * @param string $newName the new table name. The name will be properly quoted by the method. |
||
| 305 | */ |
||
| 306 | public function renameTable($table, $newName) |
||
| 313 | |||
| 314 | /** |
||
| 315 | * Builds and executes a SQL statement for dropping a DB table. |
||
| 316 | * @param string $table the table to be dropped. The name will be properly quoted by the method. |
||
| 317 | */ |
||
| 318 | 7 | public function dropTable($table) |
|
| 325 | |||
| 326 | /** |
||
| 327 | * Builds and executes a SQL statement for truncating a DB table. |
||
| 328 | * @param string $table the table to be truncated. The name will be properly quoted by the method. |
||
| 329 | */ |
||
| 330 | public function truncateTable($table) |
||
| 337 | |||
| 338 | /** |
||
| 339 | * Builds and executes a SQL statement for adding a new DB column. |
||
| 340 | * @param string $table the table that the new column will be added to. The table name will be properly quoted by the method. |
||
| 341 | * @param string $column the name of the new column. The name will be properly quoted by the method. |
||
| 342 | * @param string $type the column type. The [[QueryBuilder::getColumnType()]] method will be invoked to convert abstract column type (if any) |
||
| 343 | * into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL. |
||
| 344 | * For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'. |
||
| 345 | */ |
||
| 346 | public function addColumn($table, $column, $type) |
||
| 356 | |||
| 357 | /** |
||
| 358 | * Builds and executes a SQL statement for dropping a DB column. |
||
| 359 | * @param string $table the table whose column is to be dropped. The name will be properly quoted by the method. |
||
| 360 | * @param string $column the name of the column to be dropped. The name will be properly quoted by the method. |
||
| 361 | */ |
||
| 362 | public function dropColumn($table, $column) |
||
| 369 | |||
| 370 | /** |
||
| 371 | * Builds and executes a SQL statement for renaming a column. |
||
| 372 | * @param string $table the table whose column is to be renamed. The name will be properly quoted by the method. |
||
| 373 | * @param string $name the old name of the column. The name will be properly quoted by the method. |
||
| 374 | * @param string $newName the new name of the column. The name will be properly quoted by the method. |
||
| 375 | */ |
||
| 376 | public function renameColumn($table, $name, $newName) |
||
| 383 | |||
| 384 | /** |
||
| 385 | * Builds and executes a SQL statement for changing the definition of a column. |
||
| 386 | * @param string $table the table whose column is to be changed. The table name will be properly quoted by the method. |
||
| 387 | * @param string $column the name of the column to be changed. The name will be properly quoted by the method. |
||
| 388 | * @param string $type the new column type. The [[QueryBuilder::getColumnType()]] method will be invoked to convert abstract column type (if any) |
||
| 389 | * into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL. |
||
| 390 | * For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'. |
||
| 391 | */ |
||
| 392 | public function alterColumn($table, $column, $type) |
||
| 402 | |||
| 403 | /** |
||
| 404 | * Builds and executes a SQL statement for creating a primary key. |
||
| 405 | * The method will properly quote the table and column names. |
||
| 406 | * @param string $name the name of the primary key constraint. |
||
| 407 | * @param string $table the table that the primary key constraint will be added to. |
||
| 408 | * @param string|array $columns comma separated string or array of columns that the primary key will consist of. |
||
| 409 | */ |
||
| 410 | public function addPrimaryKey($name, $table, $columns) |
||
| 417 | |||
| 418 | /** |
||
| 419 | * Builds and executes a SQL statement for dropping a primary key. |
||
| 420 | * @param string $name the name of the primary key constraint to be removed. |
||
| 421 | * @param string $table the table that the primary key constraint will be removed from. |
||
| 422 | */ |
||
| 423 | public function dropPrimaryKey($name, $table) |
||
| 430 | |||
| 431 | /** |
||
| 432 | * Builds a SQL statement for adding a foreign key constraint to an existing table. |
||
| 433 | * The method will properly quote the table and column names. |
||
| 434 | * @param string $name the name of the foreign key constraint. |
||
| 435 | * @param string $table the table that the foreign key constraint will be added to. |
||
| 436 | * @param string|array $columns the name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas or use an array. |
||
| 437 | * @param string $refTable the table that the foreign key references to. |
||
| 438 | * @param string|array $refColumns the name of the column that the foreign key references to. If there are multiple columns, separate them with commas or use an array. |
||
| 439 | * @param string $delete the ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL |
||
| 440 | * @param string $update the ON UPDATE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL |
||
| 441 | */ |
||
| 442 | public function addForeignKey($name, $table, $columns, $refTable, $refColumns, $delete = null, $update = null) |
||
| 449 | |||
| 450 | /** |
||
| 451 | * Builds a SQL statement for dropping a foreign key constraint. |
||
| 452 | * @param string $name the name of the foreign key constraint to be dropped. The name will be properly quoted by the method. |
||
| 453 | * @param string $table the table whose foreign is to be dropped. The name will be properly quoted by the method. |
||
| 454 | */ |
||
| 455 | public function dropForeignKey($name, $table) |
||
| 462 | |||
| 463 | /** |
||
| 464 | * Builds and executes a SQL statement for creating a new index. |
||
| 465 | * @param string $name the name of the index. The name will be properly quoted by the method. |
||
| 466 | * @param string $table the table that the new index will be created for. The table name will be properly quoted by the method. |
||
| 467 | * @param string|array $columns the column(s) that should be included in the index. If there are multiple columns, please separate them |
||
| 468 | * by commas or use an array. Each column name will be properly quoted by the method. Quoting will be skipped for column names that |
||
| 469 | * include a left parenthesis "(". |
||
| 470 | * @param bool $unique whether to add UNIQUE constraint on the created index. |
||
| 471 | */ |
||
| 472 | 6 | public function createIndex($name, $table, $columns, $unique = false) |
|
| 479 | |||
| 480 | /** |
||
| 481 | * Builds and executes a SQL statement for dropping an index. |
||
| 482 | * @param string $name the name of the index to be dropped. The name will be properly quoted by the method. |
||
| 483 | * @param string $table the table whose index is to be dropped. The name will be properly quoted by the method. |
||
| 484 | */ |
||
| 485 | public function dropIndex($name, $table) |
||
| 492 | |||
| 493 | /** |
||
| 494 | * Builds and execute a SQL statement for adding comment to column |
||
| 495 | * |
||
| 496 | * @param string $table the table whose column is to be commented. The table name will be properly quoted by the method. |
||
| 497 | * @param string $column the name of the column to be commented. The column name will be properly quoted by the method. |
||
| 498 | * @param string $comment the text of the comment to be added. The comment will be properly quoted by the method. |
||
| 499 | * @since 2.0.8 |
||
| 500 | */ |
||
| 501 | public function addCommentOnColumn($table, $column, $comment) |
||
| 508 | |||
| 509 | /** |
||
| 510 | * Builds a SQL statement for adding comment to table |
||
| 511 | * |
||
| 512 | * @param string $table the table whose column is to be commented. The table name will be properly quoted by the method. |
||
| 513 | * @param string $comment the text of the comment to be added. The comment will be properly quoted by the method. |
||
| 514 | * @since 2.0.8 |
||
| 515 | */ |
||
| 516 | public function addCommentOnTable($table, $comment) |
||
| 523 | |||
| 524 | /** |
||
| 525 | * Builds and execute a SQL statement for dropping comment from column |
||
| 526 | * |
||
| 527 | * @param string $table the table whose column is to be commented. The table name will be properly quoted by the method. |
||
| 528 | * @param string $column the name of the column to be commented. The column name will be properly quoted by the method. |
||
| 529 | * @since 2.0.8 |
||
| 530 | */ |
||
| 531 | public function dropCommentFromColumn($table, $column) |
||
| 538 | |||
| 539 | /** |
||
| 540 | * Builds a SQL statement for dropping comment from table |
||
| 541 | * |
||
| 542 | * @param string $table the table whose column is to be commented. The table name will be properly quoted by the method. |
||
| 543 | * @since 2.0.8 |
||
| 544 | */ |
||
| 545 | public function dropCommentFromTable($table) |
||
| 552 | } |
||
| 553 |
Loading history...
Scrutinizer analyzes your
composer.json/composer.lockfile if available to determine the classes, and functions that are defined by your dependencies.It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.