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 QueryTrait |
||
30 | { |
||
31 | /** |
||
32 | * Returns public users |
||
33 | * |
||
34 | * @return Eloquent\Collection |
||
35 | */ |
||
36 | 4 | public function activeUsers() |
|
37 | { |
||
38 | 4 | return $this->with('role') |
|
|
|||
39 | 4 | ->where('private', '=', false) |
|
40 | 4 | ->orderBy('firstname', 'ASC')->get(); |
|
41 | } |
||
42 | |||
43 | /** |
||
44 | * Returns user projects with activities details eager loaded |
||
45 | * |
||
46 | * @param int $status |
||
47 | * |
||
48 | * @return Relations\HasMany |
||
49 | */ |
||
50 | 10 | public function projectsWidthActivities($status = Project::STATUS_OPEN) |
|
60 | |||
61 | /** |
||
62 | * Returns projects with issues details eager loaded |
||
63 | * |
||
64 | * @param int $status |
||
65 | * |
||
66 | * @return Relations\HasMany |
||
67 | */ |
||
68 | 1 | public function projectsWidthIssues($status = Project::STATUS_OPEN) |
|
84 | |||
85 | /** |
||
86 | * Load user permissions |
||
87 | * |
||
88 | * @return Eloquent\Collection |
||
89 | */ |
||
90 | 54 | protected function loadPermissions() |
|
98 | } |
||
99 |
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.