romanzipp / laravel-twitch
Twitch PHP Wrapper for Laravel
Fund package maintenance!
romanzipp
Installs: 87 161
Dependents: 4
Suggesters: 1
Security: 0
Stars: 108
Watchers: 2
Forks: 18
Open Issues: 3
Requires
- php: ^8.0
- ext-json: *
- firebase/php-jwt: ^6.2
- guzzlehttp/guzzle: ^7.0
- illuminate/cache: ^7.0|^8.0|^9.0|^10.0|^11.0
- illuminate/console: ^7.0|^8.0|^9.0|^10.0|^11.0
- illuminate/support: ^7.0|^8.0|^9.0|^10.0|^11.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.0
- mockery/mockery: ^1.3.2
- orchestra/testbench: ^3.8|^4.0|^5.0|^6.0
- phpstan/phpstan: ^0.12.99|^1.0
- phpunit/phpunit: ^8.0|^9.0
- romanzipp/php-cs-fixer-config: ^3.0
- dev-master
- 4.8.0
- 4.7.0
- 4.6.4
- 4.6.3
- 4.6.2
- 4.6.1
- 4.6.0
- 4.5.7
- 4.5.6
- 4.5.5
- 4.5.4
- 4.5.3
- 4.5.2
- 4.5.1
- 4.5.0
- 4.4.1
- 4.4.0
- 4.3.5
- 4.3.4
- 4.3.3
- 4.3.2
- 4.3.1
- 4.3.0
- 4.2.1
- 4.2.0
- 4.1.1
- 4.1.0
- 4.0.11
- 4.0.10
- 4.0.9
- 4.0.8
- 4.0.6
- 4.0.5
- 4.0.4
- 4.0.3
- 4.0.2
- 4.0.1
- 4.0.0
- 3.0.5
- 3.0.4
- 3.0.3
- 3.0.2
- 3.0.1
- 3.0.0
- 2.3.3
- 2.3.2
- 2.3.1
- 2.3.0
- 2.2.4
- 2.2.3
- 2.2.2
- 2.2.1
- 2.2.0
- 2.1.4
- 2.1.3
- 2.1.2
- 2.1.1
- 2.1.0
- 2.0.2
- 2.0.1
- 2.0.0
- 1.0.22
- 1.0.21
- 1.0.20
- 1.0.19
- 1.0.18
- 1.0.17
- 1.0.16
- 1.0.15
- 1.0.14
- 1.0.13
- 1.0.12
- 1.0.11
- 1.0.10
- 1.0.9
- 1.0.8
- 1.0.7
- 1.0.6
- 1.0.5
- 1.0.4
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
This package is auto-updated.
Last update: 2024-10-13 06:55:19 UTC
README
PHP Twitch Helix API Wrapper for Laravel 5+
⚠️ Changes on May 01, 2020
Since May 01, 2020, Twitch requires all requests to contain a valid OAuth Access Token. This can be achieved by requesting an OAuth Token using the Client Credentials Flow.
If you don't handle this by yourself, be sure to enable the built-in Access Token generation feature via the oauth_client_credentials.auto_generate
configuration entry.
You will need define a valid Client ID and Client Secret via your config or the available setters! See the full config for more details.
Table of contents
Installation
composer require romanzipp/laravel-twitch
Configuration
Copy configuration to project:
php artisan vendor:publish --provider="romanzipp\Twitch\Providers\TwitchServiceProvider"
Add environmental variables to your .env
:
TWITCH_HELIX_KEY=
TWITCH_HELIX_SECRET=
TWITCH_HELIX_REDIRECT_URI=http://localhost
If you want to use the EventSub with the Webhook transport, then you are required to define a secret. This secret is a string between 10 and 100 characters.
TWITCH_HELIX_EVENTSUB_SECRET=
Examples
Basic
$twitch = new romanzipp\Twitch\Twitch; $twitch->setClientId('abc123'); // Get User by Username $result = $twitch->getUsers(['login' => 'herrausragend']); // Check, if the query was successful if ( ! $result->success()) { return null; } // Shift result to get single user data $user = $result->shift(); return $user->id;
Setters
$twitch = new romanzipp\Twitch\Twitch; $twitch->setClientId('abc123'); $twitch->setClientSecret('abc456'); $twitch->setToken('abcdef123456'); $twitch = $twitch->withClientId('abc123'); $twitch = $twitch->withClientSecret('abc123'); $twitch = $twitch->withToken('abcdef123456');
OAuth Tokens
$twitch = new romanzipp\Twitch\Twitch; $twitch->setClientId('abc123'); $twitch->setToken('abcdef123456'); $result = $twitch->getUsers(['login' => 'herrausragend']);
OAuth Client Credentials Flow
Since May 01, 2020, every request requires an OAuth token which can be issued using the OAuth Client Credentials Flow.
use romanzipp\Twitch\Enums\GrantType; use romanzipp\Twitch\Twitch; $twitch = new Twitch; $twitch->setClientId('abc123'); $twitch->setClientSecret('def123'); $twitch->setToken('abcdef123456'); $result = $twitch->getOAuthToken(null, GrantType::CLIENT_CREDENTIALS, ['user:read']); if ( ! $result->success()) { return; } $accessToken = $result->data()->access_token;
Pagination
The Twitch API returns a paginator
field with paginated results like /streams
, /follows
or /games
. To jump between pages, the given cursor must be appended to the following query using the direction attributes after
or before
.
In this example, we will fetch a set of streams and use the provided cursor to switch to the next/previous set of data.
❗️ To prevent infinite loops or errors, use the Result::hasMoreResults()
method to check if there are more results available.
$twitch = new romanzipp\Twitch\Twitch; // Page 1 $firstResult = $twitch->getStreams(['language' => 'de']); // Page 2 $secondResult = $twitch->getStreams(['language' => 'de'], $firstResult->next()); // Page 1 (again) $thirdResult = $twitch->getStreams(['language' => 'de'], $secondResult->back());
Facade
use romanzipp\Twitch\Facades\Twitch; Twitch::withClientId('abc123')->withToken('abcdef123456')->getUsers();
Pagination Loop Example
This example fetches all Twitch Games and stores them into a database.
use romanzipp\Twitch\Twitch; $twitch = new Twitch; do { $nextCursor = null; // If this is not the first iteration, get the page cursor to the next set of results if (isset($result)) { $nextCursor = $result->next(); } // Query the API with an optional cursor to the next results page $result = $twitch->getTopGames(['first' => 100], $nextCursor); foreach ($result->data() as $item) { // Process the games result data } // Continue until there are no results left } while ($result->hasMoreResults());
Insert user objects
The new API does not include the user objects in endpoints like followers or bits.
[ { "from_id": "123456", "to_id": "654321", "followed_at": "2018-01-01 12:00:00" } ]
You can just call the insertUsers method to insert all user data identified by from_id
into from_user
use romanzipp\Twitch\Twitch; $twitch = new Twitch; $result = $twitch->getUsersFollows(['to_id' => 654321]); $result->insertUsers($twitch, 'from_id', 'from_user');
New Result data:
[ { "from_id": "123456", "to_id": "654321", "followed_at": "2018-01-01 12:00:00", "from_user": { "id": "123456", "display_name": "HerrAusragend", "login": "herrausragend" } } ]
Defining EventSub Handlers
By default, the EventSub webhook controller will automatically handle all EventSub notification and revocation calls; however, if you have additional webhook events you would like to handle, you may do so by extending the EventSub webhook controller.
To ensure your application can handle EventSub webhooks, be sure to configure the webhook callback url in the transport payload.
Your controller's method names should correspond to Laravel Twitch's controller conventions. Specifically, methods
should be prefixed with handle
, suffixed with Notification
and the "camel case" name of the EventSub Type you wish
to handle. For example, if you wish to handle the channel.follow
type, you should add a
handleChannelFollowNotification
method to the controller:
<?php namespace App\Http\Controllers; use romanzipp\Twitch\Http\Controllers\EventSubController as BaseController; use Symfony\Component\HttpFoundation\Response; class EventSubController extends BaseController { public function handleChannelFollowNotification(array $payload): Response { return $this->successMethod(); // handle the channel follow notification... } protected function handleNotification(array $payload): Response { return $this->successMethod(); // handle all other incoming notifications... } protected function handleRevocation(array $payload): Response { return $this->successMethod(); // handle the subscription revocation... } }
Next, define a route to your EventSub webhook controller within your application's routes/api.php
file.
use App\Http\Controllers\EventSubController; Route::post( 'twitch/eventsub/webhook', [EventSubController::class, 'handleWebhook'] );
Create EventSub Subscription
Important: When creating a subscription, you must specify a secret for purposes of verification, described above in “Configuration”. This secret is automatically attached to the webhook transport if it is not explicitly defined.
use romanzipp\Twitch\Enums\EventSubType; use romanzipp\Twitch\Twitch; $twitch = new Twitch; $twitch->subscribeEventSub([], [ 'type' => EventSubType::STREAM_ONLINE, 'version' => '1', 'condition' => [ 'broadcaster_user_id' => '1337', ], 'transport' => [ 'method' => 'webhook', 'callback' => 'https://example.com/api/twitch/eventsub/webhook', ] ]);
List EventSub Subscription
use romanzipp\Twitch\Twitch; $twitch = new Twitch; $result = $twitch->getEventSubs(['status' => 'notification_failures_exceeded']); foreach ($result->data() as $item) { // process the subscription }
Delete EventSub Subscription
use romanzipp\Twitch\Twitch; $twitch = new Twitch; $twitch->unsubscribeEventSub([ 'id' => '932b34ad-821a-490f-af43-b327187d0f5c' ]);
Twitch Extension Guard
1. Create TwitchUserProvider
Create app/Auth/TwitchUserProvider.php
:
namespace App\Auth; use App\User; use romanzipp\Twitch\Auth\TwitchUserProvider; use Illuminate\Contracts\Auth\Authenticatable; class TwitchUserProvider extends TwitchUserProvider { public function retrieveById($identifier): ?Authenticatable { /** @var User $user */ $user = User::query()->whereKey($identifier)->first(); return $user; } // This method is optional, if you don't want automatic user creation on request. public function createFromTwitchToken($decoded): ?Authenticatable { return User::createFromTwitchToken($decoded); } }
2. Register TwitchUserProvider & TwitchExtensionGuard
Edit app/Providers/AuthServiceProvider.php
:
use App\Auth\TwitchUserProvider; use romanzipp\Twitch\Auth\TwitchExtensionGuard; use romanzipp\Twitch\Auth\TwitchUserProvider; public function boot() { ... $this->app->bind(TwitchUserProvider::class, Auth\TwitchUserProvider::class); TwitchExtensionGuard::register(config('twitch-api.ext_secret')); }
3. Make guard available in Laravel
Edit config/auth.php
:
<?php return [ ... 'guards' => [ ... 'twitch-extension' => [ 'driver' => 'laravel-twitch', 'provider' => 'laravel-twitch', ], ], ... ];
Documentation
Twitch Helix API Documentation: https://dev.twitch.tv/docs/api/reference
Ads
public function startCommercial(array $parameters = [])
Analytics
public function getExtensionAnalytics(array $parameters = []) public function getGameAnalytics(array $parameters = [])
Bits
public function getCheermotes(array $parameters = []) public function getBitsLeaderboard(array $parameters = []) public function getExtensionTransactions(array $parameters = [])
ChannelPoints
public function createCustomRewards(array $parameters = [], array $body = []) public function deleteCustomReward(array $parameters = []) public function getCustomReward(array $parameters = []) public function getCustomRewardRedemption(array $parameters = [], ?Paginator $paginator = NULL) public function updateCustomReward(array $parameters = [], array $body = []) public function updateRedemptionStatus(array $parameters = [], array $body = [])
Channels
public function getChannels(array $parameters = []) public function updateChannels(array $parameters = [], array $body = []) public function getChannelEditors(array $parameters = []) public function getChannelFollowers(array $parameters = [], ?Paginator $paginator = NULL) public function getChannelsFollowed(array $parameters = [], ?Paginator $paginator = NULL)
Charity
public function getCharityCampaign(array $parameters = [])
Chat
public function getChannelChatEmotes(array $parameters = []) public function getGlobalChatEmotes() public function getChatEmoteSets(array $parameters = []) public function getChannelChatBadges(array $parameters = []) public function getGlobalChatBadges() public function getChatSettings(array $parameters = []) public function updateChatSettings(array $parameters, array $body = []) public function sendChatAnnouncement(array $parameters = [], array $body = []) public function getUserChatColor(array $parameters = []) public function updateUserChatColor(array $parameters = []) public function getChatters(array $parameters = [], ?Paginator $paginator = NULL) public function sendShoutout(array $parameters = [])
Clips
public function createClip(array $parameters = []) public function getClips(array $parameters = [], ?Paginator $paginator = NULL)
Entitlements
public function createEntitlementUrl(array $parameters = []) // DEPRECATED public function getEntitlementsCodeStatus(array $parameters = []) public function getDropsEntitlements(array $parameters = []) public function redeemEntitlementsCode(array $parameters = []) public function updateDropsEntitlements(array $parameters = [], array $body = [])
EventSub
public function subscribeEventSub(array $parameters = [], array $body = []) public function unsubscribeEventSub(array $parameters = []) public function getEventSubs(array $parameters = [], ?Paginator $paginator = NULL)
Extensions
public function getAuthedUserExtensions() public function getAuthedUserActiveExtensions() public function disableAllExtensions() public function disableUserExtensionById(?string $parameter = NULL) public function disableUserExtensionByName(?string $parameter = NULL) public function updateUserExtensions(?string $method = NULL, ?string $parameter = NULL, bool $disabled = false) public function getExtensionConfigurationSegment(array $parameters = []) public function setExtensionConfigurationSegment(array $body = []) public function setExtensionRequiredConfiguration(array $parameters = [], array $body = []) public function sendExtensionPubSubMessage(array $body = []) public function getExtensionLiveChannels(array $parameters = [], ?Paginator $paginator = NULL) public function getExtensionSecrets(array $parameters = []) public function createExtensionSecret(array $parameters = []) public function sendExtensionChatMessage(array $parameters = [], array $body = []) public function getExtensions(array $parameters = []) public function getReleasedExtensions(array $parameters = []) public function getExtensionBitsProducts(array $parameters = []) public function updateExtensionBitsProduct(array $parameters = [], array $body = [])
Games
public function getTopGames(array $parameters = [], ?Paginator $paginator = NULL) public function getGames(array $parameters = [])
Goals
public function getCreatorGoals(array $parameters = [])
HypeTrain
public function getHypeTrainEvents(array $parameters = [])
Moderation
public function checkAutoModStatus(array $parameters = [], array $body = []) public function getBannedUsers(array $parameters = [], ?Paginator $paginator = NULL) public function getBannedEvents(array $parameters = [], ?Paginator $paginator = NULL) // DEPRECATED public function getModerators(array $parameters = [], ?Paginator $paginator = NULL) public function getModeratorEvents(array $parameters = [], ?Paginator $paginator = NULL) // DEPRECATED public function manageHeldAutoModMessages(array $parameters = [], array $body = []) public function getAutoModSettings(array $parameters = []) public function updateAutoModSettings(array $parameters = [], array $body = []) public function banUser(array $parameters = [], array $body = []) public function unbanUser(array $parameters = []) public function getBlockedTerms(array $parameters = [], ?Paginator $paginator = NULL) public function addBlockedTerm(array $parameters = [], array $body = []) public function removeBlockedTerm(array $parameters = []) public function deleteChatMessages(array $parameters = []) public function addChannelModerator(array $parameters = []) public function removeChannelModerator(array $parameters = []) public function getVIPs(array $parameters = [], ?Paginator $paginator = NULL) public function addChannelVIP(array $parameters = []) public function removeChannelVIP(array $parameters = []) public function getShieldModeStatus(array $parameters = []) public function updateShieldModeStatus(array $parameters = [], array $body = [])
Music
public function getSoundtrackCurrentTrack(array $parameters = []) public function getSoundtrackPlaylist(array $parameters = [], ?Paginator $paginator = NULL) public function getSoundtrackPlaylists(array $parameters = [])
OAuth
public function getOAuthAuthorizeUrl(string $responseType = 'code', array $scopes = [], ?string $state = NULL, bool $forceVerify = false) public function getOAuthToken(?string $code = NULL, string $grantType = 'authorization_code', array $scopes = []) public function validateOAuthToken()
Polls
public function getPolls(array $parameters = [], ?Paginator $paginator = NULL) public function createPoll(array $parameters = [], array $body = []) public function endPoll(array $parameters = [], array $body = [])
Predictions
public function getPredictions(array $parameters = [], ?Paginator $paginator = NULL) public function createPrediction(array $parameters = [], array $body = []) public function endPrediction(array $parameters = [], array $body = [])
Raids
public function startRaid(array $parameters = []) public function cancelRaid(array $parameters = [])
Schedule
public function getChannelStreamSchedule(array $parameters = [], ?Paginator $paginator = NULL) public function getChanneliCalendar(array $parameters = []) public function updateChannelStreamSchedule(array $parameters = []) public function createChannelStreamScheduleSegment(array $parameters = [], array $body = []) public function updateChannelStreamScheduleSegment(array $parameters = [], array $body = []) public function deleteChannelStreamScheduleSegment(array $parameters = [], array $body = [])
Search
public function searchCategories(array $parameters = []) public function searchChannels(array $parameters = [])
Streams
public function getStreamKey(array $parameters = []) public function getStreams(array $parameters = [], ?Paginator $paginator = NULL) public function getFollowedStreams(array $parameters = [], ?Paginator $paginator = NULL) public function createStreamMarker(array $parameters = [], array $body = []) public function getStreamMarkers(array $parameters = [], ?Paginator $paginator = NULL)
Subscriptions
public function getSubscriptions(array $parameters = [], ?Paginator $paginator = NULL) public function getUserSubscription(array $parameters = [])
Tags
public function getStreamTags(array $parameters = []) public function getAllStreamTags(array $parameters = [], ?Paginator $paginator = NULL) public function replaceStreamTags(array $parameters = [], array $body = [])
Teams
public function getChannelTeams(array $parameters = []) public function getTeams(array $parameters = [])
Users
public function createUserFollows(array $parameters = [], array $body = []) public function deleteUserFollows(array $parameters = []) public function getUsers(array $parameters = []) public function getUsersFollows(array $parameters = [], ?Paginator $paginator = NULL) // DEPRECATED public function updateUser(array $parameters = []) public function getUserExtensions(array $parameters = []) public function getUserActiveExtensions(array $parameters = []) public function updateUserExtension(array $parameters = [], array $body = []) public function getUserBlockList(array $parameters = [], ?Paginator $paginator = NULL) public function blockUser(array $parameters = []) public function unblockUser(array $parameters = [])
Videos
public function getVideos(array $parameters = [], ?Paginator $paginator = NULL) public function deleteVideos(array $parameters = [])
Webhooks
public function getWebhookSubscriptions(array $parameters = []) // DEPRECATED public function subscribeWebhook(array $parameters = [], array $body = []) // DEPRECATED public function unsubscribeWebhook(array $parameters = [], array $body = []) // DEPRECATED public function buildWebhookTopic(string $path, array $parameters = []) // DEPRECATED
Whispers
public function sendWhisper(array $parameters = [], array $body = [])
Upgrading
Development
Run Tests
composer test
CLIENT_ID=xxxx composer test
CLIENT_ID=xxxx CLIENT_SECRET=xxxx composer test
Generate Documentation
composer docs
Join the Twitch Dev Discord!