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 | View Code Duplication | class Highscores |
|
| 11 | { |
||
| 12 | use ImmutableTrait, SerializableTrait; |
||
| 13 | |||
| 14 | /** |
||
| 15 | * @var string |
||
| 16 | */ |
||
| 17 | private $world; |
||
| 18 | |||
| 19 | /** |
||
| 20 | * @var string |
||
| 21 | */ |
||
| 22 | private $category; |
||
| 23 | |||
| 24 | /** |
||
| 25 | * @var Collection |
||
| 26 | */ |
||
| 27 | private $highscores; |
||
| 28 | |||
| 29 | /** |
||
| 30 | * Highscores constructor. |
||
| 31 | * |
||
| 32 | * @param string $world |
||
| 33 | * @param string $category |
||
| 34 | * @param array $highscores |
||
| 35 | * @throws \Igorsgm\TibiaDataApi\Exceptions\ImmutableException |
||
| 36 | */ |
||
| 37 | public function __construct(string $world, string $category, Collection $highscores) |
||
| 45 | |||
| 46 | /** |
||
| 47 | * @return string |
||
| 48 | */ |
||
| 49 | public function getWorld(): string |
||
| 53 | |||
| 54 | /** |
||
| 55 | * @return string |
||
| 56 | */ |
||
| 57 | public function getCategory(): string |
||
| 61 | |||
| 62 | /** |
||
| 63 | * @return Character[] |
||
| 64 | */ |
||
| 65 | public function getHighscores(): Collection |
||
| 69 | } |
||
| 70 |
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: