ezsystems /
ezpublish-kernel
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 | public function setUserPreference(UserPreferenceSetStruct $setStruct): UserPreference |
||
| 38 | |||
| 39 | /** |
||
| 40 | * {@inheritdoc} |
||
| 41 | */ |
||
| 42 | View Code Duplication | public function countUserPreferences(int $userId): int |
|
| 62 | |||
| 63 | /** |
||
| 64 | * {@inheritdoc} |
||
| 65 | */ |
||
| 66 | public function getUserPreferenceByUserIdAndName(int $userId, string $name): UserPreference |
||
| 67 | { |
||
| 68 | $cacheItem = $this->cache->getItem('ez-user-preference-' . $userId . '-' . $name); |
||
| 69 | |||
| 70 | $userPreference = $cacheItem->get(); |
||
| 71 | if ($cacheItem->isHit()) { |
||
| 72 | return $userPreference; |
||
| 73 | } |
||
| 74 | |||
| 75 | $this->logger->logCall(__METHOD__, [ |
||
| 76 | 'userId' => $userId, |
||
| 77 | 'name' => $name, |
||
| 78 | ]); |
||
| 79 | |||
| 80 | $userPreference = $this->persistenceHandler->userPreferenceHandler()->getUserPreferenceByUserIdAndName($userId, $name); |
||
| 81 | |||
| 82 | $cacheItem->set($userPreference); |
||
| 83 | $cacheItem->tag([ |
||
| 84 | 'user-preference-' . $userId . '-' . $name, |
||
| 85 | ]); |
||
| 86 | $this->cache->save($cacheItem); |
||
| 87 | |||
| 88 | return $userPreference; |
||
| 89 | } |
||
| 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:
. |-- 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: