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 |
||
| 10 | final class TokenContainer implements Cleanable, ContainsChildren, Removable |
||
| 11 | { |
||
| 12 | /** @var array[Token] */ |
||
| 13 | private $children; |
||
| 14 | |||
| 15 | /** @var Configuration */ |
||
| 16 | private $configuration; |
||
| 17 | |||
| 18 | /** |
||
| 19 | * Constructor |
||
| 20 | */ |
||
| 21 | 51 | public function __construct(Configuration $configuration) |
|
| 26 | |||
| 27 | /** |
||
| 28 | * Required by ContainsChildren interface. |
||
| 29 | */ |
||
| 30 | 51 | public function getChildren() |
|
| 34 | |||
| 35 | /** |
||
| 36 | * Required by ContainsChildren interface. |
||
| 37 | */ |
||
| 38 | 1 | public function hasChild(Token $token) |
|
| 42 | |||
| 43 | /** |
||
| 44 | * Required by ContainsChildren interface. |
||
| 45 | */ |
||
| 46 | 50 | public function appendChild(Token $token) |
|
| 52 | |||
| 53 | /** |
||
| 54 | * Required by ContainsChildren interface. |
||
| 55 | */ |
||
| 56 | 1 | public function prependChild(Token $token) |
|
| 62 | |||
| 63 | /** |
||
| 64 | * Required by ContainsChildren interface. |
||
| 65 | */ |
||
| 66 | 5 | View Code Duplication | public function removeChild(Token $token) |
| 77 | |||
| 78 | /** |
||
| 79 | * Required by Cleanable interface. |
||
| 80 | */ |
||
| 81 | 43 | public function clean(LoggerInterface $logger) |
|
| 89 | |||
| 90 | /** |
||
| 91 | * Required by the Removable interface. |
||
| 92 | */ |
||
| 93 | 42 | View Code Duplication | public function remove(LoggerInterface $logger) |
| 123 | } |
||
| 124 |
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: