cakephp /
phinx
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 PdoAdapter 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 PdoAdapter, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 57 | 3 | abstract class PdoAdapter extends AbstractAdapter implements DirectActionInterface |
|
| 58 | { |
||
| 59 | 287 | /** |
|
| 60 | * @var \PDO|null |
||
| 61 | */ |
||
| 62 | protected $connection; |
||
| 63 | |||
| 64 | /** |
||
| 65 | * Writes a message to stdout if verbose output is on |
||
| 66 | * |
||
| 67 | * @param string $message The message to show |
||
| 68 | 193 | * @return void |
|
| 69 | */ |
||
| 70 | 193 | protected function verboseLog($message) |
|
| 79 | |||
| 80 | /** |
||
| 81 | * Create PDO connection |
||
| 82 | * |
||
| 83 | * @param string $dsn |
||
| 84 | * @param string|null $username |
||
| 85 | * @param string|null $password |
||
| 86 | 74 | * @param array $options |
|
| 87 | * @return \PDO |
||
| 88 | */ |
||
| 89 | protected function createPdoConnection($dsn, $username = null, $password = null, array $options = []) |
||
| 104 | 189 | ||
| 105 | 189 | /** |
|
| 106 | 191 | * {@inheritdoc} |
|
| 107 | */ |
||
| 108 | public function setOptions(array $options) |
||
| 118 | |||
| 119 | /** |
||
| 120 | * Sets the database connection. |
||
| 121 | * |
||
| 122 | * @param \PDO $connection Connection |
||
| 123 | * @return \Phinx\Db\Adapter\AdapterInterface |
||
| 124 | */ |
||
| 125 | public function setConnection(\PDO $connection) |
||
| 152 | 151 | ||
| 153 | 151 | /** |
|
| 154 | * Gets the database connection |
||
| 155 | * |
||
| 156 | * @return \PDO |
||
| 157 | */ |
||
| 158 | public function getConnection() |
||
| 166 | 213 | ||
| 167 | /** |
||
| 168 | * {@inheritdoc} |
||
| 169 | */ |
||
| 170 | public function connect() |
||
| 173 | |||
| 174 | 1 | /** |
|
| 175 | 1 | * {@inheritdoc} |
|
| 176 | 1 | */ |
|
| 177 | 1 | public function disconnect() |
|
| 180 | 1 | ||
| 181 | 1 | /** |
|
| 182 | * {@inheritdoc} |
||
| 183 | 1 | */ |
|
| 184 | 1 | public function execute($sql) |
|
| 195 | 11 | ||
| 196 | /** |
||
| 197 | 11 | * Returns the Cake\Database connection object using the same underlying |
|
| 198 | 11 | * PDO object as this connection. |
|
| 199 | 11 | * |
|
| 200 | * @return \Cake\Database\Connection |
||
| 201 | 11 | */ |
|
| 202 | 11 | abstract public function getDecoratedConnection(); |
|
| 203 | 11 | ||
| 204 | 11 | /** |
|
| 205 | 11 | * {@inheritdoc} |
|
| 206 | 11 | */ |
|
| 207 | public function getQueryBuilder() |
||
| 211 | 11 | ||
| 212 | 11 | /** |
|
| 213 | 11 | * Executes a query and returns PDOStatement. |
|
| 214 | * |
||
| 215 | 11 | * @param string $sql SQL |
|
| 216 | 11 | * @return \PDOStatement |
|
| 217 | 11 | */ |
|
| 218 | public function query($sql) |
||
| 222 | 5 | ||
| 223 | /** |
||
| 224 | 5 | * {@inheritdoc} |
|
| 225 | */ |
||
| 226 | 5 | public function fetchRow($sql) |
|
| 232 | 8 | ||
| 233 | /** |
||
| 234 | 8 | * {@inheritdoc} |
|
| 235 | */ |
||
| 236 | 8 | public function fetchAll($sql) |
|
| 246 | |||
| 247 | 7 | /** |
|
| 248 | 7 | * {@inheritdoc} |
|
| 249 | 7 | */ |
|
| 250 | 7 | public function insert(Table $table, $row) |
|
| 274 | 5 | ||
| 275 | 5 | /** |
|
| 276 | * Quotes a database value. |
||
| 277 | 5 | * |
|
| 278 | 5 | * @param mixed $value The value to quote |
|
| 279 | * @return mixed |
||
| 280 | 3 | */ |
|
| 281 | 3 | private function quoteValue($value) |
|
| 293 | |||
| 294 | /** |
||
| 295 | * Quotes a database string. |
||
| 296 | 1 | * |
|
| 297 | * @param string $value The string to quote |
||
| 298 | 1 | * @return string |
|
| 299 | 1 | */ |
|
| 300 | 1 | protected function quoteString($value) |
|
| 304 | 1 | ||
| 305 | 1 | /** |
|
| 306 | 1 | * {@inheritdoc} |
|
| 307 | 1 | */ |
|
| 308 | 1 | public function bulkinsert(Table $table, $rows) |
|
| 346 | |||
| 347 | /** |
||
| 348 | * {@inheritdoc} |
||
| 349 | 208 | */ |
|
| 350 | public function getVersions() |
||
| 356 | 208 | ||
| 357 | 208 | /** |
|
| 358 | 208 | * {@inheritdoc} |
|
| 359 | 208 | */ |
|
| 360 | 208 | public function getVersionLog() |
|
| 361 | 208 | { |
|
| 362 | 208 | $result = []; |
|
| 363 | 208 | ||
| 364 | 208 | switch ($this->options['version_order']) { |
|
| 365 | 208 | case \Phinx\Config\Config::VERSION_ORDER_CREATION_TIME: |
|
| 366 | 208 | $orderBy = 'version ASC'; |
|
| 367 | 208 | break; |
|
| 368 | case \Phinx\Config\Config::VERSION_ORDER_EXECUTION_TIME: |
||
| 369 | 208 | $orderBy = 'start_time ASC, version ASC'; |
|
| 370 | 208 | break; |
|
| 371 | 208 | default: |
|
| 372 | 208 | throw new \RuntimeException('Invalid version_order configuration option'); |
|
| 373 | 208 | } |
|
| 374 | |||
| 375 | $rows = $this->fetchAll(sprintf('SELECT * FROM %s ORDER BY %s', $this->getSchemaTableName(), $orderBy)); |
||
| 376 | foreach ($rows as $version) { |
||
| 377 | $result[$version['version']] = $version; |
||
| 378 | } |
||
| 379 | 121 | ||
| 380 | return $result; |
||
| 381 | 121 | } |
|
| 382 | |||
| 383 | /** |
||
| 384 | * {@inheritdoc} |
||
| 385 | */ |
||
| 386 | public function migrated(MigrationInterface $migration, $direction, $startTime, $endTime) |
||
| 420 | |||
| 421 | /** |
||
| 422 | * {@inheritdoc} |
||
| 423 | */ |
||
| 424 | public function toggleBreakpoint(MigrationInterface $migration) |
||
| 425 | { |
||
| 426 | $this->query( |
||
| 427 | sprintf( |
||
| 428 | 'UPDATE %1$s SET %2$s = CASE %2$s WHEN %3$s THEN %4$s ELSE %3$s END, %7$s = %7$s WHERE %5$s = \'%6$s\';', |
||
| 429 | $this->getSchemaTableName(), |
||
| 430 | $this->quoteColumnName('breakpoint'), |
||
| 431 | $this->castToBool(true), |
||
| 432 | $this->castToBool(false), |
||
| 433 | $this->quoteColumnName('version'), |
||
| 434 | $migration->getVersion(), |
||
| 435 | $this->quoteColumnName('start_time') |
||
| 436 | ) |
||
| 437 | ); |
||
| 438 | |||
| 439 | return $this; |
||
| 440 | } |
||
| 441 | |||
| 442 | /** |
||
| 443 | * {@inheritdoc} |
||
| 444 | */ |
||
| 445 | public function resetAllBreakpoints() |
||
| 446 | { |
||
| 447 | return $this->execute( |
||
| 448 | sprintf( |
||
| 449 | 'UPDATE %1$s SET %2$s = %3$s, %4$s = %4$s WHERE %2$s <> %3$s;', |
||
| 450 | $this->getSchemaTableName(), |
||
| 451 | $this->quoteColumnName('breakpoint'), |
||
| 452 | $this->castToBool(false), |
||
| 453 | $this->quoteColumnName('start_time') |
||
| 454 | ) |
||
| 455 | ); |
||
| 456 | } |
||
| 457 | |||
| 458 | /** |
||
| 459 | * {@inheritdoc} |
||
| 460 | */ |
||
| 461 | public function setBreakpoint(MigrationInterface $migration) |
||
| 465 | |||
| 466 | /** |
||
| 467 | * {@inheritdoc} |
||
| 468 | */ |
||
| 469 | public function unsetBreakpoint(MigrationInterface $migration) |
||
| 473 | |||
| 474 | /** |
||
| 475 | * Mark a migration breakpoint. |
||
| 476 | * |
||
| 477 | * @param \Phinx\Migration\MigrationInterface $migration The migration target for the breakpoint |
||
| 478 | * @param bool $state The required state of the breakpoint |
||
| 479 | * |
||
| 480 | * @return \Phinx\Db\Adapter\AdapterInterface |
||
| 481 | */ |
||
| 482 | protected function markBreakpoint(MigrationInterface $migration, $state) |
||
| 498 | |||
| 499 | /** |
||
| 500 | * {@inheritdoc} |
||
| 501 | */ |
||
| 502 | public function createSchema($schemaName = 'public') |
||
| 506 | |||
| 507 | /** |
||
| 508 | * {@inheritdoc} |
||
| 509 | */ |
||
| 510 | public function dropSchema($name) |
||
| 514 | |||
| 515 | /** |
||
| 516 | * {@inheritdoc} |
||
| 517 | */ |
||
| 518 | public function getColumnTypes() |
||
| 547 | |||
| 548 | /** |
||
| 549 | * {@inheritdoc} |
||
| 550 | */ |
||
| 551 | public function castToBool($value) |
||
| 552 | { |
||
| 553 | return (bool)$value ? 1 : 0; |
||
| 554 | } |
||
| 555 | |||
| 556 | /** |
||
| 557 | * Retrieve a database connection attribute |
||
| 558 | * @see http://php.net/manual/en/pdo.getattribute.php |
||
| 559 | * |
||
| 560 | * @param int $attribute One of the PDO::ATTR_* constants |
||
| 561 | * @return mixed |
||
| 562 | */ |
||
| 563 | public function getAttribute($attribute) |
||
| 567 | |||
| 568 | /** |
||
| 569 | * Get the definition for a `DEFAULT` statement. |
||
| 570 | * |
||
| 571 | * @param mixed $default Default value |
||
| 572 | * @param string $columnType column type added |
||
| 573 | * @return string |
||
| 574 | */ |
||
| 575 | View Code Duplication | protected function getDefaultValueDefinition($default, $columnType = null) |
|
| 587 | |||
| 588 | /** |
||
| 589 | * Executes all the ALTER TABLE instructions passed for the given table |
||
| 590 | * |
||
| 591 | * @param string $tableName The table name to use in the ALTER statement |
||
| 592 | * @param AlterInstructions $instructions The object containing the alter sequence |
||
| 593 | * @return void |
||
| 594 | */ |
||
| 595 | protected function executeAlterSteps($tableName, AlterInstructions $instructions) |
||
| 600 | |||
| 601 | /** |
||
| 602 | * {@inheritdoc} |
||
| 603 | */ |
||
| 604 | public function addColumn(Table $table, Column $column) |
||
| 609 | |||
| 610 | /** |
||
| 611 | * Returns the instructions to add the specified column to a database table. |
||
| 612 | * |
||
| 613 | * @param \Phinx\Db\Table\Table $table Table |
||
| 614 | * @param \Phinx\Db\Table\Column $column Column |
||
| 615 | * @return AlterInstructions |
||
| 616 | */ |
||
| 617 | abstract protected function getAddColumnInstructions(Table $table, Column $column); |
||
| 618 | |||
| 619 | /** |
||
| 620 | * {@inheritdoc} |
||
| 621 | */ |
||
| 622 | public function renameColumn($tableName, $columnName, $newColumnName) |
||
| 627 | |||
| 628 | /** |
||
| 629 | * Returns the instructions to rename the specified column. |
||
| 630 | * |
||
| 631 | * @param string $tableName Table Name |
||
| 632 | * @param string $columnName Column Name |
||
| 633 | * @param string $newColumnName New Column Name |
||
| 634 | * @return AlterInstructions:w |
||
| 635 | * |
||
| 636 | */ |
||
| 637 | abstract protected function getRenameColumnInstructions($tableName, $columnName, $newColumnName); |
||
| 638 | |||
| 639 | /** |
||
| 640 | * {@inheritdoc} |
||
| 641 | */ |
||
| 642 | public function changeColumn($tableName, $columnName, Column $newColumn) |
||
| 647 | |||
| 648 | /** |
||
| 649 | * Returns the instructions to change a table column type. |
||
| 650 | * |
||
| 651 | * @param string $tableName Table Name |
||
| 652 | * @param string $columnName Column Name |
||
| 653 | * @param \Phinx\Db\Table\Column $newColumn New Column |
||
| 654 | * @return AlterInstructions |
||
| 655 | */ |
||
| 656 | abstract protected function getChangeColumnInstructions($tableName, $columnName, Column $newColumn); |
||
| 657 | |||
| 658 | /** |
||
| 659 | * {@inheritdoc} |
||
| 660 | */ |
||
| 661 | public function dropColumn($tableName, $columnName) |
||
| 666 | |||
| 667 | /** |
||
| 668 | * Returns the instructions to drop the specified column. |
||
| 669 | * |
||
| 670 | * @param string $tableName Table Name |
||
| 671 | * @param string $columnName Column Name |
||
| 672 | * @return AlterInstructions |
||
| 673 | */ |
||
| 674 | abstract protected function getDropColumnInstructions($tableName, $columnName); |
||
| 675 | |||
| 676 | /** |
||
| 677 | * {@inheritdoc} |
||
| 678 | */ |
||
| 679 | public function addIndex(Table $table, Index $index) |
||
| 684 | |||
| 685 | /** |
||
| 686 | * Returns the instructions to add the specified index to a database table. |
||
| 687 | * |
||
| 688 | * @param \Phinx\Db\Table\Table $table Table |
||
| 689 | * @param \Phinx\Db\Table\Index $index Index |
||
| 690 | * @return AlterInstructions |
||
| 691 | */ |
||
| 692 | abstract protected function getAddIndexInstructions(Table $table, Index $index); |
||
| 693 | |||
| 694 | /** |
||
| 695 | * {@inheritdoc} |
||
| 696 | */ |
||
| 697 | public function dropIndex($tableName, $columns) |
||
| 702 | |||
| 703 | /** |
||
| 704 | * Returns the instructions to drop the specified index from a database table. |
||
| 705 | * |
||
| 706 | * @param string $tableName The name of of the table where the index is |
||
| 707 | * @param mixed $columns Column(s) |
||
| 708 | * @return AlterInstructions |
||
| 709 | */ |
||
| 710 | abstract protected function getDropIndexByColumnsInstructions($tableName, $columns); |
||
| 711 | |||
| 712 | /** |
||
| 713 | * {@inheritdoc} |
||
| 714 | */ |
||
| 715 | public function dropIndexByName($tableName, $indexName) |
||
| 720 | |||
| 721 | /** |
||
| 722 | * Returns the instructions to drop the index specified by name from a database table. |
||
| 723 | * |
||
| 724 | * @param string $tableName The table name whe the index is |
||
| 725 | * @param string $indexName The name of the index |
||
| 726 | * @return AlterInstructions |
||
| 727 | */ |
||
| 728 | abstract protected function getDropIndexByNameInstructions($tableName, $indexName); |
||
| 729 | |||
| 730 | /** |
||
| 731 | * {@inheritdoc} |
||
| 732 | */ |
||
| 733 | public function addForeignKey(Table $table, ForeignKey $foreignKey) |
||
| 738 | |||
| 739 | /** |
||
| 740 | * Returns the instructions to adds the specified foreign key to a database table. |
||
| 741 | * |
||
| 742 | * @param \Phinx\Db\Table\Table $table The table to add the constraint to |
||
| 743 | * @param \Phinx\Db\Table\ForeignKey $foreignKey The foreign key to add |
||
| 744 | * @return AlterInstructions |
||
| 745 | */ |
||
| 746 | abstract protected function getAddForeignKeyInstructions(Table $table, ForeignKey $foreignKey); |
||
| 747 | |||
| 748 | /** |
||
| 749 | * {@inheritdoc} |
||
| 750 | */ |
||
| 751 | public function dropForeignKey($tableName, $columns, $constraint = null) |
||
| 761 | |||
| 762 | /** |
||
| 763 | * Returns the instructions to drop the specified foreign key from a database table. |
||
| 764 | * |
||
| 765 | * @param string $tableName The table where the foreign key constraint is |
||
| 766 | * @param string $constraint Constraint name |
||
| 767 | * @return AlterInstructions |
||
| 768 | */ |
||
| 769 | abstract protected function getDropForeignKeyInstructions($tableName, $constraint); |
||
| 770 | |||
| 771 | /** |
||
| 772 | * Returns the instructions to drop the specified foreign key from a database table. |
||
| 773 | * |
||
| 774 | * @param string $tableName The table where the foreign key constraint is |
||
| 775 | * @param array $columns The list of column names |
||
| 776 | * @return AlterInstructions |
||
| 777 | */ |
||
| 778 | abstract protected function getDropForeignKeyByColumnsInstructions($tableName, $columns); |
||
| 779 | |||
| 780 | /** |
||
| 781 | * {@inheritdoc} |
||
| 782 | */ |
||
| 783 | public function dropTable($tableName) |
||
| 788 | |||
| 789 | /** |
||
| 790 | * Returns the instructions to drop the specified database table. |
||
| 791 | * |
||
| 792 | * @param string $tableName Table Name |
||
| 793 | * @return AlterInstructions |
||
| 794 | */ |
||
| 795 | abstract protected function getDropTableInstructions($tableName); |
||
| 796 | |||
| 797 | /** |
||
| 798 | * {@inheritdoc} |
||
| 799 | */ |
||
| 800 | public function renameTable($tableName, $newTableName) |
||
| 805 | |||
| 806 | /** |
||
| 807 | * Returns the instructions to rename the specified database table. |
||
| 808 | * |
||
| 809 | * @param string $tableName Table Name |
||
| 810 | * @param string $newTableName New Name |
||
| 811 | * @return AlterInstructions |
||
| 812 | */ |
||
| 813 | abstract protected function getRenameTableInstructions($tableName, $newTableName); |
||
| 814 | |||
| 815 | /** |
||
| 816 | * {@inheritdoc} |
||
| 817 | */ |
||
| 818 | public function changePrimaryKey(Table $table, $newColumns) |
||
| 823 | |||
| 824 | /** |
||
| 825 | * Returns the instructions to change the primary key for the specified database table. |
||
| 826 | * |
||
| 827 | * @param Table $table Table |
||
| 828 | * @param string|array|null $newColumns Column name(s) to belong to the primary key, or null to drop the key |
||
| 829 | * @return AlterInstructions |
||
| 830 | */ |
||
| 831 | abstract protected function getChangePrimaryKeyInstructions(Table $table, $newColumns); |
||
| 832 | |||
| 833 | /** |
||
| 834 | * {@inheritdoc} |
||
| 835 | */ |
||
| 836 | public function changeComment(Table $table, $newComment) |
||
| 841 | |||
| 842 | /** |
||
| 843 | * Returns the instruction to change the comment for the specified database table. |
||
| 844 | * |
||
| 845 | * @param Table $table Table |
||
| 846 | * @param string|null $newComment New comment string, or null to drop the comment |
||
| 847 | * @return AlterInstructions |
||
| 848 | */ |
||
| 849 | abstract protected function getChangeCommentInstructions(Table $table, $newComment); |
||
| 850 | |||
| 851 | /** |
||
| 852 | * {@inheritdoc} |
||
| 853 | */ |
||
| 854 | public function executeActions(Table $table, array $actions) |
||
| 959 | } |
||
| 960 |
Loading history...
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.