Merge pull request #6 from cp6/Extras

v1.1

Author: cp6

.gitignore

@@ -0,0 +1 @@
+/vendor/

README.md

@@ -33,31 +33,52 @@ This class will automatically refresh access token once it expires!
 * Get users clips
 * Get game name for game id
 * Get game artwork for game id
+* PHP 8
 
 ## Usage
 
-Add your Twitch client id, client secret and authorization code into the constants (lines 5-7)
+**Fetch with composer:**
 
-Add your redirect URI [info](https://write.corbpie.com/twitch-api-authentication-with-oauth-using-php/) (line 8)
+```shell
+composer require corbpie/twitch-api-class
+```
 
-Change the token filename constant, however keep it as a .txt extension (line 9)
+To use:
 
-Make sure the class file is included
 ```php
-require_once('twitch-class.php');
+require_once('vendor/autoload.php');
+
+use Corbpie\TwitchApiClass\twitchWrapper;
+
+$call = new twitchWrapper();
 ```
 
-Then assign a new instance
+Add your Twitch client id and client secret into the constants (lines 7-8)
+
+Add your redirect URI [info](https://write.corbpie.com/twitch-api-authentication-with-oauth-using-php/) (line 10)
+
+Change the token filename constant, however keep it as a .txt extension (line 11)
+
+Access code can be obtained with
+
 ```php
-$call = new twitch_call();
+echo $call->accessCodeUrl();
 ```
 
+Upon going to the link You will find the access code in the URL:
+
+```http://localhost/?code=THEISACCESSCODE```
+
+### Calls
+
 Get current top (view count) streams `array`
+
 ```php
 $call->getTopStreams();
 ```
 
 <b>Protect your calls against an expired access token:</b>
+
 ```php
 $data = $call->getUserLiveData('summit1g');
 if (!$call->checkCallSuccess($data)) {//Call failed but refreshed token, try it again:
@@ -67,17 +88,20 @@ echo $data;
 ```
 
 Get current top (view count) streams for a game `array`
+
 ```php
 $call->getGameTopStreams($gameid);
 ```
 
 Get top (view count) streamer for a game `string`
+
 ```php
 $call->getGameTopStreams($gameid);
 echo $call->getTopStreamerForGame();
 ```
 
 Get viewer count for the top stream for a game `string`
+
 ```php
 $call->getGameTopStreams($gameid);
 echo $call->getTopViewersForGame();
@@ -86,141 +110,153 @@ echo $call->getTopViewersForGame();
 Get top games `array`
 
 (Good way to get gameid's)
+
 ```php
 $call->getTopGames();
 ```
 
 Get details for username `array`
+
 ```php
 $call->getUserDetails($username);
 ```
 
 Get user id for username `string`
+
 ```php
 $call->getUserDetails($username);
 $user_id = $call->idForUser();
 ```
 
 Get emotes for username `array`
+
 ```php
 $call->getUserEmotes($username);
 ```
 
 Get image for emote id `string`
+
 ```php
 $call->emoteImage($emoteid);
 ```
 
-
 Get chat for VOD `array`
+
 ```php
 $call->chatForVod($vod_id, $offset);
 ```
 
-
 Get users stream details (If live) `array`
+
 ```php
 $call->getUserStream($username);
 ```
 
 Check if a user is live and streaming `boolean`
+
 ```php
 $call->getUserStream($username);
 $call->userIsLive();//true for live | false for not live
 ```
+
 __If user is streaming:__
 
 Get game id `string`
+
 ```php
 $call->streamGameId();
 ```
 
 Get viewer count `string`
+
 ```php
 $call->streamViewers();
 ```
 
 Get stream title `string`
+
 ```php
 $call->streamTitle();
 ```
 
 Get stream id `string`
+
 ```php
 $call->streamId();
 ```
 
 Get stream start time `string`
+
 ```php
 $call->streamStart();
 ```
 
 Get stream thumbnail `string`
+
 ```php
 $call->streamThumbnail();
 ```
 
 Get stream thumbnail `array`
+
 ```php
 $call->getStreamTags($streamid);
 ```
 
 Get top clips for game id `array`
+
 ```php
 $call->getGameClips($gameid);
 ```
 
 Get users top clips `array`
+
 ```php
 $call->getUserClips($user);
 ```
 
 Get users videos (most recent first) `array`
+
 ```php
 $call->getUserVideos($user);
 ```
 
 Get users videos for game id `array`
+
 ```php
 $call->getUserVideosForGame($user, $game_id);
 ```
 
 Get game data for game id `array`
+
 ```php
 $call->getGameData($game_id);
 ```
 
 Get game name `string`
+
 ```php
 $call->getGameData($game_id);
 $game_name = $call->gameName();
 ```
 
 Get game artwork `string`
+
 ```php
 $call->getGameData($game_id);
 $game_name = $call->gameArtwork();
 ```
 
 Get game artwork `string`
+
 ```php
 $call->getGameData($game_id);
 $game_name = $call->gameArtwork();
 ```
 
-Set JSON header
-```php
-$call->setJsonHeader();
-```
-
 Custom array access `string`
+
 ```php
 //array return call here Eg:$call->getUserDetails('shroud');
 $custom = $call->getCustom(0, 'type');
-```
-
-
-## TODO
-
-* Access to all values, not just popular ones.
-* Greater options to calls, add filter types (Newest, view count, length).
+```

composer.json

@@ -0,0 +1,22 @@
+{
+  "name": "corbpie/twitch-api-class",
+  "description": "A PHP Twitch API wrapper",
+  "type": "library",
+  "license": "MIT",
+  "autoload": {
+    "psr-4": {
+      "Corbpie\\TwitchApiClass\\": "src/"
+    }
+  },
+  "authors": [
+    {
+      "name": "corbpie",
+      "email": "[email protected]"
+    }
+  ],
+  "minimum-stability": "dev",
+  "require": {
+    "php": ">=8.0",
+    "ext-curl": "*"
+  }
+}

composer.lock

@@ -1,9 +1,10 @@
 <?php
-require_once('twitch-class.php');
-
-$call = new twitch_call();
-$call->setApiKey('TWITCHCLIENTID');//Set client id
-$call->getUserStream('shroud');//Set streamers username
-if ($call->userIsLive()) {//Will return true is user is live/streaming
-    echo "Shroud is streaming right now";
-}
+require_once('vendor/autoload.php');
+
+use Corbpie\TwitchApiClass\twitchWrapper;
+
+$call = new twitchWrapper();
+
+echo $call->accessCodeUrl();
+
+echo json_encode($call->getUserDetails('shroud'));