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 |
||
20 | class UserPreferenceHandler extends AbstractHandler implements Handler |
||
21 | { |
||
22 | /** |
||
23 | * {@inheritdoc} |
||
24 | */ |
||
25 | View Code Duplication | public function setUserPreference(UserPreferenceSetStruct $setStruct): UserPreference |
|
26 | { |
||
27 | $this->logger->logCall(__METHOD__, [ |
||
28 | 'setStruct' => $setStruct, |
||
29 | ]); |
||
30 | |||
31 | $this->cache->invalidateTags([ |
||
32 | 'user-preference-count-' . $setStruct->userId, |
||
33 | 'user-preference-' . $setStruct->userId . '-' . $setStruct->name, |
||
34 | ]); |
||
35 | |||
36 | return $this->persistenceHandler->userPreferenceHandler()->setUserPreference($setStruct); |
||
37 | } |
||
38 | |||
39 | /** |
||
40 | * {@inheritdoc} |
||
41 | */ |
||
42 | View Code Duplication | public function countUserPreferences(int $userId): int |
|
62 | |||
63 | /** |
||
64 | * {@inheritdoc} |
||
65 | */ |
||
66 | View Code Duplication | public function getUserPreferenceByUserIdAndName(int $userId, string $name): UserPreference |
|
90 | |||
91 | /** |
||
92 | * {@inheritdoc} |
||
93 | */ |
||
94 | View Code Duplication | public function loadUserPreferences(int $userId, int $offset, int $limit): array |
|
104 | } |
||
105 |
Let’s assume that you have a directory layout like this:
and let’s assume the following content of
Bar.php
:If both files
OtherDir/Foo.php
andSomeDir/Foo.php
are 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.php
However, as
OtherDir/Foo.php
does 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: