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 |
||
| 52 | class DavService { |
||
| 53 | |||
| 54 | |||
| 55 | /** @var string */ |
||
| 56 | private $userId; |
||
| 57 | |||
| 58 | /** @var IUserManager */ |
||
| 59 | private $userManager; |
||
| 60 | |||
| 61 | /** @var CirclesRequest */ |
||
| 62 | private $circlesRequest; |
||
| 63 | |||
| 64 | /** @var MembersRequest */ |
||
| 65 | private $membersRequest; |
||
| 66 | |||
| 67 | /** @var ConfigService */ |
||
| 68 | private $configService; |
||
| 69 | |||
| 70 | /** @var MiscService */ |
||
| 71 | private $miscService; |
||
| 72 | |||
| 73 | |||
| 74 | /** |
||
| 75 | * TimezoneService constructor. |
||
| 76 | * |
||
| 77 | * @param string $userId |
||
| 78 | * @param IUserManager $userManager |
||
| 79 | * @param CirclesRequest $circlesRequest |
||
| 80 | * @param MembersRequest $membersRequest |
||
| 81 | * @param ConfigService $configService |
||
| 82 | * @param MiscService $miscService |
||
| 83 | */ |
||
| 84 | View Code Duplication | public function __construct( |
|
| 95 | |||
| 96 | |||
| 97 | /** |
||
| 98 | * @param GenericEvent $event |
||
| 99 | */ |
||
| 100 | public function onCreateCard(GenericEvent $event) { |
||
| 104 | |||
| 105 | |||
| 106 | /** |
||
| 107 | * @param GenericEvent $event |
||
| 108 | */ |
||
| 109 | public function onUpdateCard(GenericEvent $event) { |
||
| 113 | |||
| 114 | |||
| 115 | /** |
||
| 116 | * @param GenericEvent $event |
||
| 117 | */ |
||
| 118 | public function onDeleteCard(GenericEvent $event) { |
||
| 122 | |||
| 123 | |||
| 124 | /** |
||
| 125 | * @param GenericEvent $event |
||
| 126 | * |
||
| 127 | * @return DavCard |
||
| 128 | */ |
||
| 129 | private function generateDavCard(GenericEvent $event): DavCard { |
||
| 143 | |||
| 144 | |||
| 145 | /** |
||
| 146 | * @param DavCard $davCard |
||
| 147 | */ |
||
| 148 | private function updateDavCard(DavCard $davCard) { |
||
| 153 | |||
| 154 | |||
| 155 | /** |
||
| 156 | * @param DavCard $davCard |
||
| 157 | */ |
||
| 158 | private function manageContact(DavCard $davCard) { |
||
| 173 | |||
| 174 | |||
| 175 | /** |
||
| 176 | * @param array $circles |
||
| 177 | * @param DavCard $davCard |
||
| 178 | * @param string $userId |
||
| 179 | */ |
||
| 180 | private function manageLocalContact(array $circles, DavCard $davCard, string $userId) { |
||
| 186 | |||
| 187 | |||
| 188 | /** |
||
| 189 | * @param array $circles |
||
| 190 | * @param DavCard $davCard |
||
| 191 | */ |
||
| 192 | private function manageRemoteContact(array $circles, DavCard $davCard) { |
||
| 197 | |||
| 198 | |||
| 199 | /** |
||
| 200 | * @param Circle $circle |
||
| 201 | * @param DavCard $davCard |
||
| 202 | * @param int $type |
||
| 203 | * @param string $userId |
||
| 204 | */ |
||
| 205 | private function manageMember(Circle $circle, DavCard $davCard, int $type, string $userId = '') { |
||
| 233 | |||
| 234 | |||
| 235 | /** |
||
| 236 | * @param DavCard $davCard |
||
| 237 | * |
||
| 238 | * @return string |
||
| 239 | * @throws NotLocalMemberException |
||
| 240 | */ |
||
| 241 | private function isLocalMember(DavCard $davCard): string { |
||
| 258 | |||
| 259 | |||
| 260 | /** |
||
| 261 | * @param DavCard $davCard |
||
| 262 | */ |
||
| 263 | private function manageCircles(DavCard $davCard) { |
||
| 276 | |||
| 277 | |||
| 278 | /** |
||
| 279 | * @param DavCard $davCard |
||
| 280 | * @param array $fromCard |
||
| 281 | * @param array $current |
||
| 282 | */ |
||
| 283 | private function manageNewCircles(DavCard $davCard, array $fromCard, array $current) { |
||
| 308 | |||
| 309 | |||
| 310 | /** |
||
| 311 | * // TODO: Get all group from an addressbook |
||
| 312 | * // TODO: remove deprecated circles |
||
| 313 | * |
||
| 314 | * @param array $fromCard |
||
| 315 | * @param array $current |
||
| 316 | */ |
||
| 317 | private function manageDeprecatedCircles(array $fromCard, array $current) { |
||
| 319 | |||
| 320 | |||
| 321 | /** |
||
| 322 | * @param DavCard $davCard |
||
| 323 | */ |
||
| 324 | private function assignCirclesToCard(DavCard $davCard) { |
||
| 334 | |||
| 335 | |||
| 336 | /** |
||
| 337 | * @param int $addressBookId |
||
| 338 | * |
||
| 339 | * @return Circle[] |
||
| 340 | */ |
||
| 341 | private function getCirclesFromBook(int $addressBookId): array { |
||
| 344 | |||
| 345 | |||
| 346 | /** |
||
| 347 | * @param int $length |
||
| 348 | * |
||
| 349 | * @return string |
||
| 350 | * @deprecated |
||
| 351 | */ |
||
| 352 | protected function uuid(int $length = 0): string { |
||
| 369 | |||
| 370 | |||
| 371 | } |
||
| 372 | |||
| 374 |
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.