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:
Complex classes like SubjectProvider often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use SubjectProvider, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 37 | class SubjectProvider extends BaseProvider { |
||
| 38 | |||
| 39 | /** |
||
| 40 | * Parse on Subject 'member_join'. |
||
| 41 | * If circle is closed, we say that user accepted his invitation. |
||
| 42 | * |
||
| 43 | * @param IEvent $event |
||
| 44 | * @param Circle $circle |
||
| 45 | * @param Member $member |
||
| 46 | * |
||
| 47 | * @throws FakeException |
||
| 48 | */ |
||
| 49 | public function parseSubjectMemberJoin(IEvent &$event, Circle $circle, Member $member) { |
||
| 62 | |||
| 63 | |||
| 64 | /** |
||
| 65 | * @param IEvent $event |
||
| 66 | * @param Circle $circle |
||
| 67 | * @param Member $member |
||
| 68 | * |
||
| 69 | * @throws FakeException |
||
| 70 | */ |
||
| 71 | public function parseSubjectMemberJoinClosedCircle(IEvent &$event, Circle $circle, Member $member) { |
||
| 84 | |||
| 85 | |||
| 86 | /** |
||
| 87 | * Parse on Subject 'member_add'. |
||
| 88 | * If circle is closed, we say that user's invitation was accepted. |
||
| 89 | * |
||
| 90 | * @param IEvent $event |
||
| 91 | * @param Circle $circle |
||
| 92 | * @param Member $member |
||
| 93 | * |
||
| 94 | * @throws FakeException |
||
| 95 | */ |
||
| 96 | View Code Duplication | public function parseSubjectMemberAdd(IEvent &$event, Circle $circle, Member $member) { |
|
| 111 | |||
| 112 | |||
| 113 | /** |
||
| 114 | * @param IEvent $event |
||
| 115 | * @param Circle $circle |
||
| 116 | * @param Member $member |
||
| 117 | * |
||
| 118 | * @throws FakeException |
||
| 119 | */ |
||
| 120 | public function parseSubjectMemberAddClosedCircle(IEvent &$event, Circle $circle, Member $member) { |
||
| 134 | |||
| 135 | |||
| 136 | /** |
||
| 137 | * Parse on Subject 'member_left'. |
||
| 138 | * If circle is closed and member was not a real member, we send him to |
||
| 139 | * parseSubjectNonMemberLeftClosedCircle(); |
||
| 140 | * |
||
| 141 | * @param IEvent $event |
||
| 142 | * @param Circle $circle |
||
| 143 | * @param Member $member |
||
| 144 | * |
||
| 145 | * @throws FakeException |
||
| 146 | */ |
||
| 147 | public function parseSubjectMemberLeft(IEvent &$event, Circle $circle, Member $member) { |
||
| 162 | |||
| 163 | |||
| 164 | /** |
||
| 165 | * Parse on Subject 'member_left' on a closed circle when user were not yet a member. |
||
| 166 | * If status is Invited we say that member rejected his invitation. |
||
| 167 | * If status is Requested we say he dismissed his request. |
||
| 168 | * |
||
| 169 | * @param IEvent $event |
||
| 170 | * @param Circle $circle |
||
| 171 | * @param Member $member |
||
| 172 | * |
||
| 173 | * @throws FakeException |
||
| 174 | */ |
||
| 175 | View Code Duplication | public function parseSubjectNonMemberLeftClosedCircle(IEvent &$event, Circle $circle, Member $member |
|
| 198 | |||
| 199 | |||
| 200 | /** |
||
| 201 | * Parse on Subject 'member_remove'. |
||
| 202 | * If circle is closed and member was not a real member, we send him to |
||
| 203 | * parseSubjectNonMemberRemoveClosedCircle(); |
||
| 204 | * |
||
| 205 | * @param IEvent $event |
||
| 206 | * @param Circle $circle |
||
| 207 | * @param Member $member |
||
| 208 | * |
||
| 209 | * @throws FakeException |
||
| 210 | */ |
||
| 211 | View Code Duplication | public function parseSubjectMemberRemove(IEvent &$event, Circle $circle, Member $member) { |
|
| 232 | |||
| 233 | |||
| 234 | /** |
||
| 235 | * Parse on Subject 'member_remove' on a closed circle when user were not yet a member. |
||
| 236 | * If status is Invited we say that author cancelled his invitation. |
||
| 237 | * If status is Requested we say that his invitation was rejected. |
||
| 238 | * |
||
| 239 | * @param IEvent $event |
||
| 240 | * @param Circle $circle |
||
| 241 | * @param Member $member |
||
| 242 | * |
||
| 243 | * @return IEvent |
||
| 244 | */ |
||
| 245 | public function parseSubjectNonMemberRemoveClosedCircle( |
||
| 264 | |||
| 265 | |||
| 266 | /** |
||
| 267 | * @param IEvent $event |
||
| 268 | * @param Circle $circle |
||
| 269 | * @param Member $group |
||
| 270 | * |
||
| 271 | * @throws FakeException |
||
| 272 | */ |
||
| 273 | View Code Duplication | public function parseGroupLink(IEvent &$event, Circle $circle, Member $group) { |
|
| 285 | |||
| 286 | |||
| 287 | /** |
||
| 288 | * @param IEvent $event |
||
| 289 | * @param Circle $circle |
||
| 290 | * @param Member $group |
||
| 291 | * |
||
| 292 | * @throws FakeException |
||
| 293 | */ |
||
| 294 | View Code Duplication | public function parseGroupUnlink(IEvent &$event, Circle $circle, Member $group) { |
|
| 306 | |||
| 307 | |||
| 308 | /** |
||
| 309 | * @param IEvent $event |
||
| 310 | * @param Circle $circle |
||
| 311 | * @param Member $group |
||
| 312 | * |
||
| 313 | * @throws FakeException |
||
| 314 | */ |
||
| 315 | public function parseGroupLevel(IEvent &$event, Circle $circle, Member $group) { |
||
| 331 | |||
| 332 | |||
| 333 | /** |
||
| 334 | * @param IEvent $event |
||
| 335 | * @param Circle $circle |
||
| 336 | * @param Member $member |
||
| 337 | * |
||
| 338 | * @throws FakeException |
||
| 339 | */ |
||
| 340 | View Code Duplication | public function parseMemberInvited(IEvent &$event, Circle $circle, Member $member) { |
|
| 354 | |||
| 355 | |||
| 356 | /** |
||
| 357 | * @param IEvent $event |
||
| 358 | * @param Circle $circle |
||
| 359 | * @param Member $member |
||
| 360 | * |
||
| 361 | * @throws FakeException |
||
| 362 | */ |
||
| 363 | View Code Duplication | public function parseMemberLevel(IEvent &$event, Circle $circle, Member $member) { |
|
| 378 | |||
| 379 | |||
| 380 | /** |
||
| 381 | * @param IEvent $event |
||
| 382 | * @param Circle $circle |
||
| 383 | * @param Member $member |
||
| 384 | * |
||
| 385 | * @throws FakeException |
||
| 386 | */ |
||
| 387 | View Code Duplication | public function parseMemberRequestInvitation(IEvent &$event, Circle $circle, Member $member) { |
|
| 400 | |||
| 401 | |||
| 402 | /** |
||
| 403 | * @param IEvent $event |
||
| 404 | * @param Circle $circle |
||
| 405 | * @param Member $member |
||
| 406 | * |
||
| 407 | * @throws FakeException |
||
| 408 | */ |
||
| 409 | View Code Duplication | public function parseMemberOwner(IEvent &$event, Circle $circle, Member $member) { |
|
| 421 | |||
| 422 | |||
| 423 | /** |
||
| 424 | * @param IEvent $event |
||
| 425 | * @param Circle $circle |
||
| 426 | * @param FederatedLink $remote |
||
| 427 | * |
||
| 428 | * @throws FakeException |
||
| 429 | */ |
||
| 430 | View Code Duplication | public function parseLinkRequestSent(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 443 | |||
| 444 | |||
| 445 | /** |
||
| 446 | * @param IEvent $event |
||
| 447 | * @param Circle $circle |
||
| 448 | * @param FederatedLink $remote |
||
| 449 | * |
||
| 450 | * @throws FakeException |
||
| 451 | */ |
||
| 452 | View Code Duplication | public function parseLinkRequestReceived(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 463 | |||
| 464 | |||
| 465 | /** |
||
| 466 | * @param IEvent $event |
||
| 467 | * @param Circle $circle |
||
| 468 | * @param FederatedLink $remote |
||
| 469 | * |
||
| 470 | * @throws FakeException |
||
| 471 | */ |
||
| 472 | View Code Duplication | public function parseLinkRequestRejected(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 484 | |||
| 485 | |||
| 486 | /** |
||
| 487 | * @param IEvent $event |
||
| 488 | * @param Circle $circle |
||
| 489 | * @param FederatedLink $remote |
||
| 490 | * |
||
| 491 | * @throws FakeException |
||
| 492 | */ |
||
| 493 | View Code Duplication | public function parseLinkRequestCanceled(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 507 | |||
| 508 | |||
| 509 | /** |
||
| 510 | * @param IEvent $event |
||
| 511 | * @param Circle $circle |
||
| 512 | * @param FederatedLink $remote |
||
| 513 | * |
||
| 514 | * @throws FakeException |
||
| 515 | */ |
||
| 516 | View Code Duplication | public function parseLinkRequestAccepted(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 528 | |||
| 529 | |||
| 530 | /** |
||
| 531 | * @param IEvent $event |
||
| 532 | * @param Circle $circle |
||
| 533 | * @param FederatedLink $remote |
||
| 534 | * |
||
| 535 | * @throws FakeException |
||
| 536 | */ |
||
| 537 | View Code Duplication | public function parseLinkRequestRemoved(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 550 | |||
| 551 | |||
| 552 | /** |
||
| 553 | * @param IEvent $event |
||
| 554 | * @param Circle $circle |
||
| 555 | * @param FederatedLink $remote |
||
| 556 | * |
||
| 557 | * @throws FakeException |
||
| 558 | */ |
||
| 559 | View Code Duplication | public function parseLinkRequestCanceling(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 572 | |||
| 573 | |||
| 574 | /** |
||
| 575 | * @param IEvent $event |
||
| 576 | * @param Circle $circle |
||
| 577 | * @param FederatedLink $remote |
||
| 578 | * |
||
| 579 | * @throws FakeException |
||
| 580 | */ |
||
| 581 | View Code Duplication | public function parseLinkRequestAccepting(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 594 | |||
| 595 | |||
| 596 | /** |
||
| 597 | * @param IEvent $event |
||
| 598 | * @param Circle $circle |
||
| 599 | * @param FederatedLink $remote |
||
| 600 | * |
||
| 601 | * @throws FakeException |
||
| 602 | */ |
||
| 603 | View Code Duplication | public function parseLinkUp(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 615 | |||
| 616 | |||
| 617 | /** |
||
| 618 | * @param IEvent $event |
||
| 619 | * @param Circle $circle |
||
| 620 | * @param FederatedLink $remote |
||
| 621 | * |
||
| 622 | * @throws FakeException |
||
| 623 | */ |
||
| 624 | View Code Duplication | public function parseLinkDown(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 638 | |||
| 639 | |||
| 640 | /** |
||
| 641 | * @param IEvent $event |
||
| 642 | * @param Circle $circle |
||
| 643 | * @param FederatedLink $remote |
||
| 644 | * |
||
| 645 | * @throws FakeException |
||
| 646 | */ |
||
| 647 | View Code Duplication | public function parseLinkRemove(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 660 | } |
Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.