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 |
||
| 26 | final class Card extends Api |
||
| 27 | { |
||
| 28 | /** |
||
| 29 | * @param string $customerId |
||
| 30 | * @param string $cardId |
||
| 31 | * |
||
| 32 | * @return string |
||
| 33 | */ |
||
| 34 | private static function path($customerId, $cardId) |
||
| 38 | |||
| 39 | /** |
||
| 40 | * @param Customer $customer |
||
| 41 | * @param array $parameters |
||
| 42 | * |
||
| 43 | * @return Pagination |
||
| 44 | */ |
||
| 45 | public function all(Customer $customer, array $parameters = []) |
||
| 51 | |||
| 52 | /** |
||
| 53 | * @param string $customerId |
||
| 54 | * @param string $id |
||
| 55 | * |
||
| 56 | * @return Domain |
||
| 57 | */ |
||
| 58 | public function find($customerId, $id) |
||
| 64 | |||
| 65 | /** |
||
| 66 | * @param Domain $card |
||
| 67 | */ |
||
| 68 | public function refresh(Domain $card) |
||
| 72 | |||
| 73 | /** |
||
| 74 | * @param Domain $card |
||
| 75 | */ |
||
| 76 | View Code Duplication | public function update(Domain $card) |
|
| 84 | |||
| 85 | /** |
||
| 86 | * @param Domain $card |
||
| 87 | */ |
||
| 88 | View Code Duplication | public function destroy(Domain $card) |
|
| 96 | } |
||
| 97 |
Let’s assume that you have a directory layout like this:
. |-- OtherDir | |-- Bar.php | `-- Foo.php `-- SomeDir `-- Foo.phpand let’s assume the following content of
Bar.php:If both files
OtherDir/Foo.phpandSomeDir/Foo.phpare loaded in the same runtime, you will see a PHP error such as the following:PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.phpHowever, as
OtherDir/Foo.phpdoes not necessarily have to be loaded and the error is only triggered if it is loaded beforeOtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: