obnoxiousfrog/twitch-api

Twitch Api

This is a PHP library to simplify working with the Twitch API., _(*1)

PLEASE READ, _(*2)

It has come to my attention that this package may no longer be compatible with the recent Twitch API changes. Unfortunately, I do not have the time required to look into it at the moment. Hopefully, I will some day in the not too distant future, and maybe I'll even go ahead and re-write it completely. I will not offer support on any major feature requests or issues until then., _(*3)

Please keep this in mind if you decide to use and/or rely on this package., _(*4)

Thank you., _(*5)

Installation

Install by running the following Composer command:, _(*6)

composer require obnoxiousfrog/twitch-api

Example

Below is an example for authenticating the user, checking if the user is following and subscribed to the user obnoxiousfrog, and if they are, they are greeted with a message. If not, an exception is thrown for logging, and/or redirecting the user to another page with an error message., _(*7)

<?php require_once 'vendor/autoload.php';

try {

    $auth = new TwitchApi\Authenticator(new TwitchApi\Application(
        '3nyv5fcqdpg8uakewz6mj27r49xhbs',
        'aqdrje795sh4nm2fk8btpwuvy3cg6z',
        ['user_read', 'user_subscriptions'],
        'https://www.domain.tld/authenticate'
    ));

    if ( ! $auth->authenticate() or ! ($user = $auth->user()))
    {
        throw new Exception('Oops, something went wrong!');
    }

    if ( ! $user->isFollowing('obnoxiousfrog'))
    {
        throw new Exception('You are not a follower of ObnoxiousFrog!');
    }

    if ( ! $user->isSubscribed('obnoxiousfrog'))
    {
        throw new Exception('You are not a subscriber of ObnoxiousFrog!');
    }

    echo 'Welcome, '.$user->displayname().'!';

} catch (Exception $e) {
    // Log error
}

Documentation

TwitchApi\Application

This class implements the \TwitchApi\Contracts\Application contract., _(*8)

The entire API revolves around the Application object., _(*9)

$twitch = new TwitchApi\Application('client', 'secret', ['scopes'], 'redirect');

client is your Twitch application client id., _(*10)

secret is your Twitch application client secret (_do not share this with anyone_)., _(*11)

scopes is an array of Twitch scopes., _(*12)

redirect is the Twitch application redirect url., _(*13)

Below is an example of how this might look in a production environment., _(*14)

$twitch = new TwitchApi\Application(
    '3nyv5fcqdpg8uakewz6mj27r49xhbs',
    'aqdrje795sh4nm2fk8btpwuvy3cg6z',
    ['user_read', 'user_subscriptions'],
    'https://www.domain.tld/authenticate',
);

Class Methods

TwitchApi\Authenticator

This class implements the \TwitchApi\Contracts\Authenticator contract., _(*15)

$auth = new TwitchApi\Authenticator($twitch);

Class Methods

TwitchApi\User

This class implements the \TwitchApi\Contracts\User contract., _(*16)

Class Methods

TwitchApi\Channel

This class implements the \TwitchApi\Contracts\Channel contract., _(*17)

Class Methods

TwitchApi\Request

This class implements the \TwitchApi\Contracts\Request contract., _(*18)

Class Methods

TwitchApi\Response

This class implements the \TwitchApi\Contracts\Response contract., _(*19)

Class Methods

Using your own classes

Make sure your own classes implement the appropriate contract (_you may find all the contracts below the title of each class documentation above_), and then you may simply run the bind method from the \TwitchApi\Application object., _(*20)

For example, the following would replace the TwitchApi User class with your own:, _(*21)

$twitch->bind('TwitchApi\Contracts\User', 'CustomUserClass');