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:
| 1 | <?php |
||
| 35 | View Code Duplication | abstract class AbstractProcessor implements ProcessorInterface |
|
|
|
|||
| 36 | { |
||
| 37 | |||
| 38 | /** |
||
| 39 | * The connection instance. |
||
| 40 | * . |
||
| 41 | * @var \TechDivision\Import\Connection\ConnectionInterface; |
||
| 42 | */ |
||
| 43 | protected $connection; |
||
| 44 | |||
| 45 | /** |
||
| 46 | * The utility class instance with the SQL statements to use. |
||
| 47 | * |
||
| 48 | * @var \TechDivision\Import\Utils\SqlStatementsInterface |
||
| 49 | */ |
||
| 50 | protected $utilityClass; |
||
| 51 | |||
| 52 | /** |
||
| 53 | * Initialize the processor with the passed connection and utility class name. |
||
| 54 | * . |
||
| 55 | * @param \TechDivision\Import\Connection\ConnectionInterface $connection The connection instance |
||
| 56 | * @param \TechDivision\Import\Utils\SqlStatementsInterface $utilityClass The utility class instance |
||
| 57 | */ |
||
| 58 | public function __construct( |
||
| 70 | |||
| 71 | /** |
||
| 72 | * Set's the connection to use. |
||
| 73 | * . |
||
| 74 | * @param \TechDivision\Import\Connection\ConnectionInterface $connection The connection instance |
||
| 75 | * |
||
| 76 | * @return void |
||
| 77 | */ |
||
| 78 | public function setConnection(ConnectionInterface $connection) |
||
| 82 | |||
| 83 | /** |
||
| 84 | * Return's the connection to use. |
||
| 85 | * |
||
| 86 | * @return \TechDivision\Import\Connection\ConnectionInterface The connection instance |
||
| 87 | */ |
||
| 88 | public function getConnection() |
||
| 92 | |||
| 93 | /** |
||
| 94 | * Set's the utility class instance with the SQL statements to use. |
||
| 95 | * |
||
| 96 | * @param \TechDivision\Import\Utils\SqlStatementsInterface $utilityClass The utility class instance |
||
| 97 | * |
||
| 98 | * @return void |
||
| 99 | */ |
||
| 100 | public function setUtilityClass(SqlStatementsInterface $utilityClass) |
||
| 104 | |||
| 105 | /** |
||
| 106 | * Return's the utility class instance with the SQL statements to use. |
||
| 107 | * |
||
| 108 | * @return \TechDivision\Import\Utils\SqlStatementsInterface The utility class instance |
||
| 109 | */ |
||
| 110 | public function getUtilityClass() |
||
| 114 | |||
| 115 | /** |
||
| 116 | * Return's the utility class with the SQL statements to use. |
||
| 117 | * |
||
| 118 | * @return string The utility class name |
||
| 119 | */ |
||
| 120 | public function getUtilityClassName() |
||
| 124 | } |
||
| 125 |
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.