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 |
||
11 | trait ManagesContacts |
||
12 | { |
||
13 | /** |
||
14 | * Get all contacts. |
||
15 | * |
||
16 | * @return array |
||
17 | */ |
||
18 | public function contacts() |
||
26 | |||
27 | /** |
||
28 | * Find contact by email. |
||
29 | * |
||
30 | * @param string $email |
||
31 | * |
||
32 | * @return Contact|null |
||
33 | */ |
||
34 | public function findContact($email) |
||
44 | |||
45 | /** |
||
46 | * Create new contact. |
||
47 | * |
||
48 | * @param string $email |
||
49 | * @param string $firstName |
||
50 | * @param string $lastName |
||
51 | * @param int|null $orgid |
||
52 | * |
||
53 | * @return Contact|null |
||
54 | */ |
||
55 | public function createContact($email, $firstName, $lastName, $orgid = null) |
||
64 | |||
65 | /** |
||
66 | * Find or create a contact. |
||
67 | * |
||
68 | * @param string $email |
||
69 | * @param string $firstName |
||
70 | * @param string $lastName |
||
71 | * @param int|null $orgid |
||
72 | * |
||
73 | * @return Contact |
||
74 | */ |
||
75 | public function findOrCreateContact($email, $firstName, $lastName, $orgid = null) |
||
85 | |||
86 | /** |
||
87 | * Updates a contact by its ActiveCampaign ID. |
||
88 | * |
||
89 | * @param $id |
||
90 | * @param $email |
||
91 | * @param $firstName |
||
92 | * @param $lastName |
||
93 | * @param null $orgid |
||
94 | * |
||
95 | * @return Contact|null |
||
96 | */ |
||
97 | public function updateContactById($id, $email, $firstName, $lastName, $orgid = null) |
||
102 | |||
103 | /** |
||
104 | * Get all automations of a contact. |
||
105 | * |
||
106 | * @param \TestMonitor\ActiveCampaign\Resources\Contact $contact |
||
107 | * |
||
108 | * @return array |
||
109 | */ |
||
110 | public function contactAutomations(Contact $contact) |
||
118 | |||
119 | /** |
||
120 | * Get all tags of a contact. |
||
121 | * |
||
122 | * @param \TestMonitor\ActiveCampaign\Resources\Contact $contact |
||
123 | * |
||
124 | * @return array |
||
125 | */ |
||
126 | public function contactTags(Contact $contact) |
||
134 | |||
135 | /** |
||
136 | * Removing a automation from a contact. |
||
137 | * |
||
138 | * @param \TestMonitor\ActiveCampaign\Resources\Contact $contact |
||
139 | * @param \TestMonitor\ActiveCampaign\Resources\Automation $automation |
||
140 | */ |
||
141 | View Code Duplication | public function removeAutomationFromContact(Contact $contact, Automation $automation) |
|
155 | |||
156 | /** |
||
157 | * Removing all automations from a contact. |
||
158 | * |
||
159 | * @param \TestMonitor\ActiveCampaign\Resources\Contact $contact |
||
160 | */ |
||
161 | public function removeAllAutomationsFromContact(Contact $contact) |
||
169 | |||
170 | /** |
||
171 | * Removing a tag from a contact. |
||
172 | * |
||
173 | * @param \TestMonitor\ActiveCampaign\Resources\Contact $contact |
||
174 | * @param \TestMonitor\ActiveCampaign\Resources\Tag $tag |
||
175 | */ |
||
176 | View Code Duplication | public function removeTagFromContact(Contact $contact, Tag $tag) |
|
190 | } |
||
191 |
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.