README

这是一个用于与 TeamSpeak 3 服务器查询接口交互的 PHP 框架，适用于网页和命令行应用程序。

安装

• 通过 composer 安装此包

composer require mskarbek48/teamspeakframework

功能

• 访问所有 TeamSpeak 3 和 TeamSpeak 5 服务器查询命令。
• 处理默认 TeamSpeak "notifyevents" 和日志中的自定义事件。
• 与 TeamSpeak 3 和 TeamSpeak 5 服务器的兼容性。
• 与 PHP 8.3 及更高版本兼容。

测试

• 要运行测试，您需要通过 composer 安装包，然后运行以下命令

php vendor/bin/phpunit

入门

• 连接到 TeamSpeak ServerQuery 接口

<?php

use mskarbek48\TeamspeakFramework\TeamSpeak;

require_once __DIR__ . '/../vendor/autoload.php';

try {
    $TeamSpeak = TeamSpeak::factory()
        ->setHost('localhost')
        ->setPort(10011)
        ->connect();
} catch (\mskarbek48\TeamspeakFramework\Exception\TransportException $e) {
    echo $e->getMessage();
}

• 获取 ServerQuery 实例并进行登录

$instance = $TeamSpeak->getInstance();
$instance->login('username', 'password');

• 通过端口号选择服务器实例

$server = $instance->selectServerByPort(9987);

• 通过 ID 选择服务器实例

$server = $instance->selectServerById(1);

• 监听 TeamSpeak 事件

$server->serverNotifyRegister('server');
$server->serverNotifyRegister('channel',0);
$server->serverNotifyRegister('textprivate');

while($server->getParent()->isConnected())
{
    if(time() - $server->getParent()->getLastExecutedCommandTime() > 60)
    {
        $server->getParent()->version(); # Prevent timeout
    }
    $event = $server->getParent()->waitForEvents(1); # Set to zero, to disable blocking
    switch(key($event)) {
        case "notifyclientmoved":
            echo "Client moved: " . $event['clid'] . " to " . $event['ctid'] . PHP_EOL;
            break;
    }
}

实际示例

<?php

use mskarbek48\TeamspeakFramework\TeamSpeak;

require_once __DIR__ . '/../vendor/autoload.php';

try {
    $TeamSpeak = TeamSpeak::factory()
        ->setHost('localhost')
        ->setPort(10011)
        ->connect();
} catch (\mskarbek48\TeamspeakFramework\Exception\TransportException $e) {
    echo $e->getMessage();
}
$instance = $TeamSpeak->getInstance();
$instance->login('username', 'password');

$server = $instance->selectServerByPort(9987);


# Kick all clients from the server with a specific nickname:
foreach($server->clientList()->toAssocArray() as $client)
{
    if($client['client_nickname']== 'iwanttobekicked')
    {
        $server->clientKick($client['clid'], TeamSpeak::TEAMSPEAK_KICK_SERVER, 'Bye bye!');
    }
}

许可协议

本项目采用 MIT 许可协议 - 有关详细信息，请参阅LICENSE.md 文件。