jofner\SDK\TwitchTV\Methods\Channel

Complexity

Total Complexity

7

Size/Duplication

Total Lines	96
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setChannel()	0	4	1
A	getChannel()	0	4	1
A	resetStreamKey()	0	4	1
A	getChannels()	0	4	1
A	getEditors()	0	4	1
A	getTeams()	0	4	1

<?php

namespace jofner\SDK\TwitchTV\Methods;

use jofner\SDK\TwitchTV\TwitchSDKException;
use jofner\SDK\TwitchTV\TwitchRequest;

/**
 * Channels method class for TwitchTV API SDK for PHP
 *
 * @author Josef Ohnheiser <jofnercz@gmail.com>
 * @license https://github.com/jofner/Twitch-SDK/blob/master/LICENSE.md MIT
 * @homepage https://github.com/jofner/Twitch-SDK
 */
class Channel
{
    /** @var TwitchRequest */
    protected $request;

    const URI_CHANNEL_AUTH = 'channel';
    const URI_CHANNELS = 'channels/';
    const URI_CHANNEL_KEY = 'channels/%s/stream_key';
    const URI_CHANNEL_EDITORS_AUTH = 'channels/%s/editors';
    const URI_CHANNEL_TEAMS = 'channels/%s/teams';

    public function __construct(TwitchRequest $request)
    {
        $this->request = $request;
    }

    /**
     * Update channel's status or game
     *  - requires scope 'channel_editor'
     * @see https://github.com/justintv/Twitch-API/blob/master/v3_resources/channels.md#put-channelschannel
     * @param string $channel
     * @param string $queryString
     * @param string $data
     * @return \stdClass
     * @throws TwitchSDKException
     */
    public function setChannel($channel, $queryString, $data)
    {
        return $this->request->request(self::URI_CHANNELS . $channel . $queryString, 'PUT', $data);
    }

    /**
     * Get the authenticated channel
     *  - requires scope 'channel_read'
     * @see https://github.com/justintv/Twitch-API/blob/master/v3_resources/channels.md#get-channel
     * @param string $queryString
     * @return \stdClass
     * @throws TwitchSDKException
     */
    public function getChannel($queryString)
    {
        return $this->request->request(self::URI_CHANNEL_AUTH . $queryString);
    }

    /**
     * Resets channel's stream key
     *  - requires scope 'channel_stream'
     * @see https://github.com/justintv/Twitch-API/blob/master/v3_resources/channels.md#delete-channelschannelstream_key
     * @param string $channel
     * @param string $queryString
     * @return \stdClass
     * @throws TwitchSDKException
     */
    public function resetStreamKey($channel, $queryString)
    {
        return $this->request->request(sprintf(self::URI_CHANNEL_KEY, $channel) . $queryString, 'DELETE');
    }

    /**
     * Get the specified channel
     * @see https://github.com/justintv/Twitch-API/blob/master/v3_resources/channels.md#get-channelschannel
     * @param string $channel
     * @return \stdClass
     * @throws TwitchSDKException
     */
    public function getChannels($channel)
    {
        return $this->request->request(self::URI_CHANNELS . $channel);
    }

    /**
     * Returns an array of users who are editors of specified channel
     *  - requires scope 'channel_read'
     * @see https://github.com/justintv/Twitch-API/blob/master/v3_resources/channels.md#get-channelschanneleditors
     * @param string $channel
     * @param string $queryString
     * @return \stdClass
     * @throws TwitchSDKException
     */
    public function getEditors($channel, $queryString)
    {
        return $this->request->request(sprintf(self::URI_CHANNEL_EDITORS_AUTH, $channel) . $queryString);
    }

    /**
     * Return team list for specified channel
     * @see https://github.com/justintv/Twitch-API/blob/master/v3_resources/channels.md#get-channelschannelteams
     * @param string $channel
     * @return \stdClass
     * @throws TwitchSDKException
     */
    public function getTeams($channel)
    {
        return $this->request->request(sprintf(self::URI_CHANNEL_TEAMS, $channel));
    }
}