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\InvalidEmailAddressException;
use TwitchApi\Exceptions\InvalidIdentifierException;
use TwitchApi\Exceptions\InvalidParameterLengthException;
use TwitchApi\Exceptions\InvalidTypeException;
trait Communities
{
/**
* Get community by name
*
* @param string $name
* @throws InvalidTypeException
* @throws EndpointNotSupportedByApiVersionException
* @return array|json
*/
public function getCommunityByName($name)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if (!is_string($name)) {
throw new InvalidTypeException('Name', 'string', gettype($name));
}
return $this->get('communities', ['name' => $name]);
}
/**
* Get community by ID
*
* @param string $communityId
* @throws InvalidTypeException
* @throws EndpointNotSupportedByApiVersionException
* @return array|json
*/
public function getCommunityById($communityId)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if (!is_string($communityId)) {
throw new InvalidTypeException('Community ID', 'string', gettype($communityId));
}
return $this->get(sprintf('communities/%s', $communityId));
}
/**
* Create a community
*
* @param string $name
* @param string $summary
* @param string $description
* @param string $rules
* @param string $accessToken
* @throws InvalidParameterLengthException
* @throws EndpointNotSupportedByApiVersionException
* @return array|json
*/
public function createCommunity($name, $summary, $description, $rules, $accessToken)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if (strlen($name) < 3 || strlen($name) > 25) {
throw new InvalidParameterLengthException('name');
}
if (strlen($summary) > 160) {
throw new InvalidParameterLengthException('summary');
}
if (strlen($description) > 1572864) { // 1.5MB
throw new InvalidParameterLengthException('description');
}
if (strlen($rules) > 1572864) { // 1.5MB
throw new InvalidParameterLengthException('rules');
}
$params = [
'name' => $name,
'summary' => $summary,
'description' => $description,
'rules' => $rules,
];
return $this->post('communities', $params, $accessToken);
}
/**
* Update a community
*
* @param string $communityId
* @param string $accessToken
* @param string $summary
* @param string $description
* @param string $rules
* @param string $email
* @throws InvalidParameterLengthException
* @throws EndpointNotSupportedByApiVersionException
* @throws InvalidEmailAddressException
* @return array|json
*/
public function updateCommunity($communityId, $accessToken, $summary = null, $description = null, $rules = null, $email = null)
{
$params = [];
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if ($summary) {
if (strlen($summary) > 160) {
throw new InvalidParameterLengthException('summary');
}
$params['summary'] = $summary;
}
if ($description) {
if (strlen($description) > 1572864) { // 1.5MB
throw new InvalidParameterLengthException('description');
}
$params['description'] = $description;
}
if ($rules) {
if (strlen($rules) > 1572864) { // 1.5MB
throw new InvalidParameterLengthException('rules');
}
$params['rules'] = $rules;
}
if ($email) {
if (filter_var($email, FILTER_VALIDATE_EMAIL) === false) {
throw new InvalidEmailAddressException();
}
$params['email'] = $email;
}
return $this->put(sprintf('communities/%s', $communityId), $params, $accessToken);
}
/**
* Get top communities
*
* @param int $limit
* @param string $cursor
* @throws InvalidLimitException
* @throws InvalidTypeException
* @throws EndpointNotSupportedByApiVersionException
* @return array|json
*/
public function getTopCommunities($limit = 10, $cursor = null)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if (!$this->isValidLimit($limit)) {
throw new InvalidLimitException();
}
if ($cursor && !is_string($cursor)) {
throw new InvalidTypeException('Cursor', 'string', gettype($cursor));
}
$params = [
'limit' => intval($limit),
'cursor' => $cursor,
];
return $this->get('communities/top', $params);
}
/**
* Get banned community users
*
* @param string $communityId
* @param string $accessToken
* @param int $limit
* @param string $cursor
* @throws InvalidLimitException
* @throws InvalidTypeException
* @throws EndpointNotSupportedByApiVersionException
* @return array|json
*/
public function getBannedCommunityUsers($communityId, $accessToken, $limit = 10, $cursor = null)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if (!$this->isValidLimit($limit)) {
throw new InvalidLimitException();
}
if ($cursor && !is_string($cursor)) {
throw new InvalidTypeException('Cursor', 'string', gettype($cursor));
}
$params = [
'limit' => intval($limit),
'cursor' => $cursor,
];
return $this->get(sprintf('communities/%s/bans', $communityId), $params, $accessToken);
}
/**
* Ban a community user
*
* @param string $communityId
* @param string $userId
* @param string $accessToken
* @throws EndpointNotSupportedByApiVersionException
* @throws InvalidIdentifierException
* @return array|json
*/
public function banCommunityUser($communityId, $userId, $accessToken)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if (!is_numeric($userId)) {
throw new InvalidIdentifierException('user');
}
return $this->put(sprintf('communities/%s/bans/%s', $communityId, $userId), [], $accessToken);
}
/**
* Un-ban a community user
*
* @param string $communityId
* @param string $userId
* @param string $accessToken
* @throws EndpointNotSupportedByApiVersionException
* @throws InvalidIdentifierException
* @return array|json
*/
public function unbanCommunityUser($communityId, $userId, $accessToken)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if (!is_numeric($userId)) {
throw new InvalidIdentifierException('user');
}
return $this->delete(sprintf('communities/%s/bans/%s', $communityId, $userId), [], $accessToken);
}
/**
* Upload a community avatar image (600x800px)
*
* @param string $communityId
* @param string $avatar (base64 encoded)
* @param string $accessToken
* @throws InvalidTypeException
* @throws EndpointNotSupportedByApiVersionException
* @return null|array|json
*/
public function createCommunityAvatar($communityId, $avatar, $accessToken)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if (!is_string($avatar)) {
throw new InvalidTypeException('Avatar', 'string', gettype($avatar));
}
return $this->post(sprintf('communities/%s/images/avatar', $communityId), ['avatar_image' => $avatar], $accessToken);
}
/**
* Delete a community avatar image
*
* @param string $communityId
* @param string $accessToken
* @throws EndpointNotSupportedByApiVersionException
* @return null|array|json
*/
public function deleteCommunityAvatar($communityId, $accessToken)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
return $this->delete(sprintf('communities/%s/images/avatar', $communityId), [], $accessToken);
}
/**
* Upload a community cover image (1200x180px)
*
* @param string $communityId
* @param string $image (base64 encoded)
* @param string $accessToken
* @throws InvalidTypeException
* @throws EndpointNotSupportedByApiVersionException
* @return null|array|json
*/
public function createCommunityCoverImage($communityId, $image, $accessToken)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if (!is_string($image)) {
throw new InvalidTypeException('Cover image', 'string', gettype($image));
}
return $this->post(sprintf('communities/%s/images/cover', $communityId), ['cover_image' => $image], $accessToken);
}
/**
* Delete a community cover image
*
* @param string $communityId
* @param string $accessToken
* @throws EndpointNotSupportedByApiVersionException
* @return null|array|json
*/
public function deleteCommunityCoverImage($communityId, $accessToken)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
return $this->delete(sprintf('communities/%s/images/cover', $communityId), [], $accessToken);
}
/**
* Get community moderators
*
* @param string $communityId
* @throws EndpointNotSupportedByApiVersionException
* @return array|json
*/
public function getCommunityModerators($communityId)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
return $this->get(sprintf('communities/%s/moderators', $communityId));
}
/**
* Give a community user moderator permissions
*
* @param string $communityId
* @param int $userId
* @param string $accessToken
* @throws EndpointNotSupportedByApiVersionException
* @throws InvalidIdentifierException
* @return null|array|json
*/
public function addCommunityModerator($communityId, $userId, $accessToken)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if (!is_numeric($userId)) {
throw new InvalidIdentifierException('user');
}
return $this->put(sprintf('communities/%s/moderators/%s', $communityId, $userId), [], $accessToken);
}
/**
* Remove moderator permission from a community user
*
* @param string $communityId
* @param int $userId
* @param string $accessToken
* @throws EndpointNotSupportedByApiVersionException
* @throws InvalidIdentifierException
* @return null|array|json
*/
public function removeCommunityModerator($communityId, $userId, $accessToken)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if (!is_numeric($userId)) {
throw new InvalidIdentifierException('user');
}
return $this->delete(sprintf('communities/%s/moderators/%s', $communityId, $userId), [], $accessToken);
}
/**
* Get community permissions
*
* @param string $communityId
* @param string $accessToken
* @throws EndpointNotSupportedByApiVersionException
* @return array|json
*/
public function getCommunityPermissions($communityId, $accessToken)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
return $this->get(sprintf('communities/%s/permissions', $communityId), [], $accessToken);
}
/**
* Report a community channel violation
*
* @param string $communityId
* @param int $channelId
* @throws EndpointNotSupportedByApiVersionException
* @throws InvalidIdentifierException
* @return null|array|json
*/
public function reportCommunityViolation($communityId, $channelId)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if (!is_numeric($channelId)) {
throw new InvalidIdentifierException('channel');
}
return $this->post(sprintf('communities/%s/report_channel', $communityId), ['channel_id' => $channelId]);
}
/**
* Get timed-out community users
*
* @param string $communityId
* @param string $accessToken
* @throws EndpointNotSupportedByApiVersionException
* @throws InvalidLimitException
* @throws InvalidTypeException
* @return array|json
*/
public function getTimedOutCommunityUsers($communityId, $accessToken, $limit = 10, $cursor = null)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if (!$this->isValidLimit($limit)) {
throw new InvalidLimitException();
}
if ($cursor && !is_string($cursor)) {
throw new InvalidTypeException('Cursor', 'string', gettype($cursor));
}
$params = [
'limit' => intval($limit),
'cursor' => $cursor,
];
return $this->get(sprintf('communities/%s/timeouts', $communityId), $params, $accessToken);
}
/**
* Timeout a community user
*
* @param string $communityId
* @param int $userId
* @param string $accessToken
* @param int $duration
* @param string $reason
* @throws EndpointNotSupportedByApiVersionException
* @throws InvalidTypeException
* @return null|array|json
*/
public function timeoutCommunityUser($communityId, $userId, $accessToken, $duration, $reason = null)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if (!is_numeric($userId)) {
throw new InvalidIdentifierException('user');
}
if (!is_numeric($duration)) {
throw new InvalidTypeException('Duration', 'integer', gettype($duration));
}
if ($reason && !is_string($reason)) {
throw new InvalidTypeException('Reason', 'string', gettype($reason));
}
$params = [
'duration' => intval($duration),
'reason' => $reason,
];
return $this->put(sprintf('communities/%s/timeouts/%s', $communityId, $userId), $params, $accessToken);
}
/**
* Remove a timeout from a community user
*
* @param string $communityId
* @param int $userId
* @param string $accessToken
* @throws EndpointNotSupportedByApiVersionException
* @throws InvalidIdentifierException
* @return null|array|json
*/
public function removeCommunityUserTimeout($communityId, $userId, $accessToken)
{
if (!$this->apiVersionIsGreaterThanV4()) {
throw new EndpointNotSupportedByApiVersionException();
}
if (!is_numeric($userId)) {
throw new InvalidIdentifierException('user');
}
return $this->delete(sprintf('communities/%s/timeouts/%s', $communityId, $userId), [], $accessToken);
}
}