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 |
||
7 | trait HasUsers |
||
8 | { |
||
9 | /** |
||
10 | * @return Illuminate\Database\Eloquent\Relations\BelongsToMany |
||
11 | */ |
||
12 | public function users() : BelongsToMany |
||
21 | |||
22 | /** |
||
23 | * Add a user to the current Project. |
||
24 | * |
||
25 | * @param string|int|\Illuminate\Database\Eloquent\Model $user |
||
26 | * @param array $pivot_columns |
||
27 | * @return self |
||
28 | */ |
||
29 | public function addUser($user, array $pivot_columns = []) : self |
||
33 | |||
34 | /** |
||
35 | * Add one or multiple users to the current Project. |
||
36 | * |
||
37 | * @param array $users |
||
38 | * @param array $pivot_columns |
||
39 | * @return self |
||
40 | */ |
||
41 | View Code Duplication | public function addUsers(array $users = [], array $pivot_columns = []) : self |
|
58 | |||
59 | /** |
||
60 | * Remove the given user from the current Project |
||
61 | * |
||
62 | * @param string|int|\Illuminate\Database\Eloquent\Model $user |
||
63 | * @return self |
||
64 | */ |
||
65 | public function removeUser($user) : self |
||
69 | |||
70 | /** |
||
71 | * Remove one or multiple users from the current Project |
||
72 | * |
||
73 | * @param array $users |
||
74 | * @return self |
||
75 | */ |
||
76 | View Code Duplication | public function removeUsers(array $users = []) : self |
|
91 | |||
92 | /** |
||
93 | * Check if the given user is on the current Project |
||
94 | * |
||
95 | * @param string|int|\Illuminate\Database\Eloquent\Model $user |
||
96 | * @return bool |
||
97 | */ |
||
98 | public function hasUser($user) : bool |
||
102 | } |
||
103 |
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.