jofner /
Twitch-SDK
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 TwitchSDK 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 TwitchSDK, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 18 | class TwitchSDK |
||
| 19 | { |
||
| 20 | /** |
||
| 21 | * @var array|bool |
||
| 22 | * @todo Create setter and getter with data validation |
||
| 23 | */ |
||
| 24 | protected $authConfig = false; |
||
| 25 | |||
| 26 | /** @var TwitchRequest */ |
||
| 27 | protected $request; |
||
| 28 | |||
| 29 | /** @var Helper */ |
||
| 30 | protected $helper; |
||
| 31 | |||
| 32 | /** |
||
| 33 | * TwitchAPI URI's |
||
| 34 | */ |
||
| 35 | const URI_CHANNEL = 'channels/'; |
||
| 36 | const URI_STREAMS_SEARCH = 'search/streams/'; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * TwitchSDK constructor |
||
| 40 | * @param array $config |
||
| 41 | * @throws TwitchException |
||
| 42 | */ |
||
| 43 | public function __construct(array $config = array()) |
||
| 60 | |||
| 61 | /** |
||
| 62 | * authConfig setter |
||
| 63 | * @param array $config |
||
| 64 | * @return TwitchSDK |
||
| 65 | * @throws TwitchException |
||
| 66 | */ |
||
| 67 | public function setAuthConfig(array $config) |
||
| 77 | |||
| 78 | /** |
||
| 79 | * Basic information about the API and authentication status |
||
| 80 | * @param null $token |
||
| 81 | * @return \stdClass |
||
| 82 | * @throws TwitchException |
||
| 83 | */ |
||
| 84 | public function status($token = null) |
||
| 98 | |||
| 99 | /** |
||
| 100 | * Get the specified user |
||
| 101 | * @param $username |
||
| 102 | * @return \stdClass |
||
| 103 | * @throws TwitchException |
||
| 104 | */ |
||
| 105 | public function userGet($username) |
||
| 110 | |||
| 111 | /** |
||
| 112 | * Get a user's list of followed channels |
||
| 113 | * @param string $user |
||
| 114 | * @param integer $limit |
||
| 115 | * @param integer $offset |
||
| 116 | * @param string $direction |
||
| 117 | * @param string $sortby |
||
| 118 | * @return \stdClass |
||
| 119 | * @throws TwitchException |
||
| 120 | */ |
||
| 121 | View Code Duplication | public function userFollowChannels($user, $limit = null, $offset = null, $direction = null, $sortby = null) |
|
| 134 | |||
| 135 | /** |
||
| 136 | * Get the status of a follow relationship |
||
| 137 | * @param string $user |
||
| 138 | * @param string $channel |
||
| 139 | * @return \stdClass |
||
| 140 | * @throws TwitchException |
||
| 141 | */ |
||
| 142 | public function userFollowRelationship($user, $channel) |
||
| 148 | |||
| 149 | /** |
||
| 150 | * Set user to follow given channel |
||
| 151 | * - requires scope 'user_follows_edit' |
||
| 152 | * @param string $user |
||
| 153 | * @param string $channel |
||
| 154 | * @param string $userToken |
||
| 155 | * @param bool $notifications |
||
| 156 | * @return \stdClass |
||
| 157 | * @throws TwitchException |
||
| 158 | */ |
||
| 159 | View Code Duplication | public function userFollowChannel($user, $channel, $userToken, $notifications = false) |
|
| 170 | |||
| 171 | /** |
||
| 172 | * Set user to unfollow given channel |
||
| 173 | * - requires scope 'user_follows_edit' |
||
| 174 | * @param string $user |
||
| 175 | * @param string $channel |
||
| 176 | * @param string $userToken |
||
| 177 | * @return \stdClass |
||
| 178 | * @throws TwitchException |
||
| 179 | */ |
||
| 180 | View Code Duplication | public function userUnfollowChannel($user, $channel, $userToken) |
|
| 190 | |||
| 191 | /** |
||
| 192 | * Get the specified channel |
||
| 193 | * @param string $channelName |
||
| 194 | * @return \stdClass |
||
| 195 | * @throws TwitchException |
||
| 196 | */ |
||
| 197 | public function channelGet($channelName) |
||
| 203 | |||
| 204 | /** |
||
| 205 | * Return team list for specified channel |
||
| 206 | * @param string $channelName |
||
| 207 | * @return \stdClass |
||
| 208 | * @throws TwitchException |
||
| 209 | */ |
||
| 210 | public function channelTeamsGet($channelName) |
||
| 216 | |||
| 217 | /** |
||
| 218 | * Get the specified team |
||
| 219 | * @param $teamName |
||
| 220 | * @return \stdClass |
||
| 221 | * @throws TwitchException |
||
| 222 | */ |
||
| 223 | public function teamGet($teamName) |
||
| 229 | |||
| 230 | /** |
||
| 231 | * Returns a list of active teams |
||
| 232 | * @param integer $limit |
||
| 233 | * @param integer $offset |
||
| 234 | * @return \stdClass |
||
| 235 | * @throws TwitchException |
||
| 236 | */ |
||
| 237 | View Code Duplication | public function teamList($limit = null, $offset = null) |
|
| 248 | |||
| 249 | /** |
||
| 250 | * Get all team members |
||
| 251 | * @param $teamName |
||
| 252 | * @return mixed |
||
| 253 | * @throws TwitchException |
||
| 254 | */ |
||
| 255 | public function teamMembersAll($teamName) |
||
| 259 | |||
| 260 | /** |
||
| 261 | * Returns an array of users who follow the specified channel |
||
| 262 | * @param string $channelName |
||
| 263 | * @param integer $limit |
||
| 264 | * @param integer $offset |
||
| 265 | * @param string $cursor |
||
| 266 | * @param string $direction |
||
| 267 | * @return \stdClass |
||
| 268 | * @throws TwitchException |
||
| 269 | */ |
||
| 270 | View Code Duplication | public function channelFollows($channelName, $limit = null, $offset = null, $cursor = null, $direction = null) |
|
| 283 | |||
| 284 | /** |
||
| 285 | * Get the specified channel's stream |
||
| 286 | * @param $channel |
||
| 287 | * @return \stdClass |
||
| 288 | * @throws TwitchException |
||
| 289 | */ |
||
| 290 | public function streamGet($channel) |
||
| 296 | |||
| 297 | /** |
||
| 298 | * Search live streams |
||
| 299 | * @param $query |
||
| 300 | * @param null $limit |
||
| 301 | * @param null $offset |
||
| 302 | * @return \stdClass |
||
| 303 | * @throws TwitchException |
||
| 304 | * @deprecated will be replaced by getStreams() function |
||
| 305 | */ |
||
| 306 | View Code Duplication | public function streamSearch($query, $limit = null, $offset = null) |
|
| 316 | |||
| 317 | /** |
||
| 318 | * Summarize streams |
||
| 319 | * @param null $game |
||
| 320 | * @param array|null $channels |
||
| 321 | * @param null $hls |
||
| 322 | * @return \stdClass |
||
| 323 | * @throws TwitchException |
||
| 324 | */ |
||
| 325 | View Code Duplication | public function streamsSummarize($game = null, array $channels = null, $hls = null) |
|
| 341 | |||
| 342 | /** |
||
| 343 | * Get featured streams |
||
| 344 | * @param null $limit |
||
| 345 | * @param null $offset |
||
| 346 | * @param null $hls |
||
| 347 | * @return \stdClass |
||
| 348 | * @throws TwitchException |
||
| 349 | */ |
||
| 350 | View Code Duplication | public function streamsFeatured($limit = null, $offset = null, $hls = null) |
|
| 362 | |||
| 363 | /** |
||
| 364 | * Get streams by channel |
||
| 365 | * @param $channels |
||
| 366 | * @param null $limit |
||
| 367 | * @param null $offset |
||
| 368 | * @param null $embeddable |
||
| 369 | * @param null $hls |
||
| 370 | * @return \stdClass |
||
| 371 | * @deprecated will be replaced by getStreams() function |
||
| 372 | */ |
||
| 373 | public function streamsByChannels($channels, $limit = null, $offset = null, $embeddable = null, $hls = null) |
||
| 379 | |||
| 380 | /** |
||
| 381 | * Get streams by game |
||
| 382 | * @param $game |
||
| 383 | * @param null $limit |
||
| 384 | * @param null $offset |
||
| 385 | * @param null $embeddable |
||
| 386 | * @param null $hls |
||
| 387 | * @return \stdClass |
||
| 388 | * @deprecated will be replaced by getStreams() function |
||
| 389 | */ |
||
| 390 | public function streamsByGame($game, $limit = null, $offset = null, $embeddable = null, $hls = null) |
||
| 394 | |||
| 395 | /** |
||
| 396 | * Get video |
||
| 397 | * @param string $videoId |
||
| 398 | * @return \stdClass |
||
| 399 | * @throws TwitchException |
||
| 400 | */ |
||
| 401 | public function videoGet($videoId) |
||
| 407 | |||
| 408 | /** |
||
| 409 | * Returns top videos |
||
| 410 | * @param integer $limit |
||
| 411 | * @param integer $offset |
||
| 412 | * @param string $game |
||
| 413 | * @param string $period |
||
| 414 | * @return \stdClass |
||
| 415 | * @throws TwitchException |
||
| 416 | */ |
||
| 417 | public function videosTop($limit = null, $offset = null, $game = null, $period = null) |
||
| 430 | |||
| 431 | /** |
||
| 432 | * Get videos for a channel |
||
| 433 | * @param $channel |
||
| 434 | * @param null $limit |
||
| 435 | * @param null $offset |
||
| 436 | * @param bool $broadcasts |
||
| 437 | * @param bool $hls |
||
| 438 | * @return \stdClass |
||
| 439 | * @throws TwitchException |
||
| 440 | */ |
||
| 441 | View Code Duplication | public function videosByChannel($channel, $limit = null, $offset = null, $broadcasts = null, $hls = null) |
|
| 454 | |||
| 455 | /** |
||
| 456 | * Returns a links object to all other chat endpoints |
||
| 457 | * @param string $channelName |
||
| 458 | * @return \stdClass |
||
| 459 | * @throws TwitchException |
||
| 460 | */ |
||
| 461 | public function chatGet($channelName) |
||
| 467 | |||
| 468 | /** |
||
| 469 | * Get a chat's emoticons |
||
| 470 | * @return \stdClass |
||
| 471 | * @throws TwitchException |
||
| 472 | */ |
||
| 473 | public function chatEmoticons() |
||
| 479 | |||
| 480 | /** |
||
| 481 | * Returns a list of emoticons |
||
| 482 | * @param string $emoteset |
||
| 483 | * @return \stdClass |
||
| 484 | * @throws TwitchException |
||
| 485 | */ |
||
| 486 | View Code Duplication | public function chatEmoticonsImages($emoteset = null) |
|
| 496 | |||
| 497 | /** |
||
| 498 | * Returns a list of chat badges |
||
| 499 | * @param string $channelName |
||
| 500 | * @return \stdClass |
||
| 501 | * @throws TwitchException |
||
| 502 | */ |
||
| 503 | public function chatBadges($channelName) |
||
| 509 | |||
| 510 | /** |
||
| 511 | * Get top games |
||
| 512 | * @param integer $limit |
||
| 513 | * @param integer $offset |
||
| 514 | * @return \stdClass |
||
| 515 | * @throws TwitchException |
||
| 516 | */ |
||
| 517 | View Code Duplication | public function gamesTop($limit = null, $offset = null) |
|
| 528 | |||
| 529 | /** |
||
| 530 | * Get HTML code for stream embedding |
||
| 531 | * @param $channel |
||
| 532 | * @param int $width |
||
| 533 | * @param int $height |
||
| 534 | * @param int $volume |
||
| 535 | * @return string |
||
| 536 | */ |
||
| 537 | View Code Duplication | public function embedStream($channel, $width = 620, $height = 378, $volume = 25) |
|
| 557 | |||
| 558 | /** |
||
| 559 | * Get HTML code for video embedding |
||
| 560 | * @param $channel |
||
| 561 | * @param $chapterid |
||
| 562 | * @param int $width |
||
| 563 | * @param int $height |
||
| 564 | * @param int $volume |
||
| 565 | * @return string |
||
| 566 | */ |
||
| 567 | View Code Duplication | public function embedVideo($channel, $chapterid, $width = 400, $height = 300, $volume = 25) |
|
| 587 | |||
| 588 | /** |
||
| 589 | * Get HTML code for chat embedding |
||
| 590 | * @param $channel |
||
| 591 | * @param int $width |
||
| 592 | * @param int $height |
||
| 593 | * @return string |
||
| 594 | */ |
||
| 595 | public function embedChat($channel, $width = 400, $height = 300) |
||
| 605 | |||
| 606 | /** |
||
| 607 | * Get login URL for authentication |
||
| 608 | * @param string $scope Specify which permissions your app requires (space separated list) |
||
| 609 | * @return string |
||
| 610 | * @throws TwitchException |
||
| 611 | */ |
||
| 612 | View Code Duplication | public function authLoginURL($scope) |
|
| 629 | |||
| 630 | /** |
||
| 631 | * Get authentication access token |
||
| 632 | * @param string $code returned after app authorization by user |
||
| 633 | * @return \stdClass |
||
| 634 | * @throws TwitchException |
||
| 635 | */ |
||
| 636 | View Code Duplication | public function authAccessTokenGet($code) |
|
| 654 | |||
| 655 | /** |
||
| 656 | * Get the authenticated user |
||
| 657 | * - requires scope 'user_read' |
||
| 658 | * @param string |
||
| 659 | * @return \stdClass |
||
| 660 | * @throws TwitchException |
||
| 661 | */ |
||
| 662 | public function authUserGet($token) |
||
| 676 | |||
| 677 | /** |
||
| 678 | * Get the authenticated channel |
||
| 679 | * - requires scope 'channel_read' |
||
| 680 | * @param string |
||
| 681 | * @return \stdClass |
||
| 682 | * @throws TwitchException |
||
| 683 | */ |
||
| 684 | public function authChannelGet($token) |
||
| 699 | |||
| 700 | /** |
||
| 701 | * Update channel's status or game |
||
| 702 | * - requires scope 'channel_editor' |
||
| 703 | * @param $token |
||
| 704 | * @param string $channelName |
||
| 705 | * @param string $status |
||
| 706 | * @param string $game |
||
| 707 | * @param integer $delay |
||
| 708 | * @return \stdClass |
||
| 709 | * @throws TwitchException |
||
| 710 | */ |
||
| 711 | public function authChannelSet($token, $channelName, $status = null, $game = null, $delay = null) |
||
| 732 | |||
| 733 | /** |
||
| 734 | * Resets channel's stream key |
||
| 735 | * - requires scope 'channel_stream' |
||
| 736 | * @param string $token |
||
| 737 | * @param string $channelName |
||
| 738 | * @return \stdClass |
||
| 739 | * @throws TwitchException |
||
| 740 | */ |
||
| 741 | public function authChannelResetKey($token, $channelName) |
||
| 756 | |||
| 757 | /** |
||
| 758 | * Returns an array of users who are editors of specified channel |
||
| 759 | * - requires scope 'channel_read' |
||
| 760 | * @param string |
||
| 761 | * @param string |
||
| 762 | * @return \stdClass |
||
| 763 | * @throws TwitchException |
||
| 764 | */ |
||
| 765 | public function authChannelEditors($token, $channel) |
||
| 780 | |||
| 781 | /** |
||
| 782 | * Returns an array of subscriptions who are subscribed to specified channel |
||
| 783 | * - requires scope 'channel_subscriptions' |
||
| 784 | * @param string $token - user's access token |
||
| 785 | * @param string $channel |
||
| 786 | * @param integer $limit - can be up to 100 |
||
| 787 | * @param integer $offset |
||
| 788 | * @param string $direction can be DESC|ASC, if DESC - lasts will be showed first |
||
| 789 | * @return \stdClass |
||
| 790 | * @throws TwitchException |
||
| 791 | */ |
||
| 792 | View Code Duplication | public function authChannelSubscriptions($token, $channel, $limit = 25, $offset = 0, $direction = 'DESC') |
|
| 810 | |||
| 811 | /** |
||
| 812 | * List the live streams that the authenticated user is following |
||
| 813 | * - requires scope 'user_read' |
||
| 814 | * @param string |
||
| 815 | * @param integer $limit |
||
| 816 | * @param integer $offset |
||
| 817 | * @param bool $hls |
||
| 818 | * @return \stdClass |
||
| 819 | * @throws TwitchException |
||
| 820 | */ |
||
| 821 | View Code Duplication | public function authStreamsFollowed($token, $limit = 25, $offset = 0, $hls = null) |
|
| 838 | |||
| 839 | /** |
||
| 840 | * Get streams helper |
||
| 841 | * @param null $game |
||
| 842 | * @param null $limit |
||
| 843 | * @param null $offset |
||
| 844 | * @param null $channels |
||
| 845 | * @param null $embeddable |
||
| 846 | * @param null $hls |
||
| 847 | * @return \stdClass |
||
| 848 | * @throws TwitchException |
||
| 849 | */ |
||
| 850 | public function getStreams($game = null, $limit = null, $offset = null, $channels = null, $embeddable = null, $hls = null) |
||
| 866 | |||
| 867 | /** |
||
| 868 | * Validate parameters for authentication |
||
| 869 | * @param array |
||
| 870 | * @return boolean |
||
| 871 | */ |
||
| 872 | private function configValidate($config) |
||
| 887 | |||
| 888 | /** |
||
| 889 | * Configuration exception |
||
| 890 | * @throws TwitchException |
||
| 891 | */ |
||
| 892 | private function authConfigException() |
||
| 896 | } |
||
| 897 |
Loading history...
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.