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 |
||
21 | class Provider implements IProvider { |
||
22 | |||
23 | /** @var MiscService */ |
||
24 | protected $miscService; |
||
25 | |||
26 | /** @var IL10N */ |
||
27 | protected $l10n; |
||
28 | |||
29 | /** @var IURLGenerator */ |
||
30 | protected $url; |
||
31 | |||
32 | /** @var IManager */ |
||
33 | protected $activityManager; |
||
34 | |||
35 | public function __construct( |
||
43 | |||
44 | |||
45 | /** |
||
46 | * @param string $lang |
||
47 | * @param IEvent $event |
||
48 | * @param IEvent|null $previousEvent |
||
49 | * |
||
50 | * @return IEvent |
||
51 | * @since 11.0.0 |
||
52 | */ |
||
53 | public function parse($lang, IEvent $event, IEvent $previousEvent = null) { |
||
67 | |||
68 | |||
69 | /** |
||
70 | * @param string $lang |
||
71 | * @param IEvent $event |
||
72 | * |
||
73 | * @return IEvent |
||
74 | * @throws Exception |
||
75 | */ |
||
76 | private function parseAsMember($lang, IEvent $event) { |
||
100 | |||
101 | |||
102 | /** |
||
103 | * @param $lang |
||
104 | * @param Circle $circle |
||
105 | * @param IEvent $event |
||
106 | * |
||
107 | * @return IEvent |
||
108 | */ |
||
109 | private function parseMembersAsMember($lang, Circle $circle, IEvent $event) { |
||
126 | |||
127 | |||
128 | /** |
||
129 | * @param string $lang |
||
130 | * @param IEvent $event |
||
131 | * |
||
132 | * @return IEvent |
||
133 | */ |
||
134 | private function parseAsModerator($lang, IEvent $event) { |
||
159 | |||
160 | /** |
||
161 | * @param string $lang |
||
162 | * @param Circle $circle |
||
163 | * @param IEvent $event |
||
164 | * |
||
165 | * @return IEvent |
||
166 | */ |
||
167 | View Code Duplication | private function parseCircleCreate($lang, Circle $circle, IEvent $event) { |
|
194 | |||
195 | |||
196 | /** |
||
197 | * @param string $lang |
||
198 | * @param Circle $circle |
||
199 | * @param IEvent $event |
||
200 | * |
||
201 | * @return IEvent |
||
202 | */ |
||
203 | View Code Duplication | private function parseCircleDelete($lang, Circle $circle, IEvent $event) { |
|
229 | |||
230 | |||
231 | /** |
||
232 | * @param string $lang |
||
233 | * @param Circle $circle |
||
234 | * @param Member $member |
||
235 | * @param IEvent $event |
||
236 | * |
||
237 | * @return IEvent |
||
238 | */ |
||
239 | private function parseMemberInvited($lang, Circle $circle, Member $member, IEvent $event) { |
||
284 | |||
285 | |||
286 | /** |
||
287 | * @param $lang |
||
288 | * @param Circle $circle |
||
289 | * @param Member $member |
||
290 | * @param IEvent $event |
||
291 | * |
||
292 | * @return IEvent |
||
293 | */ |
||
294 | private function parseMemberRequestInvitation( |
||
320 | |||
321 | |||
322 | /** |
||
323 | * @param $lang |
||
324 | * @param Circle $circle |
||
325 | * @param Member $member |
||
326 | * @param IEvent $event |
||
327 | * |
||
328 | * @return IEvent |
||
329 | */ |
||
330 | private function parseMemberJoin($lang, Circle $circle, Member $member, IEvent $event) { |
||
333 | |||
334 | // |
||
335 | // |
||
336 | // /** |
||
337 | // * @param string $lang |
||
338 | // * @param IEvent $event |
||
339 | // * |
||
340 | // * @return IEvent |
||
341 | // */ |
||
342 | // private function parsePopulation($lang, IEvent $event) { |
||
343 | // if ($event->getType() !== 'circles_population') { |
||
344 | // return $event; |
||
345 | // } |
||
346 | // |
||
347 | // return $event; |
||
348 | // } |
||
349 | // |
||
350 | // |
||
351 | // /** |
||
352 | // * @param string $lang |
||
353 | // * @param IEvent $event |
||
354 | // * |
||
355 | // * @return IEvent |
||
356 | // */ |
||
357 | // private function parseRights($lang, IEvent $event) { |
||
358 | // if ($event->getType() !== 'circles_rights') { |
||
359 | // return $event; |
||
360 | // } |
||
361 | // |
||
362 | // return $event; |
||
363 | // } |
||
364 | // |
||
365 | // |
||
366 | // /** |
||
367 | // * @param string $lang |
||
368 | // * @param IEvent $event |
||
369 | // * |
||
370 | // * @return IEvent |
||
371 | // */ |
||
372 | // private function parseShares($lang, IEvent $event) { |
||
373 | // if ($event->getType() !== 'circles_shares') { |
||
374 | // return $event; |
||
375 | // } |
||
376 | // |
||
377 | // return $event; |
||
378 | // } |
||
379 | // |
||
380 | // private function parseMood(IEvent &$event, $mood) { |
||
381 | // |
||
382 | // if (key_exists('website', $mood)) { |
||
383 | // $event->setRichMessage( |
||
384 | // $mood['text'] . '{opengraph}', |
||
385 | // ['opengraph' => $this->generateOpenGraphParameter('_id_', $mood['website'])] |
||
386 | // ); |
||
387 | // } else { |
||
388 | // $event->setParsedMessage($mood['text']); |
||
389 | // } |
||
390 | // |
||
391 | // } |
||
392 | |||
393 | |||
394 | private function parseActivityHeader(IEvent &$event, SharingFrame $frame) { |
||
436 | |||
437 | |||
438 | private function generateCircleParameter(Circle $circle) { |
||
448 | |||
449 | |||
450 | private function generateMemberParameter(Member $member) { |
||
453 | |||
454 | /** |
||
455 | * @param $userId |
||
456 | * |
||
457 | * @return array |
||
458 | */ |
||
459 | private function generateUserParameter($userId) { |
||
466 | } |
||
467 |
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.
The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.
This check looks for comments that seem to be mostly valid code and reports them.