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 |
||
| 39 | class MembersService { |
||
| 40 | |||
| 41 | /** @var string */ |
||
| 42 | private $userId; |
||
| 43 | |||
| 44 | /** @var IL10N */ |
||
| 45 | private $l10n; |
||
| 46 | |||
| 47 | /** @var IUserManager */ |
||
| 48 | private $userManager; |
||
| 49 | |||
| 50 | /** @var ConfigService */ |
||
| 51 | private $configService; |
||
| 52 | |||
| 53 | /** @var CirclesMapper */ |
||
| 54 | private $dbCircles; |
||
| 55 | |||
| 56 | /** @var MembersMapper */ |
||
| 57 | private $dbMembers; |
||
| 58 | |||
| 59 | /** @var MiscService */ |
||
| 60 | private $miscService; |
||
| 61 | |||
| 62 | View Code Duplication | public function __construct( |
|
| 63 | $userId, |
||
| 64 | IL10N $l10n, |
||
| 65 | IUserManager $userManager, |
||
| 66 | ConfigService $configService, |
||
| 67 | DatabaseService $databaseService, |
||
| 68 | MiscService $miscService |
||
| 69 | ) { |
||
| 70 | $this->userId = $userId; |
||
| 71 | $this->l10n = $l10n; |
||
| 72 | $this->userManager = $userManager; |
||
| 73 | $this->configService = $configService; |
||
| 74 | $this->miscService = $miscService; |
||
| 75 | |||
| 76 | $this->dbCircles = $databaseService->getCirclesMapper(); |
||
| 77 | $this->dbMembers = $databaseService->getMembersMapper(); |
||
| 78 | } |
||
| 79 | |||
| 80 | |||
| 81 | /** |
||
| 82 | * @param $circleId |
||
| 83 | * @param $name |
||
| 84 | * |
||
| 85 | * @return array |
||
| 86 | * @throws \Exception |
||
| 87 | */ |
||
| 88 | View Code Duplication | public function addMember($circleId, $name) { |
|
| 89 | |||
| 90 | try { |
||
| 91 | $circle = $this->dbCircles->getDetailsFromCircle($circleId, $this->userId); |
||
| 92 | $this->dbMembers->getMemberFromCircle($circleId, $this->userId) |
||
| 93 | ->hasToBeModerator(); |
||
| 94 | } catch (\Exception $e) { |
||
| 95 | throw $e; |
||
| 96 | } |
||
| 97 | |||
| 98 | try { |
||
| 99 | $member = $this->getFreshNewMember($circleId, $name); |
||
| 100 | } catch (\Exception $e) { |
||
| 101 | throw $e; |
||
| 102 | } |
||
| 103 | $member->inviteToCircle($circle->getType()); |
||
| 104 | $this->dbMembers->editMember($member); |
||
| 105 | |||
| 106 | return $this->dbMembers->getMembersFromCircle($circleId, $circle->getUser()); |
||
| 107 | } |
||
| 108 | |||
| 109 | |||
| 110 | /** |
||
| 111 | * Check if a fresh member can be generated (by addMember) |
||
| 112 | * |
||
| 113 | * @param $circleId |
||
| 114 | * @param $name |
||
| 115 | * |
||
| 116 | * @return null|Member |
||
| 117 | * @throws MemberAlreadyExistsException |
||
| 118 | * @throws NoUserException |
||
| 119 | */ |
||
| 120 | private function getFreshNewMember($circleId, $name) { |
||
| 142 | |||
| 143 | |||
| 144 | /** |
||
| 145 | * return if member already exists |
||
| 146 | * |
||
| 147 | * @param Member $member |
||
| 148 | * |
||
| 149 | * @return bool |
||
| 150 | */ |
||
| 151 | private function memberAlreadyExist($member) { |
||
| 157 | |||
| 158 | |||
| 159 | /** |
||
| 160 | * @param $circleId |
||
| 161 | * @param $name |
||
| 162 | * @param $level |
||
| 163 | * |
||
| 164 | * @return array |
||
| 165 | * @throws \Exception |
||
| 166 | */ |
||
| 167 | public function levelMember($circleId, $name, $level) { |
||
| 191 | |||
| 192 | |||
| 193 | public function switchOwner($circleId, $name) { |
||
| 209 | |||
| 210 | |||
| 211 | /** |
||
| 212 | * @param $circleId |
||
| 213 | * @param $name |
||
| 214 | * |
||
| 215 | * @return array |
||
| 216 | * @throws \Exception |
||
| 217 | */ |
||
| 218 | public function removeMember($circleId, $name) { |
||
| 237 | |||
| 238 | |||
| 239 | /** |
||
| 240 | * When a user is removed, remove him from all Circles |
||
| 241 | * |
||
| 242 | * @param $userId |
||
| 243 | */ |
||
| 244 | public function removeUser($userId) { |
||
| 247 | |||
| 248 | |||
| 249 | } |