ChannelGroup.php

Go to the documentation of this file.

<?php
 
namespace PlanetTeamSpeak\TeamSpeak3Framework\Node;
 
use PlanetTeamSpeak\TeamSpeak3Framework\Exception\ServerQueryException;
use PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper;
use PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3;

class ChannelGroup extends Group
{
    public function __construct(Server $server, array $info, string $index = "cgid")
    {
        $this->parent = $server;
        $this->nodeInfo = $info;
 
        if (!array_key_exists($index, $this->nodeInfo)) {
            throw new ServerQueryException("invalid groupID", 0xA00);
        }
 
        $this->nodeId = $this->nodeInfo[$index];
    }

    public function rename(string $name): void
    {
        $this->getParent()->channelGroupRename($this->getId(), $name);
    }

    public function delete(bool $force = false): void
    {
        $this->getParent()->channelGroupDelete($this->getId(), $force);
    }

    public function copy(string $name = null, int $tcgid = 0, int $type = TeamSpeak3::GROUP_DBTYPE_REGULAR): int
    {
        return $this->getParent()->channelGroupCopy($this->getId(), $name, $tcgid, $type);
    }

    public function permList(bool $permsid = false): array
    {
        return $this->getParent()->channelGroupPermList($this->getId(), $permsid);
    }

    public function permAssign(int $permid, int $permvalue): void
    {
        $this->getParent()->channelGroupPermAssign($this->getId(), $permid, $permvalue);
    }

    public function permAssignByName($permname, $permvalue)
    {
        $this->permAssign($permname, $permvalue);
    }

    public function permRemove(int $permid): void
    {
        $this->getParent()->channelGroupPermRemove($this->getId(), $permid);
    }

    public function permRemoveByName($permname)
    {
        $this->permRemove($permname);
    }

    public function clientList(int $cid = null, int $cldbid = null, bool $resolve = false): array
    {
        return $this->getParent()->channelGroupClientList($this->getId(), $cid, $cldbid, $resolve);
    }

    public function tokenCreate($cid, $description = null, $customset = null): StringHelper
    {
        return $this->privilegeKeyCreate($cid, $description, $customset);
    }

    public function privilegeKeyCreate(int $cid, string $description = null, string $customset = null): StringHelper
    {
        return $this->getParent()->privilegeKeyCreate($this->getId(), TeamSpeak3::TOKEN_CHANNELGROUP, $cid, $description, $customset);
    }

    protected function fetchNodeList()
    {
        $this->nodeList = [];
 
        foreach ($this->getParent()->clientList() as $client) {
            if ($client["client_channel_group_id"] == $this->getId()) {
                $this->nodeList[] = $client;
            }
        }
    }

    public function getUniqueId(): string
    {
        return $this->getParent()->getUniqueId() . "_cg" . $this->getId();
    }

    public function getIcon(): string
    {
        return "group_channel";
    }
}