ServerGroup.php

Go to the documentation of this file.

<?php
 
namespace PlanetTeamSpeak\TeamSpeak3Framework\Node;
 
use PlanetTeamSpeak\TeamSpeak3Framework\Exception\NodeException;
use PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3;

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

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

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

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

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

    public function permAssign(int $permid, int $permvalue, int $permnegated = 0, int $permskip = 0): void
    {
        $this->getParent()->serverGroupPermAssign($this->getId(), $permid, $permvalue, $permnegated, $permskip);
    }

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

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

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

    public function clientList(): array
    {
        return $this->getParent()->serverGroupClientList($this->getId());
    }

    public function clientAdd(int $cldbid): void
    {
        $this->getParent()->serverGroupClientAdd($this->getId(), $cldbid);
    }

    public function clientDel(int $cldbid): void
    {
        $this->getParent()->serverGroupClientDel($this->getId(), $cldbid);
    }

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

    public function privilegeKeyCreate(string $description = null, string $customset = null): string
    {
        return $this->getParent()
            ->privilegeKeyCreate($this->getId(), TeamSpeak3::TOKEN_SERVERGROUP, 0, $description, $customset);
    }

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

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

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