Complex classes like Client 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 Client, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 13 | class Client |
||
| 14 | { |
||
| 15 | /** |
||
| 16 | * Microsoft Exchange 2007 |
||
| 17 | * |
||
| 18 | * @var string |
||
| 19 | */ |
||
| 20 | const VERSION_2007 = 'Exchange2007'; |
||
| 21 | |||
| 22 | /** |
||
| 23 | * Microsoft Exchange 2007 SP1 |
||
| 24 | * |
||
| 25 | * @var string |
||
| 26 | */ |
||
| 27 | const VERSION_2007_SP1 = 'Exchange2007_SP1'; |
||
| 28 | |||
| 29 | /** |
||
| 30 | * Microsoft Exchange 2007 SP2 |
||
| 31 | * |
||
| 32 | * @var string |
||
| 33 | */ |
||
| 34 | const VERSION_2007_SP2 = 'Exchange2007_SP2'; |
||
| 35 | |||
| 36 | /** |
||
| 37 | * Microsoft Exchange 2007 SP3 |
||
| 38 | * |
||
| 39 | * @var string |
||
| 40 | */ |
||
| 41 | const VERSION_2007_SP3 = 'Exchange2007_SP3'; |
||
| 42 | |||
| 43 | /** |
||
| 44 | * Microsoft Exchange 2010 |
||
| 45 | * |
||
| 46 | * @var string |
||
| 47 | */ |
||
| 48 | const VERSION_2010 = 'Exchange2010'; |
||
| 49 | |||
| 50 | /** |
||
| 51 | * Microsoft Exchange 2010 SP1 |
||
| 52 | * |
||
| 53 | * @var string |
||
| 54 | */ |
||
| 55 | const VERSION_2010_SP1 = 'Exchange2010_SP1'; |
||
| 56 | |||
| 57 | /** |
||
| 58 | * Microsoft Exchange 2010 SP2 |
||
| 59 | * |
||
| 60 | * @var string |
||
| 61 | */ |
||
| 62 | const VERSION_2010_SP2 = 'Exchange2010_SP2'; |
||
| 63 | |||
| 64 | /** |
||
| 65 | * Microsoft Exchange 2013. |
||
| 66 | * |
||
| 67 | * @var string |
||
| 68 | */ |
||
| 69 | const VERSION_2013 = 'Exchange2013'; |
||
| 70 | |||
| 71 | /** |
||
| 72 | * Microsoft Exchange 2013 SP1. |
||
| 73 | * |
||
| 74 | * @var string |
||
| 75 | */ |
||
| 76 | const VERSION_2013_SP1 = 'Exchange2013_SP1'; |
||
| 77 | |||
| 78 | /** |
||
| 79 | * Microsoft Exchange 2016. |
||
| 80 | * |
||
| 81 | * @var string |
||
| 82 | */ |
||
| 83 | const VERSION_2016 = 'Exchange2016'; |
||
| 84 | |||
| 85 | /** |
||
| 86 | * Password to use when connecting to the Exchange server. |
||
| 87 | * |
||
| 88 | * @var string |
||
| 89 | */ |
||
| 90 | protected $password; |
||
| 91 | |||
| 92 | /** |
||
| 93 | * Location of the Exchange server. |
||
| 94 | * |
||
| 95 | * @var string |
||
| 96 | */ |
||
| 97 | protected $server; |
||
| 98 | |||
| 99 | /** |
||
| 100 | * SOAP client used to make the request |
||
| 101 | * |
||
| 102 | * @var \jamesiarmes\PhpEws\SoapClient |
||
| 103 | */ |
||
| 104 | protected $soap; |
||
| 105 | |||
| 106 | /** |
||
| 107 | * Username to use when connecting to the Exchange server. |
||
| 108 | * |
||
| 109 | * @var string |
||
| 110 | */ |
||
| 111 | protected $username; |
||
| 112 | |||
| 113 | /** |
||
| 114 | * Exchange impersonation |
||
| 115 | * |
||
| 116 | * @var \jamesiarmes\PhpEws\Type\ExchangeImpersonationType |
||
| 117 | */ |
||
| 118 | protected $impersonation; |
||
| 119 | |||
| 120 | /** |
||
| 121 | * Miscrosoft Exchange version that we are going to connect to |
||
| 122 | * |
||
| 123 | * @var string |
||
| 124 | * |
||
| 125 | * @see Client::VERSION_2007 |
||
| 126 | * @see Client::VERSION_2007_SP1 |
||
| 127 | * @see Client::VERSION_2007_SP2 |
||
| 128 | * @see Client::VERSION_2007_SP3 |
||
| 129 | * @see Client::VERSION_2010 |
||
| 130 | * @see Client::VERSION_2010_SP1 |
||
| 131 | * @see Client::VERSION_2010_SP2 |
||
| 132 | */ |
||
| 133 | protected $version; |
||
| 134 | |||
| 135 | /** |
||
| 136 | * Constructor for the ExchangeWebServices class |
||
| 137 | * |
||
| 138 | * @param string $server |
||
| 139 | * @param string $username |
||
| 140 | * @param string $password |
||
| 141 | * @param string $version One of the Client::VERSION_* constants. |
||
| 142 | */ |
||
| 143 | public function __construct( |
||
| 155 | |||
| 156 | /** |
||
| 157 | * Returns the SOAP Client that may be used to make calls against the server |
||
| 158 | * |
||
| 159 | * @return \jamesiarmes\PhpEws\SoapClient |
||
| 160 | */ |
||
| 161 | public function getClient() |
||
| 165 | |||
| 166 | /** |
||
| 167 | * Sets the impersonation property |
||
| 168 | * |
||
| 169 | * @param \jamesiarmes\PhpEws\Type\ExchangeImpersonationType $impersonation |
||
| 170 | */ |
||
| 171 | public function setImpersonation($impersonation) |
||
| 177 | |||
| 178 | /** |
||
| 179 | * Sets the password property |
||
| 180 | * |
||
| 181 | * @param string $password |
||
| 182 | */ |
||
| 183 | public function setPassword($password) |
||
| 189 | |||
| 190 | /** |
||
| 191 | * Sets the server property |
||
| 192 | * |
||
| 193 | * @param string $server |
||
| 194 | */ |
||
| 195 | public function setServer($server) |
||
| 201 | |||
| 202 | /** |
||
| 203 | * Sets the user name property |
||
| 204 | * |
||
| 205 | * @param string $username |
||
| 206 | */ |
||
| 207 | public function setUsername($username) |
||
| 213 | |||
| 214 | /** |
||
| 215 | * Sets the version property |
||
| 216 | * |
||
| 217 | * @param string $version |
||
| 218 | */ |
||
| 219 | public function setVersion($version) |
||
| 225 | |||
| 226 | /** |
||
| 227 | * Function Description |
||
| 228 | * |
||
| 229 | * @param \jamesiarmes\PhpEws\Request\AddDelegateType $request |
||
| 230 | * @return \jamesiarmes\PhpEws\Response\AddDelegateResponseMessageType |
||
| 231 | */ |
||
| 232 | public function AddDelegate($request) |
||
| 239 | |||
| 240 | /** |
||
| 241 | * Adds a distribution group to the instant messaging (IM) list in the |
||
| 242 | * Unified Contact Store. |
||
| 243 | * |
||
| 244 | * @param \jamesiarmes\PhpEws\Request\AddDistributionGroupToImListType $request |
||
| 245 | * @return \jamesiarmes\PhpEws\Response\AddDistributionGroupToImListResponseMessageType |
||
| 246 | * |
||
| 247 | * @since Exchange 2013 |
||
| 248 | */ |
||
| 249 | public function AddDistributionGroupToImList($request) |
||
| 256 | |||
| 257 | /** |
||
| 258 | * Adds an existing instant messaging (IM) contact to a group. |
||
| 259 | * |
||
| 260 | * @param \jamesiarmes\PhpEws\Request\AddImContactToGroup $request |
||
| 261 | * @return \jamesiarmes\PhpEws\Response\AddImContactToGroupResponseMessageType |
||
| 262 | * |
||
| 263 | * @since Exchange 2013 |
||
| 264 | */ |
||
| 265 | public function AddImContactToGroup($request) |
||
| 272 | |||
| 273 | /** |
||
| 274 | * Adds a new instant messaging (IM) group to a mailbox. |
||
| 275 | * |
||
| 276 | * @param \jamesiarmes\PhpEws\Request\AddImGroupType $request |
||
| 277 | * @return \jamesiarmes\PhpEws\Response\AddImGroupResponseMessageType |
||
| 278 | * |
||
| 279 | * @since Exchange 2013 |
||
| 280 | */ |
||
| 281 | public function AddImGroup($request) |
||
| 288 | |||
| 289 | /** |
||
| 290 | * Function Description |
||
| 291 | * |
||
| 292 | * @param \jamesiarmes\PhpEws\Request\ConvertIdType $request |
||
| 293 | * @return \jamesiarmes\PhpEws\Response\ConvertIdResponseType |
||
| 294 | */ |
||
| 295 | public function ConvertId($request) |
||
| 302 | |||
| 303 | /** |
||
| 304 | * Function Description |
||
| 305 | * |
||
| 306 | * @param \jamesiarmes\PhpEws\Request\CopyFolderType $request |
||
| 307 | * @return \jamesiarmes\PhpEws\Response\CopyFolderResponseType |
||
| 308 | */ |
||
| 309 | public function CopyFolder($request) |
||
| 316 | |||
| 317 | /** |
||
| 318 | * Function Description |
||
| 319 | * |
||
| 320 | * @param \jamesiarmes\PhpEws\Request\CopyItemType $request |
||
| 321 | * @return \jamesiarmes\PhpEws\Response\CopyItemResponseType |
||
| 322 | */ |
||
| 323 | public function CopyItem($request) |
||
| 330 | |||
| 331 | /** |
||
| 332 | * Function Description |
||
| 333 | * |
||
| 334 | * @param \jamesiarmes\PhpEws\Request\CreateAttachmentType $request |
||
| 335 | * @return \jamesiarmes\PhpEws\Response\CreateAttachmentResponseType |
||
| 336 | */ |
||
| 337 | public function CreateAttachment($request) |
||
| 344 | |||
| 345 | /** |
||
| 346 | * Function Description |
||
| 347 | * |
||
| 348 | * @param \jamesiarmes\PhpEws\Request\CreateFolderType $request |
||
| 349 | * @return \jamesiarmes\PhpEws\Response\CreateFolderResponseType |
||
| 350 | */ |
||
| 351 | public function CreateFolder($request) |
||
| 358 | |||
| 359 | /** |
||
| 360 | * Function Description |
||
| 361 | * |
||
| 362 | * @param \jamesiarmes\PhpEws\Request\CreateItemType $request |
||
| 363 | * @return \jamesiarmes\PhpEws\Response\CreateItemResponseType |
||
| 364 | */ |
||
| 365 | public function CreateItem($request) |
||
| 372 | |||
| 373 | /** |
||
| 374 | * Function Description |
||
| 375 | * |
||
| 376 | * @param \jamesiarmes\PhpEws\Request\CreateManagedFolderRequestType $request |
||
| 377 | * @return \jamesiarmes\PhpEws\Response\CreateManagedFolderResponseType |
||
| 378 | */ |
||
| 379 | public function CreateManagedFolder($request) |
||
| 386 | |||
| 387 | /** |
||
| 388 | * Function Description |
||
| 389 | * |
||
| 390 | * @param \jamesiarmes\PhpEws\Request\DeleteAttachmentType $request |
||
| 391 | * @return \jamesiarmes\PhpEws\Response\DeleteAttachmentResponseType |
||
| 392 | */ |
||
| 393 | public function DeleteAttachment($request) |
||
| 400 | |||
| 401 | /** |
||
| 402 | * Function Description |
||
| 403 | * |
||
| 404 | * @param \jamesiarmes\PhpEws\Request\DeleteFolderType $request |
||
| 405 | * @return \jamesiarmes\PhpEws\Response\DeleteFolderResponseType |
||
| 406 | */ |
||
| 407 | public function DeleteFolder($request) |
||
| 414 | |||
| 415 | /** |
||
| 416 | * Function Description |
||
| 417 | * |
||
| 418 | * @param \jamesiarmes\PhpEws\Request\DeleteItemType $request |
||
| 419 | * @return \jamesiarmes\PhpEws\Response\DeleteItemResponseType |
||
| 420 | */ |
||
| 421 | public function DeleteItem($request) |
||
| 428 | |||
| 429 | /** |
||
| 430 | * Function Description |
||
| 431 | * |
||
| 432 | * @param \jamesiarmes\PhpEws\Request\ExpandDLType $request |
||
| 433 | * @return \jamesiarmes\PhpEws\Response\ExpandDLResponseType |
||
| 434 | */ |
||
| 435 | public function ExpandDL($request) |
||
| 442 | |||
| 443 | /** |
||
| 444 | * Function Description |
||
| 445 | * |
||
| 446 | * @param \jamesiarmes\PhpEws\Request\FindFolderType $request |
||
| 447 | * @return \jamesiarmes\PhpEws\Response\FindFolderResponseType |
||
| 448 | */ |
||
| 449 | public function FindFolder($request) |
||
| 456 | |||
| 457 | /** |
||
| 458 | * Function Description |
||
| 459 | * |
||
| 460 | * @param \jamesiarmes\PhpEws\Request\FindItemType $request |
||
| 461 | * @return \jamesiarmes\PhpEws\Response\FindItemResponseType |
||
| 462 | */ |
||
| 463 | public function FindItem($request) |
||
| 470 | |||
| 471 | /** |
||
| 472 | * Function Description |
||
| 473 | * |
||
| 474 | * @param \jamesiarmes\PhpEws\Request\GetAttachmentType $request |
||
| 475 | * @return \jamesiarmes\PhpEws\Response\GetAttachmentResponseType |
||
| 476 | */ |
||
| 477 | public function GetAttachment($request) |
||
| 484 | |||
| 485 | /** |
||
| 486 | * Function Description |
||
| 487 | * |
||
| 488 | * @param \jamesiarmes\PhpEws\Request\GetDelegateType $request |
||
| 489 | * @return \jamesiarmes\PhpEws\Response\GetDelegateResponseMessageType |
||
| 490 | */ |
||
| 491 | public function GetDelegate($request) |
||
| 498 | |||
| 499 | /** |
||
| 500 | * Function Description |
||
| 501 | * |
||
| 502 | * @param \jamesiarmes\PhpEws\Request\GetEventsType $request |
||
| 503 | * @return \jamesiarmes\PhpEws\Response\GetEventsResponseType |
||
| 504 | */ |
||
| 505 | public function GetEvents($request) |
||
| 512 | |||
| 513 | /** |
||
| 514 | * Function Description |
||
| 515 | * |
||
| 516 | * @param \jamesiarmes\PhpEws\Request\GetFolderType $request |
||
| 517 | * @return \jamesiarmes\PhpEws\Response\GetFolderResponseType |
||
| 518 | */ |
||
| 519 | public function GetFolder($request) |
||
| 526 | |||
| 527 | /** |
||
| 528 | * Function Description |
||
| 529 | * |
||
| 530 | * @param \jamesiarmes\PhpEws\Request\GetItemType $request |
||
| 531 | * @return \jamesiarmes\PhpEws\Response\GetItemResponseType |
||
| 532 | */ |
||
| 533 | public function GetItem($request) |
||
| 540 | |||
| 541 | /** |
||
| 542 | * Retrieve the timezones supported by the server. |
||
| 543 | * |
||
| 544 | * @since Exchange 2010 |
||
| 545 | * |
||
| 546 | * @param \jamesiarmes\PhpEws\Request\GetServerTimeZonesType $request |
||
| 547 | * @return \jamesiarmes\PhpEws\Response\GetServerTimeZonesResponseType |
||
| 548 | */ |
||
| 549 | public function GetServerTimeZones($request) |
||
| 556 | |||
| 557 | /** |
||
| 558 | * Function Description |
||
| 559 | * |
||
| 560 | * @param \jamesiarmes\PhpEws\Request\GetUserAvailabilityRequestType $request |
||
| 561 | * @return \jamesiarmes\PhpEws\Response\GetUserAvailabilityResponseType |
||
| 562 | */ |
||
| 563 | public function GetUserAvailability($request) |
||
| 570 | |||
| 571 | /** |
||
| 572 | * Function Description |
||
| 573 | * |
||
| 574 | * @param \jamesiarmes\PhpEws\Request\GetUserOofSettingsRequest $request |
||
| 575 | * @return \jamesiarmes\PhpEws\Response\GetUserOofSettingsResponse |
||
| 576 | */ |
||
| 577 | public function GetUserOofSettings($request) |
||
| 584 | |||
| 585 | /** |
||
| 586 | * Function Description |
||
| 587 | * |
||
| 588 | * @param \jamesiarmes\PhpEws\Request\MoveFolderType $request |
||
| 589 | * @return \jamesiarmes\PhpEws\Response\MoveFolderResponseType |
||
| 590 | */ |
||
| 591 | public function MoveFolder($request) |
||
| 598 | |||
| 599 | /** |
||
| 600 | * Function Description |
||
| 601 | * |
||
| 602 | * @param \jamesiarmes\PhpEws\Request\MoveItemType $request |
||
| 603 | * @return \jamesiarmes\PhpEws\Response\MoveItemResponseType |
||
| 604 | */ |
||
| 605 | public function MoveItem($request) |
||
| 612 | |||
| 613 | /** |
||
| 614 | * Function Description |
||
| 615 | * |
||
| 616 | * @param \jamesiarmes\PhpEws\Request\RemoveDelegateType $request |
||
| 617 | * @return \jamesiarmes\PhpEws\Response\RemoveDelegateResponseMessageType |
||
| 618 | */ |
||
| 619 | public function RemoveDelegate($request) |
||
| 626 | |||
| 627 | /** |
||
| 628 | * Function Description |
||
| 629 | * |
||
| 630 | * @param \jamesiarmes\PhpEws\Request\ResolveNamesType $request |
||
| 631 | * @return \jamesiarmes\PhpEws\Response\ResolveNamesResponseType |
||
| 632 | */ |
||
| 633 | public function ResolveNames($request) |
||
| 640 | |||
| 641 | /** |
||
| 642 | * Function Description |
||
| 643 | * |
||
| 644 | * @param \jamesiarmes\PhpEws\Request\SendItemType $request |
||
| 645 | * @return \jamesiarmes\PhpEws\Response\SendItemResponseType |
||
| 646 | */ |
||
| 647 | public function SendItem($request) |
||
| 654 | |||
| 655 | /** |
||
| 656 | * Function Description |
||
| 657 | * |
||
| 658 | * @param \jamesiarmes\PhpEws\Request\SetUserOofSettingsRequest $request |
||
| 659 | * @return \jamesiarmes\PhpEws\Response\SetUserOofSettingsResponse |
||
| 660 | */ |
||
| 661 | public function SetUserOofSettings($request) |
||
| 668 | |||
| 669 | /** |
||
| 670 | * Function Description |
||
| 671 | * |
||
| 672 | * @param \jamesiarmes\PhpEws\Request\SubscribeType $request |
||
| 673 | * @return \jamesiarmes\PhpEws\Response\SubscribeResponseType |
||
| 674 | */ |
||
| 675 | public function Subscribe($request) |
||
| 682 | |||
| 683 | /** |
||
| 684 | * Function Description |
||
| 685 | * |
||
| 686 | * @param \jamesiarmes\PhpEws\Request\SyncFolderHierarchyType $request |
||
| 687 | * @return \jamesiarmes\PhpEws\Response\SyncFolderHierarchyResponseType |
||
| 688 | */ |
||
| 689 | public function SyncFolderHierarchy($request) |
||
| 696 | |||
| 697 | /** |
||
| 698 | * Function Description |
||
| 699 | * |
||
| 700 | * @param \jamesiarmes\PhpEws\Request\SyncFolderItemsType $request |
||
| 701 | * @return \jamesiarmes\PhpEws\Response\SyncFolderItemsResponseType |
||
| 702 | */ |
||
| 703 | public function SyncFolderItems($request) |
||
| 710 | |||
| 711 | /** |
||
| 712 | * Function Description |
||
| 713 | * |
||
| 714 | * @param \jamesiarmes\PhpEws\Request\UnsubscribeType $request |
||
| 715 | * @return \jamesiarmes\PhpEws\Response\UnsubscribeResponseType |
||
| 716 | */ |
||
| 717 | public function Unsubscribe($request) |
||
| 724 | |||
| 725 | /** |
||
| 726 | * Function Description |
||
| 727 | * |
||
| 728 | * @param \jamesiarmes\PhpEws\Request\UpdateDelegateType $request |
||
| 729 | * @return \jamesiarmes\PhpEws\Response\UpdateDelegateResponseMessageType |
||
| 730 | */ |
||
| 731 | public function UpdateDelegate($request) |
||
| 738 | |||
| 739 | /** |
||
| 740 | * Function Description |
||
| 741 | * |
||
| 742 | * @param \jamesiarmes\PhpEws\Request\UpdateFolderType $request |
||
| 743 | * @return \jamesiarmes\PhpEws\Response\UpdateFolderResponseType |
||
| 744 | */ |
||
| 745 | public function UpdateFolder($request) |
||
| 752 | |||
| 753 | /** |
||
| 754 | * Function Description |
||
| 755 | * |
||
| 756 | * @param \jamesiarmes\PhpEws\Request\UpdateItemType $request |
||
| 757 | * @return \jamesiarmes\PhpEws\Response\UpdateItemResponseType |
||
| 758 | */ |
||
| 759 | public function UpdateItem($request) |
||
| 766 | |||
| 767 | /** |
||
| 768 | * Initializes the SoapClient object to make a request |
||
| 769 | * |
||
| 770 | * @return \jamesiarmes\PhpEws\SoapClient |
||
| 771 | * |
||
| 772 | * TODO: Build a class map that we can pass to the client. |
||
| 773 | */ |
||
| 774 | protected function initializeSoapClient() |
||
| 789 | |||
| 790 | /** |
||
| 791 | * Process a response to verify that it succeeded and take the appropriate |
||
| 792 | * action |
||
| 793 | * |
||
| 794 | * @throws \Exception |
||
| 795 | * |
||
| 796 | * @param \stdClass $response |
||
| 797 | * @return \stdClass |
||
| 798 | */ |
||
| 799 | protected function processResponse($response) |
||
| 812 | } |
||
| 813 |