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 |
||
8 | trait MatcherTrait |
||
9 | { |
||
10 | private $name; |
||
11 | private $isBot; |
||
12 | private $channels; |
||
13 | private $users; |
||
14 | private $patterns; |
||
15 | |||
16 | public function matches(Message $message) |
||
52 | |||
53 | private function setName($name) |
||
57 | |||
58 | private function setIsBot($isBot) |
||
62 | |||
63 | private function setChannels(array $channels) |
||
67 | |||
68 | private function setUsers(array $users) |
||
72 | |||
73 | private function setPatterns(array $patterns) |
||
77 | } |
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.