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 |
||
| 10 | class JukeboxService |
||
| 11 | { |
||
| 12 | /** @var JukeboxMap[] */ |
||
| 13 | protected $mapQueue = []; |
||
| 14 | |||
| 15 | /** |
||
| 16 | * @var PlayerStorage |
||
| 17 | */ |
||
| 18 | private $playerStorage; |
||
| 19 | /** |
||
| 20 | * @var AdminGroups |
||
| 21 | */ |
||
| 22 | private $adminGroups; |
||
| 23 | |||
| 24 | /** |
||
| 25 | * JukeboxService constructor. |
||
| 26 | * |
||
| 27 | * @param PlayerStorage $playerStorage |
||
| 28 | * @param AdminGroups $adminGroups |
||
| 29 | */ |
||
| 30 | public function __construct(PlayerStorage $playerStorage, AdminGroups $adminGroups) |
||
| 35 | |||
| 36 | /** |
||
| 37 | * @return JukeboxMap[] |
||
| 38 | */ |
||
| 39 | public function getMapQueue() |
||
| 43 | |||
| 44 | /** |
||
| 45 | * @return JukeboxMap|null |
||
| 46 | */ |
||
| 47 | public function getFirst() |
||
| 53 | |||
| 54 | /** |
||
| 55 | * Adds map as first item |
||
| 56 | * |
||
| 57 | * @param Map $map |
||
| 58 | * @param null $login |
||
| 59 | * @param bool $force |
||
| 60 | * |
||
| 61 | * @return bool |
||
| 62 | */ |
||
| 63 | public function addMapFirst(Map $map, $login = null, $force = false) |
||
| 67 | |||
| 68 | /** |
||
| 69 | * Adds map as last item |
||
| 70 | * |
||
| 71 | * @param Map $map |
||
| 72 | * @param null $login |
||
| 73 | * @param bool $force |
||
| 74 | * |
||
| 75 | * @return bool |
||
| 76 | */ |
||
| 77 | public function addMapLast(Map $map, $login = null, $force = false) |
||
| 81 | |||
| 82 | /** |
||
| 83 | * Adds map as last or first item |
||
| 84 | * |
||
| 85 | * @param Map $map |
||
| 86 | * @param null $login |
||
| 87 | * @param bool $force |
||
| 88 | * @param bool $addFirst |
||
| 89 | * |
||
| 90 | * @return bool |
||
| 91 | */ |
||
| 92 | public function addMap(Map $map, $login = null, $force = false, $addFirst = false) |
||
| 126 | |||
| 127 | /** |
||
| 128 | * @param Map $map |
||
| 129 | * @param $login |
||
| 130 | * @param bool $force |
||
| 131 | * |
||
| 132 | * @return false; |
||
|
|
|||
| 133 | */ |
||
| 134 | public function removeMap(Map $map, $login = null, $force = false) |
||
| 159 | |||
| 160 | /** |
||
| 161 | * @param JukeboxMap $map |
||
| 162 | * @param bool $addFirst |
||
| 163 | * |
||
| 164 | * @return void |
||
| 165 | */ |
||
| 166 | private function add(JukeboxMap $map, $addFirst = false) |
||
| 175 | |||
| 176 | /** |
||
| 177 | * @param $login |
||
| 178 | * |
||
| 179 | * @return bool|JukeboxMap |
||
| 180 | */ |
||
| 181 | public function getMap($login) |
||
| 191 | |||
| 192 | /** |
||
| 193 | * @param Map $map |
||
| 194 | * |
||
| 195 | * @return bool |
||
| 196 | */ |
||
| 197 | View Code Duplication | private function remove(Map $map) |
|
| 209 | |||
| 210 | |||
| 211 | /** |
||
| 212 | * checks if login exists on queue |
||
| 213 | * @param string $login |
||
| 214 | * @return bool |
||
| 215 | */ |
||
| 216 | private function checkLogin($login) |
||
| 226 | |||
| 227 | /** |
||
| 228 | * checks if map exists on queue |
||
| 229 | * @param Map $map |
||
| 230 | * |
||
| 231 | * @return bool |
||
| 232 | */ |
||
| 233 | View Code Duplication | private function checkMap(Map $map) |
|
| 243 | |||
| 244 | /** |
||
| 245 | * |
||
| 246 | */ |
||
| 247 | public function clearMapQueue() |
||
| 251 | |||
| 252 | } |
||
| 253 |
This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.