Server : Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.4.20 System : Linux st2.domain.com 3.10.0-1127.10.1.el7.x86_64 #1 SMP Wed Jun 3 14:28:03 UTC 2020 x86_64 User : apache ( 48) PHP Version : 7.4.20 Disable Function : NONE Directory : /var/www/html/123vid/vendor/nicklaw5/twitch-api-php/src/Api/ |
<?php
namespace TwitchApi\Api;
use TwitchApi\Exceptions\EndpointNotSupportedByApiVersionException;
use TwitchApi\Exceptions\InvalidDirectionException;
use TwitchApi\Exceptions\InvalidIdentifierException;
use TwitchApi\Exceptions\InvalidLimitException;
use TwitchApi\Exceptions\InvalidOffsetException;
use TwitchApi\Exceptions\InvalidTypeException;
use TwitchApi\Exceptions\TwitchApiException;
use TwitchApi\Exceptions\UnsupportedOptionException;
trait Channels
{
/**
* Get a user's own channel
*
* @param string $accessToken
* @return array|json
*/
public function getAuthenticatedChannel($accessToken)
{
return $this->get('channel', [], $accessToken);
}
/**
* Get a channel
*
* @param string|int $channelIdentifier
* @throws InvalidIdentifierException
* @return array|json
*/
public function getChannel($channelIdentifier)
{
if ($this->apiVersionIsGreaterThanV4() && !is_numeric($channelIdentifier)) {
throw new InvalidIdentifierException('channel');
}
return $this->get(sprintf('channels/%s', $channelIdentifier));
}
/**
* Update a user's channel
*
* @param string|int $channelIdentifier
* @param string $accessToken
* @param string $status
* @param string $game
* @param int $delay
* @param bool $channelFeedEnabled
* @throws InvalidIdentifierException
* @throws InvalidTypeException
* @throws TwitchApiException
* @return array|json
*/
public function updateChannel($channelIdentifier, $accessToken, $status = null, $game = null, $delay = null, $channelFeedEnabled = null)
{
$params = [];
$params['channel'] = [];
if ($this->apiVersionIsGreaterThanV4() && !is_numeric($channelIdentifier)) {
throw new InvalidIdentifierException('channel');
}
if ($status) {
if (!is_string($status)) {
throw new InvalidTypeException('Status', 'string', gettype($status));
}
$params['channel']['status'] = $status;
}
if ($game) {
if (!is_string($game)) {
throw new InvalidTypeException('Game', 'string', gettype($game));
}
$params['channel']['game'] = $game;
}
if ($delay) {
if (!is_numeric($delay)) {
throw new InvalidTypeException('Delay', 'integer', gettype($delay));
}
$params['channel']['delay'] = intval($delay);
}
if ($channelFeedEnabled !== null) {
if (!is_bool($channelFeedEnabled)) {
throw new InvalidTypeException('ChannelFeedEnabled', 'boolean', gettype($channelFeedEnabled));
}
$params['channel']['channel_feed_enabled'] = $channelFeedEnabled;
}
if (empty($params['channels'])) {
throw new TwitchApiException('At least one of the following parameters must be set: status, game, delay or channelFeedEnabled.');
}
return $this->put(sprintf('channels/%s', $channelIdentifier), $params, $accessToken);
}
/**
* Get channel editors
*
* @param string|int $channelIdentifier
* @param string $accessToken
* @throws InvalidIdentifierException
* @return array|json
*/
public function getChannelEditors($channelIdentifier, $accessToken)
{
if ($this->apiVersionIsGreaterThanV4() && !is_numeric($channelIdentifier)) {
throw new InvalidIdentifierException('channel');
}
return $this->get(sprintf('channels/%s/editors', $channelIdentifier), [], $accessToken);
}
/**
* Get channel followers
*
* @param string|int $channelIdentifier
* @param int $limit
* @param int $offset
* @param string $cursor
* @param string $direction
* @throws InvalidIdentifierException
* @throws InvalidLimitException
* @throws InvalidOffsetException
* @throws InvalidTypeException
* @throws InvalidDirectionException
* @return array|json
*/
public function getChannelFollowers($channelIdentifier, $limit = 25, $offset = 0, $cursor = null, $direction = 'desc')
{
if ($this->apiVersionIsGreaterThanV4() && !is_numeric($channelIdentifier)) {
throw new InvalidIdentifierException('channel');
}
if (!$this->isValidLimit($limit)) {
throw new InvalidLimitException();
}
if (!$this->isValidOffset($offset)) {
throw new InvalidOffsetException();
}
if ($cursor && !is_string($cursor)) {
throw new InvalidTypeException('Cursor', 'string', gettype($cursor));
}
if (!$this->isValidDirection($direction)) {
throw new InvalidDirectionException();
}
$params = [
'limit' => intval($limit),
'offset' => intval($offset),
'cursor' => $cursor,
'direction' => $direction,
];
return $this->get(sprintf('channels/%s/follows', $channelIdentifier), $params);
}
/**
* Get channel teams
*
* @param string|int $channelIdentifier
* @throws InvalidIdentifierException
* @return array|json
*/
public function getChannelTeams($channelIdentifier)
{
if ($this->apiVersionIsGreaterThanV4() && !is_numeric($channelIdentifier)) {
throw new InvalidIdentifierException('channel');
}
return $this->get(sprintf('channels/%s/teams', $channelIdentifier));
}
/**
* Get channel subscribers
*
* @param string|int $channelIdentifier
* @param string $accessToken
* @param int $limit
* @param int $offset
* @param string $direction
* @throws InvalidIdentifierException
* @throws InvalidLimitException
* @throws InvalidOffsetException
* @throws InvalidDirectionException
* @return array|json
*/
public function getChannelSubscribers($channelIdentifier, $accessToken, $limit = 25, $offset = 0, $direction = 'desc')
{
if ($this->apiVersionIsGreaterThanV4() && !is_numeric($channelIdentifier)) {
throw new InvalidIdentifierException('channel');
}
if (!$this->isValidLimit($limit)) {
throw new InvalidLimitException();
}
if (!$this->isValidOffset($offset)) {
throw new InvalidOffsetException();
}
if (!$this->isValidDirection($direction)) {
throw new InvalidDirectionException();
}
$params = [
'limit' => intval($limit),
'offset' => intval($offset),
'direction' => $direction,
];
return $this->get(sprintf('channels/%s/subscriptions', $channelIdentifier), $params, $accessToken);
}
/**
* Check a user's subscription to a channel
*
* @param string|int $channelIdentifier
* @param string|int $userIdentifier
* @param string $accessToken
* @throws InvalidIdentifierException
* @return array|json
*/
public function checkChannelSubscriptionByUser($channelIdentifier, $userIdentifier, $accessToken)
{
if ($this->apiVersionIsGreaterThanV4()) {
if (!is_numeric($channelIdentifier)) {
throw new InvalidIdentifierException('channel');
}
if (!is_numeric($userIdentifier)) {
throw new InvalidIdentifierException('user');
}
}
return $this->get(sprintf('channels/%s/subscriptions/%s', $channelIdentifier, $userIdentifier), [], $accessToken);
}
/**
* Get channel videos
*
* @param string|int $channelIdentifier
* @param int $limit
* @param int $offset
* @param string $broadcastType (comma-seperated list)
* @param string $language (comma-seperated list)
* @param string $sort
* @throws InvalidIdentifierException
* @throws InvalidLimitException
* @throws InvalidOffsetException
* @throws UnsupportedOptionException
* @throws InvalidTypeException
* @return array|json
*/
public function getChannelVideos($channelIdentifier, $limit = 10, $offset = 0, $broadcastType = 'highlight', $language = null, $sort = 'time')
{
$validSort = ['views', 'time'];
if ($this->apiVersionIsGreaterThanV4() && !is_numeric($channelIdentifier)) {
throw new InvalidIdentifierException('channel');
}
if (!$this->isValidLimit($limit)) {
throw new InvalidLimitException();
}
if (!$this->isValidOffset($offset)) {
throw new InvalidOffsetException();
}
$broadcastType = trim($broadcastType, ', ');
if (!$this->isValidBroadcastType($broadcastType)) {
throw new UnsupportedOptionException('broadcastType', $validBroadcastTypes);
}
if ($language && !is_string($language)) {
throw new InvalidTypeException('language', 'string', gettype($language));
}
if (!in_array($sort = strtolower($sort), $validSort)) {
throw new UnsupportedOptionException('sort', $validSort);
}
$params = [
'limit' => intval($limit),
'offset' => intval($offset),
'broadcast_type' => $broadcastType,
'language' => $language,
'sort' => $sort,
];
return $this->get(sprintf('channels/%s/videos', $channelIdentifier), $params);
}
/**
* Run a channel commercial
*
* @param string|int $channelIdentifier
* @param string $accessToken
* @param int $length
* @throws InvalidIdentifierException
* @throws UnsupportedOptionException
* @return array|json
*/
public function startChannelCommercial($channelIdentifier, $accessToken, $length = 30)
{
$validLengths = [30, 60, 90, 120, 150, 180];
if ($this->apiVersionIsGreaterThanV4() && !is_numeric($channelIdentifier)) {
throw new InvalidIdentifierException('channel');
}
if (!in_array($length = intval($length), $validLengths)) {
throw new UnsupportedOptionException('length', $validLengths);
}
return $this->post(sprintf('channels/%s/commercial', $channelIdentifier), ['length' => $length], $accessToken);
}
/**
* Reset a channel's stream key
*
* @param string|int $channelIdentifier
* @param string $accessToken
* @throws InvalidIdentifierException
* @return array|json
*/
public function resetChannelStreamKey($channelIdentifier, $accessToken)
{
if ($this->apiVersionIsGreaterThanV4() && !is_numeric($channelIdentifier)) {
throw new InvalidIdentifierException('channel');
}
return $this->delete(sprintf('channels/%s/stream_key', $channelIdentifier), [], $accessToken);
}
/**
* Get the community for a channel
*
* @param string|int $channelIdentifier
* @throws InvalidIdentifierException
* @throws EndpointNotSupportedByApiVersionException
* @return null|array|json
*/
public function getChannelCommunity($channelIdentifier)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if (!is_numeric($channelIdentifier)) {
throw new InvalidIdentifierException('channel');
}
return $this->get(sprintf('channels/%s/community', $channelIdentifier));
}
/**
* Set the community for a channel
*
* @param string|int $channelIdentifier
* @param string $communityId
* @param string $accessToken
* @throws InvalidIdentifierException
* @throws EndpointNotSupportedByApiVersionException
* @return null
*/
public function setChannelCommunity($channelIdentifier, $communityId, $accessToken)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if (!is_numeric($channelIdentifier)) {
throw new InvalidIdentifierException('channel');
}
return $this->put(sprintf('channels/%s/community/%s', $channelIdentifier, $communityId), [], $accessToken);
}
/**
* Remove a channel form a community
*
* @param string|int $channelIdentifier
* @param string $accessToken
* @throws InvalidIdentifierException
* @throws EndpointNotSupportedByApiVersionException
* @return null
*/
public function deleteChannelFromCommunity($channelIdentifier, $accessToken)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if (!is_numeric($channelIdentifier)) {
throw new InvalidIdentifierException('channel');
}
return $this->delete(sprintf('channels/%s/community', $channelIdentifier), [], $accessToken);
}
}