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 |
||
18 | class StorageImpl implements Storage |
||
19 | { |
||
20 | /** @var EntityPool */ |
||
21 | private $entityPool; |
||
22 | /** @var RepositoryRegistry */ |
||
23 | private $registry; |
||
24 | |||
25 | /** |
||
26 | * StorageImpl constructor. |
||
27 | * |
||
28 | * @param EntityPool $entityPool |
||
29 | * @param RepositoryRegistry $registry |
||
30 | */ |
||
31 | public function __construct(EntityPool $entityPool, RepositoryRegistry $registry) |
||
36 | |||
37 | /** |
||
38 | * @param mixed $subject |
||
39 | * |
||
40 | * @throws SlumberException When no repo is associated with the subject |
||
41 | */ |
||
42 | 2 | View Code Duplication | public function save($subject) |
56 | |||
57 | /** |
||
58 | * @param mixed $subject |
||
59 | * |
||
60 | * @throws SlumberException When no repo is associated with the subject |
||
61 | */ |
||
62 | View Code Duplication | public function remove($subject) |
|
76 | |||
77 | /** |
||
78 | * @return EntityPool |
||
79 | */ |
||
80 | 20 | public function getEntityPool() |
|
84 | |||
85 | /** |
||
86 | * @return Repository[] |
||
87 | */ |
||
88 | public function getRepositories() |
||
92 | |||
93 | /** |
||
94 | * @param string $name |
||
95 | * |
||
96 | * @return Repository|null |
||
97 | */ |
||
98 | public function getRepositoryByName($name) |
||
102 | |||
103 | /** |
||
104 | * @param string $cls |
||
105 | * |
||
106 | * @return bool |
||
107 | */ |
||
108 | public function hasRepositoryByClassName($cls) |
||
112 | |||
113 | /** |
||
114 | * @param string $cls |
||
115 | * |
||
116 | * @return Repository|null |
||
117 | */ |
||
118 | 17 | public function getRepositoryByClassName($cls) |
|
122 | |||
123 | /** |
||
124 | * @param mixed $entity |
||
125 | * |
||
126 | * @return Repository|null |
||
127 | */ |
||
128 | 6 | public function getRepositoryByEntity($entity) |
|
132 | } |
||
133 |
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.