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 Provider 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 Provider, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 42 | class Provider extends BaseProvider implements IProvider { |
||
| 43 | |||
| 44 | |||
| 45 | /** |
||
| 46 | * @param string $lang |
||
| 47 | * @param IEvent $event |
||
| 48 | * @param IEvent|null $previousEvent |
||
| 49 | * |
||
| 50 | * @return IEvent |
||
| 51 | */ |
||
| 52 | public function parse($lang, IEvent $event, IEvent $previousEvent = null) { |
||
| 73 | |||
| 74 | |||
| 75 | private function setIcon(IEvent &$event, Circle $circle) { |
||
| 84 | |||
| 85 | /** |
||
| 86 | * @param Circle $circle |
||
| 87 | * @param IEvent $event |
||
| 88 | * @param array $params |
||
| 89 | * |
||
| 90 | * @return IEvent |
||
| 91 | */ |
||
| 92 | private function parseAsMember(IEvent &$event, Circle $circle, $params) { |
||
| 119 | |||
| 120 | |||
| 121 | /** |
||
| 122 | * @param Circle $circle |
||
| 123 | * @param IEvent $event |
||
| 124 | * @param array $params |
||
| 125 | * |
||
| 126 | * @return IEvent |
||
| 127 | * @throws Exception |
||
| 128 | */ |
||
| 129 | private function parseAsModerator(IEvent &$event, Circle $circle, $params) { |
||
| 152 | |||
| 153 | |||
| 154 | /** |
||
| 155 | * @param Circle $circle |
||
| 156 | * @param IEvent $event |
||
| 157 | * |
||
| 158 | * @return IEvent |
||
| 159 | */ |
||
| 160 | View Code Duplication | private function parseMemberAsMember(IEvent &$event, Circle $circle) { |
|
| 176 | |||
| 177 | |||
| 178 | /** |
||
| 179 | * Parse on Subject 'member_join'. |
||
| 180 | * If circle is closed, we say that user accepted his invitation. |
||
| 181 | * |
||
| 182 | * @param IEvent $event |
||
| 183 | * @param Circle $circle |
||
| 184 | * @param Member $member |
||
| 185 | * |
||
| 186 | * @throws FakeException |
||
| 187 | */ |
||
| 188 | private function parseSubjectMemberJoin(IEvent &$event, Circle $circle, Member $member) { |
||
| 202 | |||
| 203 | |||
| 204 | /** |
||
| 205 | * @param IEvent $event |
||
| 206 | * @param Circle $circle |
||
| 207 | * @param Member $member |
||
| 208 | * |
||
| 209 | * @throws FakeException |
||
| 210 | */ |
||
| 211 | private function parseSubjectMemberJoinClosedCircle(IEvent &$event, Circle $circle, Member $member) { |
||
| 224 | |||
| 225 | |||
| 226 | /** |
||
| 227 | * Parse on Subject 'member_add'. |
||
| 228 | * If circle is closed, we say that user's invitation was accepted. |
||
| 229 | * |
||
| 230 | * @param IEvent $event |
||
| 231 | * @param Circle $circle |
||
| 232 | * @param Member $member |
||
| 233 | * |
||
| 234 | * @throws FakeException |
||
| 235 | */ |
||
| 236 | View Code Duplication | private function parseSubjectMemberAdd(IEvent &$event, Circle $circle, Member $member) { |
|
| 251 | |||
| 252 | |||
| 253 | /** |
||
| 254 | * @param IEvent $event |
||
| 255 | * @param Circle $circle |
||
| 256 | * @param Member $member |
||
| 257 | * |
||
| 258 | * @throws FakeException |
||
| 259 | */ |
||
| 260 | private function parseSubjectMemberAddClosedCircle(IEvent &$event, Circle $circle, Member $member) { |
||
| 274 | |||
| 275 | |||
| 276 | /** |
||
| 277 | * Parse on Subject 'member_left'. |
||
| 278 | * If circle is closed and member was not a real member, we send him to |
||
| 279 | * parseSubjectNonMemberLeftClosedCircle(); |
||
| 280 | * |
||
| 281 | * @param IEvent $event |
||
| 282 | * @param Circle $circle |
||
| 283 | * @param Member $member |
||
| 284 | * |
||
| 285 | * @throws FakeException |
||
| 286 | */ |
||
| 287 | private function parseSubjectMemberLeft(IEvent &$event, Circle $circle, Member $member) { |
||
| 302 | |||
| 303 | |||
| 304 | /** |
||
| 305 | * Parse on Subject 'member_left' on a closed circle when user were not yet a member. |
||
| 306 | * If status is Invited we say that member rejected his invitation. |
||
| 307 | * If status is Requested we say he dismissed his request. |
||
| 308 | * |
||
| 309 | * @param IEvent $event |
||
| 310 | * @param Circle $circle |
||
| 311 | * @param Member $member |
||
| 312 | * |
||
| 313 | * @throws FakeException |
||
| 314 | */ |
||
| 315 | View Code Duplication | private function parseSubjectNonMemberLeftClosedCircle(IEvent &$event, Circle $circle, Member $member |
|
| 338 | |||
| 339 | |||
| 340 | /** |
||
| 341 | * Parse on Subject 'member_remove'. |
||
| 342 | * If circle is closed and member was not a real member, we send him to |
||
| 343 | * parseSubjectNonMemberRemoveClosedCircle(); |
||
| 344 | * |
||
| 345 | * @param IEvent $event |
||
| 346 | * @param Circle $circle |
||
| 347 | * @param Member $member |
||
| 348 | * |
||
| 349 | * @throws FakeException |
||
| 350 | */ |
||
| 351 | View Code Duplication | private function parseSubjectMemberRemove(IEvent &$event, Circle $circle, Member $member) { |
|
| 372 | |||
| 373 | |||
| 374 | /** |
||
| 375 | * Parse on Subject 'member_remove' on a closed circle when user were not yet a member. |
||
| 376 | * If status is Invited we say that author cancelled his invitation. |
||
| 377 | * If status is Requested we say that his invitation was rejected. |
||
| 378 | * |
||
| 379 | * @param IEvent $event |
||
| 380 | * @param Circle $circle |
||
| 381 | * @param Member $member |
||
| 382 | * |
||
| 383 | * @return IEvent |
||
| 384 | */ |
||
| 385 | private function parseSubjectNonMemberRemoveClosedCircle( |
||
| 404 | |||
| 405 | |||
| 406 | /** |
||
| 407 | * @param Circle $circle |
||
| 408 | * @param IEvent $event |
||
| 409 | * |
||
| 410 | * @return IEvent |
||
| 411 | */ |
||
| 412 | private function parseGroupAsModerator(IEvent &$event, Circle $circle) { |
||
| 427 | |||
| 428 | |||
| 429 | /** |
||
| 430 | * @param Circle $circle |
||
| 431 | * @param IEvent $event |
||
| 432 | * |
||
| 433 | * @return IEvent |
||
| 434 | */ |
||
| 435 | View Code Duplication | private function parseMemberAsModerator(IEvent &$event, Circle $circle) { |
|
| 451 | |||
| 452 | |||
| 453 | /** |
||
| 454 | * @param Circle $circle |
||
| 455 | * @param IEvent $event |
||
| 456 | * |
||
| 457 | * @return IEvent |
||
| 458 | */ |
||
| 459 | private function parseLinkAsModerator(IEvent &$event, Circle $circle) { |
||
| 482 | |||
| 483 | |||
| 484 | /** |
||
| 485 | * @param IEvent $event |
||
| 486 | * @param Circle $circle |
||
| 487 | * @param Member $group |
||
| 488 | * |
||
| 489 | * @throws FakeException |
||
| 490 | */ |
||
| 491 | View Code Duplication | private function parseGroupLink(IEvent &$event, Circle $circle, Member $group) { |
|
| 503 | |||
| 504 | |||
| 505 | /** |
||
| 506 | * @param IEvent $event |
||
| 507 | * @param Circle $circle |
||
| 508 | * @param Member $group |
||
| 509 | * |
||
| 510 | * @throws FakeException |
||
| 511 | */ |
||
| 512 | View Code Duplication | private function parseGroupUnlink(IEvent &$event, Circle $circle, Member $group) { |
|
| 524 | |||
| 525 | |||
| 526 | /** |
||
| 527 | * @param IEvent $event |
||
| 528 | * @param Circle $circle |
||
| 529 | * @param Member $group |
||
| 530 | * |
||
| 531 | * @throws FakeException |
||
| 532 | */ |
||
| 533 | private function parseGroupLevel(IEvent &$event, Circle $circle, Member $group) { |
||
| 549 | |||
| 550 | |||
| 551 | /** |
||
| 552 | * @param IEvent $event |
||
| 553 | * @param Circle $circle |
||
| 554 | * @param Member $member |
||
| 555 | * |
||
| 556 | * @throws FakeException |
||
| 557 | */ |
||
| 558 | View Code Duplication | private function parseMemberInvited(IEvent &$event, Circle $circle, Member $member) { |
|
| 572 | |||
| 573 | |||
| 574 | /** |
||
| 575 | * @param IEvent $event |
||
| 576 | * @param Circle $circle |
||
| 577 | * @param Member $member |
||
| 578 | * |
||
| 579 | * @throws FakeException |
||
| 580 | */ |
||
| 581 | View Code Duplication | private function parseMemberLevel(IEvent &$event, Circle $circle, Member $member) { |
|
| 596 | |||
| 597 | |||
| 598 | /** |
||
| 599 | * @param IEvent $event |
||
| 600 | * @param Circle $circle |
||
| 601 | * @param Member $member |
||
| 602 | * |
||
| 603 | * @throws FakeException |
||
| 604 | */ |
||
| 605 | View Code Duplication | private function parseMemberRequestInvitation(IEvent &$event, Circle $circle, Member $member) { |
|
| 618 | |||
| 619 | |||
| 620 | /** |
||
| 621 | * @param IEvent $event |
||
| 622 | * @param Circle $circle |
||
| 623 | * @param Member $member |
||
| 624 | * |
||
| 625 | * @throws FakeException |
||
| 626 | */ |
||
| 627 | View Code Duplication | private function parseMemberOwner(IEvent &$event, Circle $circle, Member $member) { |
|
| 639 | |||
| 640 | |||
| 641 | /** |
||
| 642 | * @param IEvent $event |
||
| 643 | * @param Circle $circle |
||
| 644 | * @param FederatedLink $remote |
||
| 645 | * |
||
| 646 | * @throws FakeException |
||
| 647 | */ |
||
| 648 | View Code Duplication | private function parseLinkRequestSent(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 661 | |||
| 662 | |||
| 663 | /** |
||
| 664 | * @param IEvent $event |
||
| 665 | * @param Circle $circle |
||
| 666 | * @param FederatedLink $remote |
||
| 667 | * |
||
| 668 | * @throws FakeException |
||
| 669 | */ |
||
| 670 | View Code Duplication | private function parseLinkRequestReceived(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 681 | |||
| 682 | |||
| 683 | /** |
||
| 684 | * @param IEvent $event |
||
| 685 | * @param Circle $circle |
||
| 686 | * @param FederatedLink $remote |
||
| 687 | * |
||
| 688 | * @throws FakeException |
||
| 689 | */ |
||
| 690 | View Code Duplication | private function parseLinkRequestRejected(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 702 | |||
| 703 | |||
| 704 | /** |
||
| 705 | * @param IEvent $event |
||
| 706 | * @param Circle $circle |
||
| 707 | * @param FederatedLink $remote |
||
| 708 | * |
||
| 709 | * @throws FakeException |
||
| 710 | */ |
||
| 711 | View Code Duplication | private function parseLinkRequestCanceled(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 725 | |||
| 726 | |||
| 727 | /** |
||
| 728 | * @param IEvent $event |
||
| 729 | * @param Circle $circle |
||
| 730 | * @param FederatedLink $remote |
||
| 731 | * |
||
| 732 | * @throws FakeException |
||
| 733 | */ |
||
| 734 | View Code Duplication | private function parseLinkRequestAccepted(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 746 | |||
| 747 | |||
| 748 | /** |
||
| 749 | * @param IEvent $event |
||
| 750 | * @param Circle $circle |
||
| 751 | * @param FederatedLink $remote |
||
| 752 | * |
||
| 753 | * @throws FakeException |
||
| 754 | */ |
||
| 755 | View Code Duplication | private function parseLinkRequestRemoved(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 768 | |||
| 769 | |||
| 770 | /** |
||
| 771 | * @param IEvent $event |
||
| 772 | * @param Circle $circle |
||
| 773 | * @param FederatedLink $remote |
||
| 774 | * |
||
| 775 | * @throws FakeException |
||
| 776 | */ |
||
| 777 | View Code Duplication | private function parseLinkRequestCanceling(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 790 | |||
| 791 | |||
| 792 | /** |
||
| 793 | * @param IEvent $event |
||
| 794 | * @param Circle $circle |
||
| 795 | * @param FederatedLink $remote |
||
| 796 | * |
||
| 797 | * @throws FakeException |
||
| 798 | */ |
||
| 799 | View Code Duplication | private function parseLinkRequestAccepting(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 812 | |||
| 813 | |||
| 814 | /** |
||
| 815 | * @param IEvent $event |
||
| 816 | * @param Circle $circle |
||
| 817 | * @param FederatedLink $remote |
||
| 818 | * |
||
| 819 | * @throws FakeException |
||
| 820 | */ |
||
| 821 | View Code Duplication | private function parseLinkUp(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 833 | |||
| 834 | |||
| 835 | /** |
||
| 836 | * @param IEvent $event |
||
| 837 | * @param Circle $circle |
||
| 838 | * @param FederatedLink $remote |
||
| 839 | * |
||
| 840 | * @throws FakeException |
||
| 841 | */ |
||
| 842 | View Code Duplication | private function parseLinkDown(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 856 | |||
| 857 | |||
| 858 | /** |
||
| 859 | * @param IEvent $event |
||
| 860 | * @param Circle $circle |
||
| 861 | * @param FederatedLink $remote |
||
| 862 | * |
||
| 863 | * @throws FakeException |
||
| 864 | */ |
||
| 865 | View Code Duplication | private function parseLinkRemove(IEvent &$event, Circle $circle, FederatedLink $remote) { |
|
| 878 | } |
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.