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 |
||
29 | trait ManageCommentReplies |
||
30 | { |
||
31 | /** |
||
32 | * Reply to a comment. |
||
33 | * |
||
34 | * @param int $commentId |
||
35 | * @param string $content |
||
36 | * |
||
37 | * @return \EasyWeChat\Support\Collection |
||
38 | */ |
||
39 | 1 | View Code Duplication | public function reply($commentId, $content) |
48 | |||
49 | /** |
||
50 | * Delete a reply. |
||
51 | * |
||
52 | * @param int $commentId |
||
53 | * |
||
54 | * @return \EasyWeChat\Support\Collection |
||
55 | */ |
||
56 | 1 | View Code Duplication | public function deleteReply($commentId) |
64 | } |
||
65 |
This check looks for methods that are used by a trait but not required by it.
To illustrate, let’s look at the following code example
The trait
Idable
provides a methodequalsId
that in turn relies on the methodgetId()
. If this method does not exist on a class mixing in this trait, the method will fail.Adding the
getId()
as an abstract method to the trait will make sure it is available.