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:
| 1 | <?php | ||
| 15 | View Code Duplication | class Chat | |
| 16 | { | ||
| 17 | /** @var TwitchRequest */ | ||
| 18 | protected $request; | ||
| 19 | |||
| 20 | const URI_CHAT = 'chat/'; | ||
| 21 | const URI_CHAT_EMOTICONS = 'chat/emoticons'; | ||
| 22 | const URI_CHAT_EMOTICONS_IMAGES = 'chat/emoticon_images'; | ||
| 23 | const URI_CHAT_BADGES = 'chat/%s/badges'; | ||
| 24 | |||
| 25 | /** | ||
| 26 | * Chat constructor | ||
| 27 | * @param TwitchRequest $request | ||
| 28 | */ | ||
| 29 | public function __construct(TwitchRequest $request) | ||
| 33 | |||
| 34 | /** | ||
| 35 | * Returns a links object to all other chat endpoints | ||
| 36 | * @see https://github.com/justintv/Twitch-API/blob/master/v3_resources/chat.md#get-chatchannel | ||
| 37 | * @param string $channel | ||
| 38 | * @return \stdClass | ||
| 39 | * @throws TwitchSDKException | ||
| 40 | */ | ||
| 41 | public function getChat($channel) | ||
| 45 | |||
| 46 | /** | ||
| 47 | * Get a chat's emoticons | ||
| 48 | * @see https://github.com/justintv/Twitch-API/blob/master/v3_resources/chat.md#get-chatemoticons | ||
| 49 | * @return \stdClass | ||
| 50 | * @throws TwitchSDKException | ||
| 51 | */ | ||
| 52 | public function getEmoticons() | ||
| 56 | |||
| 57 | /** | ||
| 58 | * Returns a list of emoticons | ||
| 59 | * @see https://github.com/justintv/Twitch-API/blob/master/v3_resources/chat.md#get-chatemoticon_images | ||
| 60 | * @param string $queryString | ||
| 61 | * @return \stdClass | ||
| 62 | * @throws TwitchSDKException | ||
| 63 | */ | ||
| 64 | public function getEmoticonImages($queryString) | ||
| 68 | |||
| 69 | /** | ||
| 70 | * Returns a list of chat badges that can be used in the :channel's chat | ||
| 71 | * @see https://github.com/justintv/Twitch-API/blob/master/v3_resources/chat.md#get-chatchannelbadges | ||
| 72 | * @param string $channel | ||
| 73 | * @return \stdClass | ||
| 74 | * @throws TwitchSDKException | ||
| 75 | */ | ||
| 76 | public function getBadges($channel) | ||
| 80 | } | ||
| 81 |