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 HasMeta |
||
| 8 | { |
||
| 9 | /** |
||
| 10 | * @return \Illuminate\Database\Eloquent\Relations\morphMany |
||
| 11 | */ |
||
| 12 | public function meta() |
||
| 16 | |||
| 17 | /** |
||
| 18 | * Get meta by key. |
||
| 19 | * |
||
| 20 | * @param $key |
||
| 21 | * @param $group null |
||
| 22 | * @return mixed |
||
| 23 | */ |
||
| 24 | public function getMeta($key, $group = null) |
||
| 31 | |||
| 32 | /** |
||
| 33 | * Set meta. |
||
| 34 | * |
||
| 35 | * @param $key |
||
| 36 | * @param $value |
||
| 37 | * @param null $group |
||
| 38 | * @return mixed |
||
| 39 | */ |
||
| 40 | View Code Duplication | public function setMeta($meta_data, $group = null) |
|
| 48 | |||
| 49 | /** |
||
| 50 | * Update Meta. |
||
| 51 | * |
||
| 52 | * @param $meta |
||
| 53 | * @param $key |
||
| 54 | * @param $value |
||
| 55 | * @param null $group |
||
| 56 | * @return mixed |
||
| 57 | */ |
||
| 58 | View Code Duplication | public function updateMeta($meta, $meta_data, $group = null) |
|
| 71 | |||
| 72 | /** |
||
| 73 | * Delete meta. |
||
| 74 | * |
||
| 75 | * @param $key |
||
| 76 | * @param null $group |
||
| 77 | * @return mixed |
||
| 78 | */ |
||
| 79 | public function unsetMeta($key, $group = null) |
||
| 83 | |||
| 84 | /** |
||
| 85 | * Alias for unsetMeta method. |
||
| 86 | * |
||
| 87 | * @param $key |
||
| 88 | * @param null $group |
||
| 89 | * @return mixed |
||
| 90 | */ |
||
| 91 | public function removeMeta($meta_data, $group = null) |
||
| 98 | |||
| 99 | /** |
||
| 100 | * Remove by id. |
||
| 101 | * |
||
| 102 | * @param $id |
||
| 103 | */ |
||
| 104 | public function removeMetaById($id) |
||
| 120 | |||
| 121 | /** |
||
| 122 | * Remove group of meta. |
||
| 123 | * |
||
| 124 | * @param $groups |
||
| 125 | * @return $this |
||
| 126 | */ |
||
| 127 | View Code Duplication | public function removeMetaGroups($groups) |
|
| 139 | |||
| 140 | /** |
||
| 141 | * @param $group |
||
| 142 | * @return $this |
||
| 143 | */ |
||
| 144 | public function removeGroup($group) |
||
| 148 | |||
| 149 | /** |
||
| 150 | * Get other meta. |
||
| 151 | * |
||
| 152 | * @return mixed |
||
| 153 | */ |
||
| 154 | public function getOtherMeta() |
||
| 158 | |||
| 159 | /** |
||
| 160 | * Get other meta. |
||
| 161 | * |
||
| 162 | * @alias: self::getOtherMeta() |
||
| 163 | * @return mixed |
||
| 164 | */ |
||
| 165 | public function getSimpleMeta() |
||
| 169 | |||
| 170 | /** |
||
| 171 | * Get other meta. |
||
| 172 | * |
||
| 173 | * @return mixed |
||
| 174 | */ |
||
| 175 | public function metaWithoutGroup() |
||
| 179 | |||
| 180 | /** |
||
| 181 | * Get all meta from specific group. |
||
| 182 | * |
||
| 183 | * @param $group |
||
| 184 | * @return mixed |
||
| 185 | */ |
||
| 186 | public function getMetaFromGroup($group) |
||
| 190 | |||
| 191 | /** |
||
| 192 | * @param $group |
||
| 193 | * @return mixed |
||
| 194 | */ |
||
| 195 | public function getMetaGroup($group) |
||
| 199 | |||
| 200 | /** |
||
| 201 | * Get meta repository |
||
| 202 | * |
||
| 203 | * @return Repository |
||
| 204 | */ |
||
| 205 | private function getRepository() |
||
| 209 | } |
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
Idableprovides a methodequalsIdthat 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.