nextcloud /
circles
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 |
||
| 23 | class Provider implements IProvider { |
||
| 24 | |||
| 25 | /** @var MiscService */ |
||
| 26 | protected $miscService; |
||
| 27 | |||
| 28 | /** @var IL10N */ |
||
| 29 | protected $l10n; |
||
| 30 | |||
| 31 | /** @var IURLGenerator */ |
||
| 32 | protected $url; |
||
| 33 | |||
| 34 | /** @var IManager */ |
||
| 35 | protected $activityManager; |
||
| 36 | |||
| 37 | public function __construct( |
||
| 45 | |||
| 46 | |||
| 47 | /** |
||
| 48 | * @param string $lang |
||
| 49 | * @param IEvent $event |
||
| 50 | * @param IEvent|null $previousEvent |
||
| 51 | * |
||
| 52 | * @return IEvent |
||
| 53 | */ |
||
| 54 | public function parse($lang, IEvent $event, IEvent $previousEvent = null) { |
||
| 55 | |||
| 56 | if ($event->getApp() !== 'circles') { |
||
| 57 | throw new \InvalidArgumentException(); |
||
| 58 | } |
||
| 59 | |||
| 60 | try { |
||
| 61 | |||
| 62 | $params = $event->getSubjectParameters(); |
||
| 63 | $circle = Circle::fromJSON($this->l10n, $params['circle']); |
||
|
|
|||
| 64 | |||
| 65 | $this->setIcon($event, $circle); |
||
| 66 | $this->parseAsMember($event, $circle, $params); |
||
| 67 | $this->parseAsModerator($event, $circle, $params); |
||
| 68 | $this->generateParsedSubject($event); |
||
| 69 | |||
| 70 | return $event; |
||
| 71 | } catch (\Exception $e) { |
||
| 72 | throw new \InvalidArgumentException(); |
||
| 73 | } |
||
| 74 | } |
||
| 75 | |||
| 76 | |||
| 77 | private function setIcon(IEvent &$event, Circle $circle) { |
||
| 78 | $event->setIcon( |
||
| 79 | CirclesService::getCircleIcon( |
||
| 80 | $circle->getType(), |
||
| 81 | (method_exists($this->activityManager, 'getRequirePNG') |
||
| 82 | && $this->activityManager->getRequirePNG()) |
||
| 83 | ) |
||
| 84 | ); |
||
| 85 | } |
||
| 86 | |||
| 87 | /** |
||
| 88 | * @param Circle $circle |
||
| 89 | * @param IEvent $event |
||
| 90 | * @param array $params |
||
| 91 | * |
||
| 92 | * @return IEvent |
||
| 93 | */ |
||
| 94 | private function parseAsMember(IEvent &$event, Circle $circle, $params) { |
||
| 121 | |||
| 122 | |||
| 123 | /** |
||
| 124 | * @param Circle $circle |
||
| 125 | * @param IEvent $event |
||
| 126 | * |
||
| 127 | * @return IEvent |
||
| 128 | */ |
||
| 129 | private function parseMemberAsMember(IEvent &$event, Circle $circle) { |
||
| 149 | |||
| 150 | |||
| 151 | /** |
||
| 152 | * Parse on Subject 'member_join'. |
||
| 153 | * If circle is closed, we say that user accepted his invitation. |
||
| 154 | * |
||
| 155 | * @param IEvent $event |
||
| 156 | * @param Circle $circle |
||
| 157 | * @param Member $member |
||
| 158 | * |
||
| 159 | * @return IEvent |
||
| 160 | */ |
||
| 161 | View Code Duplication | private function parseSubjectMemberJoin(IEvent &$event, Circle $circle, Member $member) { |
|
| 176 | |||
| 177 | |||
| 178 | /** |
||
| 179 | * Parse on Subject 'member_add'. |
||
| 180 | * If circle is closed, we say that user's invitation was accepted. |
||
| 181 | * |
||
| 182 | * @param IEvent $event |
||
| 183 | * @param Circle $circle |
||
| 184 | * @param Member $member |
||
| 185 | * |
||
| 186 | * @return IEvent |
||
| 187 | */ |
||
| 188 | View Code Duplication | private function parseSubjectMemberAdd(IEvent &$event, Circle $circle, Member $member) { |
|
| 205 | |||
| 206 | |||
| 207 | /** |
||
| 208 | * Parse on Subject 'member_left'. |
||
| 209 | * If circle is closed and member was not a real member, we send him to |
||
| 210 | * parseSubjectNonMemberLeftClosedCircle(); |
||
| 211 | * |
||
| 212 | * @param IEvent $event |
||
| 213 | * @param Circle $circle |
||
| 214 | * @param Member $member |
||
| 215 | * |
||
| 216 | * @return IEvent |
||
| 217 | */ |
||
| 218 | private function parseSubjectMemberLeft(IEvent &$event, Circle $circle, Member $member) { |
||
| 230 | |||
| 231 | /** |
||
| 232 | * Parse on Subject 'member_left' on a closed circle when user were not yet a member. |
||
| 233 | * If status is Invited we say that member rejected his invitation. |
||
| 234 | * If status is Requested we say he dismissed his request. |
||
| 235 | * |
||
| 236 | * @param IEvent $event |
||
| 237 | * @param Circle $circle |
||
| 238 | * @param Member $member |
||
| 239 | * |
||
| 240 | * @return IEvent |
||
| 241 | */ |
||
| 242 | View Code Duplication | private function parseSubjectNonMemberLeftClosedCircle( |
|
| 259 | |||
| 260 | |||
| 261 | /** |
||
| 262 | * Parse on Subject 'member_remove'. |
||
| 263 | * If circle is closed and member was not a real member, we send him to |
||
| 264 | * parseSubjectNonMemberRemoveClosedCircle(); |
||
| 265 | * |
||
| 266 | * @param IEvent $event |
||
| 267 | * @param Circle $circle |
||
| 268 | * @param Member $member |
||
| 269 | * |
||
| 270 | * @return IEvent |
||
| 271 | */ |
||
| 272 | View Code Duplication | private function parseSubjectMemberRemove(IEvent &$event, Circle $circle, Member $member) { |
|
| 286 | |||
| 287 | |||
| 288 | /** |
||
| 289 | * Parse on Subject 'member_remove' on a closed circle when user were not yet a member. |
||
| 290 | * If status is Invited we say that author cancelled his invitation. |
||
| 291 | * If status is Requested we say that his invitation was rejected. |
||
| 292 | * |
||
| 293 | * @param IEvent $event |
||
| 294 | * @param Circle $circle |
||
| 295 | * @param Member $member |
||
| 296 | * |
||
| 297 | * @return IEvent |
||
| 298 | */ |
||
| 299 | View Code Duplication | private function parseSubjectNonMemberRemoveClosedCircle( |
|
| 318 | |||
| 319 | |||
| 320 | /** |
||
| 321 | * @param Circle $circle |
||
| 322 | * @param IEvent $event |
||
| 323 | * @param array $params |
||
| 324 | * |
||
| 325 | * @return IEvent |
||
| 326 | * @throws Exception |
||
| 327 | */ |
||
| 328 | private function parseAsModerator(IEvent &$event, Circle $circle, $params) { |
||
| 351 | |||
| 352 | |||
| 353 | /** |
||
| 354 | * @param Circle $circle |
||
| 355 | * @param IEvent $event |
||
| 356 | * |
||
| 357 | * @return IEvent |
||
| 358 | */ |
||
| 359 | private function parseGroupAsModerator(IEvent &$event, Circle $circle) { |
||
| 398 | |||
| 399 | |||
| 400 | /** |
||
| 401 | * @param Circle $circle |
||
| 402 | * @param IEvent $event |
||
| 403 | * |
||
| 404 | * @return IEvent |
||
| 405 | */ |
||
| 406 | private function parseMemberAsModerator(IEvent &$event, Circle $circle) { |
||
| 447 | |||
| 448 | |||
| 449 | /** |
||
| 450 | * @param Circle $circle |
||
| 451 | * @param IEvent $event |
||
| 452 | * |
||
| 453 | * @return IEvent |
||
| 454 | */ |
||
| 455 | private function parseLinkAsModerator(IEvent &$event, Circle $circle) { |
||
| 540 | |||
| 541 | |||
| 542 | /** |
||
| 543 | * general function to generate Circle event. |
||
| 544 | * |
||
| 545 | * @param IEvent $event |
||
| 546 | * @param Circle $circle |
||
| 547 | * @param FederatedLink $remote |
||
| 548 | * @param string $ownEvent |
||
| 549 | * @param string $othersEvent |
||
| 550 | * |
||
| 551 | * @return IEvent |
||
| 552 | */ |
||
| 553 | private function parseCircleEvent( |
||
| 568 | |||
| 569 | |||
| 570 | /** |
||
| 571 | * general function to generate Member event. |
||
| 572 | * |
||
| 573 | * @param Circle $circle |
||
| 574 | * @param $member |
||
| 575 | * @param IEvent $event |
||
| 576 | * @param $ownEvent |
||
| 577 | * @param $othersEvent |
||
| 578 | * |
||
| 579 | * @return IEvent |
||
| 580 | */ |
||
| 581 | private function parseMemberEvent( |
||
| 596 | |||
| 597 | |||
| 598 | /** |
||
| 599 | * general function to generate Link event. |
||
| 600 | * |
||
| 601 | * @param Circle $circle |
||
| 602 | * @param FederatedLink $remote |
||
| 603 | * @param IEvent $event |
||
| 604 | * @param string $line |
||
| 605 | * |
||
| 606 | * @return IEvent |
||
| 607 | */ |
||
| 608 | private function parseLinkEvent(IEvent &$event, Circle $circle, FederatedLink $remote, $line) { |
||
| 616 | |||
| 617 | |||
| 618 | /** |
||
| 619 | * general function to generate Circle+Member event. |
||
| 620 | * |
||
| 621 | * @param Circle $circle |
||
| 622 | * @param Member $member |
||
| 623 | * @param IEvent $event |
||
| 624 | * @param string $ownEvent |
||
| 625 | * @param string $othersEvent |
||
| 626 | * |
||
| 627 | * @return IEvent |
||
| 628 | */ |
||
| 629 | private function parseCircleMemberEvent( |
||
| 645 | |||
| 646 | |||
| 647 | /** |
||
| 648 | * general function to generate Circle+Member advanced event. |
||
| 649 | * |
||
| 650 | * @param Circle $circle |
||
| 651 | * @param Member $member |
||
| 652 | * @param IEvent $event |
||
| 653 | *\ |
||
| 654 | * @param $ownEvent |
||
| 655 | * @param $targetEvent |
||
| 656 | * @param $othersEvent |
||
| 657 | * |
||
| 658 | * @return IEvent |
||
| 659 | */ |
||
| 660 | private function parseCircleMemberAdvancedEvent( |
||
| 679 | |||
| 680 | |||
| 681 | /** |
||
| 682 | * @param IEvent $event |
||
| 683 | */ |
||
| 684 | private function generateParsedSubject(IEvent &$event) { |
||
| 696 | |||
| 697 | |||
| 698 | /** |
||
| 699 | * @param Circle $circle |
||
| 700 | * @param string $userId |
||
| 701 | * |
||
| 702 | * @return bool |
||
| 703 | */ |
||
| 704 | private function isViewerTheAuthor(Circle $circle, $userId) { |
||
| 716 | |||
| 717 | |||
| 718 | /** |
||
| 719 | * @param Circle $circle |
||
| 720 | * |
||
| 721 | * @return string|array <string,string|integer> |
||
| 722 | */ |
||
| 723 | private function generateViewerParameter(Circle $circle) { |
||
| 730 | |||
| 731 | |||
| 732 | /** |
||
| 733 | * @param Circle $circle |
||
| 734 | * |
||
| 735 | * @return array<string,string|integer> |
||
| 736 | */ |
||
| 737 | private function generateCircleParameter(Circle $circle) { |
||
| 746 | |||
| 747 | |||
| 748 | /** |
||
| 749 | * @param FederatedLink $link |
||
| 750 | * |
||
| 751 | * @return array<string,string|integer> |
||
| 752 | */ |
||
| 753 | private function generateRemoteCircleParameter(FederatedLink $link) { |
||
| 761 | |||
| 762 | |||
| 763 | /** |
||
| 764 | * @param Member $member |
||
| 765 | * |
||
| 766 | * @return array <string,string|integer> |
||
| 767 | */ |
||
| 768 | private function generateUserParameter(Member $member) { |
||
| 776 | |||
| 777 | |||
| 778 | /** |
||
| 779 | * @param Member $group |
||
| 780 | * |
||
| 781 | * @return array <string,string|integer> |
||
| 782 | */ |
||
| 783 | private function generateGroupParameter($group) { |
||
| 791 | } |
||
| 792 |
Loading history...
This method has been deprecated.