README

TS3 PHP Framework于2010年1月首次发布，是一个强大、开源、面向对象的框架，用PHP 5实现并遵循GNU通用公共许可证。它基于简洁性和经过严格测试的敏捷代码库。通过脚本扩展服务器功能，或创建强大的Web应用程序来管理TeamSpeak 3服务器实例的所有功能。

经过全面测试。采用敏捷方法构建，TS3 PHP Framework从一开始就进行了单元测试，以确保所有代码保持稳定，并便于您扩展、重新测试您的扩展，以及进一步维护。

为什么TS3 PHP Framework比其他库更好？

TS3 PHP Framework是一个现代的即用即弃框架，提供独立组件与TeamSpeak 3服务器进行通信。

与其他基于PHP的库相比，TS3 PHP Framework有很多优势。它是同类软件中最动态、功能最丰富的软件之一，正确使用时能提供前所未有的性能。

功能

TS3 PHP Framework的功能包括

• 完全面向对象的PHP 5和E_STRICT兼容组件
• 通过ServerQuery访问所有TeamSpeak 3服务器功能
• 集成了全功能且可定制的TSViewer接口
• 支持文件传输，上传和/或下载自定义图标和其他文件
• 使用异常和可定制的错误消息提供强大的错误处理能力
• 针对多个官方服务的查询机制，如黑名单和自动更新服务器
• 基于事件的脚本动态信号槽

使用这款小巧的软件加快新开发并降低维护成本！

安装

要求

• PHP - 在PHP 7.x上开发，针对7.2.x进行测试。
• TeamSpeak服务器 - v3.4.0（版本 >= 1536564584）或更高版本。

常用...

• 服务器 - Apache、nginx、php-fpm、CLI
• 数据库 - 独立（sqlite）、Maria DB、PostgreSQL
• 开发 - Git、composer、docker、PHPUnit

请注意，TS3 PHP Framework的大多数开发和部署都是在nginx上完成的，因此在Apache上比在其他Web服务器上拥有更多的社区经验和测试。

您可以通过手动下载或使用Composer来安装TS3 PHP Framework

composer require planetteamspeak/ts3-php-framework

上述命令将安装最新可用的版本。

如果您想安装TS3 PHP Framework的master分支（可能尚未发布/标记），则需要运行

composer require planetteamspeak/ts3-php-framework:dev-master

测试

要运行所有测试，请使用php vendor/bin/phpunit。

有用链接

访问以下页面以获取有关TS3 PHP Framework的更多信息

• 在线文档
• 变更日志
• 变更日志（开发版）

入门指南

连接URI（选项 + IPv4 vs IPv6）

在运行“获取服务器实例版本”或“更新某些设置”等命令之前，您需要指定要连接的实例。这是通过在TeamSpeak3::factory($uri)中使用URI来完成的。

基本$uri始终如下所示

$uri = "serverquery://username:password@127.0.0.1:10011/";

注意：如果您的URI中包含特殊字符，则您需要使用rawurlencode对这部分进行编码

$uri = "serverquery://" . rawurlencode("test!@#$%^&*()_+") . ":" . rawurlencode('sd5kjKJ2') . "@127.0.0.1:10011/";

您还可以在URI的最后面添加一些选项。

要连接到特定的虚拟TeamSpeak 3服务器，可以使用其virtualserver_port

$uri = "serverquery://username:password@127.0.0.1:10011/?server_port=9987";

可以使用简单的&添加额外的选项，就像在HTTP GET URL中一样

$uri = "serverquery://username:password@127.0.0.1:10011/?server_port=9987&blocking=0";

可用选项的列表可以在TeamSpeak3 > factory中找到

TS3 PHP框架支持连接到IPv6 TeamSpeak主机。IPv6地址必须写成方括号内

$uri = "serverquery://username:password@[fe80::250:56ff:fe16:1447]:10011/";

您可以使用这个简单的技巧来始终根据提供的IP地址类型获取正确的URI

if(filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) {
  $uri = "serverquery://username:password@${ip}:10011/";
} elseif(filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6)) {
  $uri = "serverquery://username:password@[${ip}]:10011/";
} else {
  echo "${ip} is no valid IPv4 or IPv6 address!";
}

SSH连接（仅适用于TeamSpeak服务器）

可以使用可选的ssh参数建立SSH连接

$uri = "serverquery://username:password@[fe80::250:56ff:fe16:1447]:10022/?ssh=1";

SSL/TLS连接（仅适用于TeaSpeak服务器）

可以使用可选的tls参数建立安全的ServerQuery连接

$uri = "serverquery://username:password@[fe80::250:56ff:fe16:1447]:10011/?tls=1";

自定义协议欢迎信息和/或MOTD（仅适用于TeaSpeak服务器）

如果您正在运行一个TeaSpeak服务器并带有自定义MOTD，只需在启动ServerQuery连接之前定义CUSTOM_PROTO_IDENT和/或CUSTOM_MOTD_PREFIX即可

define("CUSTOM_PROTO_IDENT", "MyTS3");
define("CUSTOM_MOTD_PREFIX", "Hello");

编码URI特殊字符

在将URI作为参数传递时，某些部分可能需要包含特殊字符。您应该使用rawurlencode对这些部分进行编码

// Bad:
$uri = "serverquery://test!@#$%^&*()_+:sd5kjKJ2@127.0.0.1:10011/";
// Good:
$uri = "serverquery://" . rawurlencode("test!@#$%^&*()_+") . ":sd5kjKJ2@127.0.0.1:10011/";

注意：编码URI组件而不是整个URI字符串。有效的特殊字符需要保持未编码！

特殊字符在新版的RFC 3986中被定义为不在(ascii, latin)集中的任何字符

ALPHA / DIGIT / "-" / "." / "_" / "~"

附加信息

• 最常见的情况是将'username'和'password'部分进行编码。
• 如果不使用特殊字符，则不需要编码。
• 路径和查询组件需要额外的解析，例如，我们不想对有效的'/'和'&'进行编码。
• 片段组件可能需要使用较旧的urlencode进行编码。
• RFC 1738 - 用于URI编码的旧RFC
• RFC 3986 - 当前的URI标准
• RFC 2396 - 第3节 - 有效的URI语法（特别是，组件）
• PHP.net - rawurlencode

常见的PHP代码（require解决方案）

常见的PHP代码意味着一个简单的file.php文件，其中您开始编写代码如下

<?php

echo "Hello World!";

当您使用此解决方案时，您可能会像这样开始使用TS3 PHP框架

<?php
// load framework files
require_once("libraries/TeamSpeak3/TeamSpeak3.php");
  
try
{
  // IPv4 connection URI
  $uri = "serverquery://username:password@127.0.0.1:10011/?server_port=9987";

  // connect to above specified server, authenticate and spawn an object for the virtual server on port 9987
  $ts3_VirtualServer = TeamSpeak3::factory($uri);

  // spawn an object for the channel using a specified name
  $ts3_Channel = $ts3_VirtualServer->channelGetByName("I do not exist");
}
catch(TeamSpeak3_Exception $e)
{
  // print the error message returned by the server
  echo "Error " . $e->getCode() . ": " . $e->getMessage();
}

PHP代码在MVC（use解决方案）

当您使用基于MVC的软件，如Symfony、CakePHP、Laravel或类似软件时，您可能会使用如下所示的内容

<?php

use TeamSpeak3;
use TeamSpeak3_Exception;

class TeamspeakController extends Controller
{
  public function doSomething()
    {
    try
    {
      // IPv4 connection URI
      $uri = "serverquery://username:password@127.0.0.1:10011/?server_port=9987";
      
      // Create new object of TS3 PHP Framework class
      $TS3PHPFramework = new TeamSpeak3();
      
      // connect to above specified server, authenticate and spawn an object for the virtual server on port 9987
      $ts3_VirtualServer = $TS3PHPFramework->factory($uri);
      
      // spawn an object for the channel using a specified name
      $ts3_Channel = $ts3_VirtualServer->channelGetByName("I do not exist");
    }
    catch(TeamSpeak3_Exception $e)
    {
      // print the error message returned by the server
      return "Error " . $e->getCode() . ": " . $e->getMessage();
    }
  }
}

有关更多信息，请访问文档（见上方的有用链接）。

Docker

设置本地TeamSpeak3测试实例（amd64，Alpine Linux）

docker run --name teamspeak_server -p 9987:9987/udp -p 10011:10011 -p 30033:30033 -e TS3SERVER_LICENSE=accept teamspeak:latest

添加-d标志以在后台运行。选项/示例：Docker文档 | Docker Hub

使用完整的docker stack来部署TeamSpeak 3和Maria DB

// If fresh Docker install, you might need to:
docker swarm init
// Deploy stack with latest TS3, PHP 7.x, Maria DB:
docker stack deploy -c docker-compose.yml teamspeak

其他有用的命令

docker logs teamspeak_server # View container logs
docker exec -it teamspeak_server sh # Open shell in container
docker stop teamspeak_server # Stop container
docker rm teamspeak_server # Remove container
docker ps # Show all processes
docker stack ps # Show stack processes
docker stack ls # List stacks

注意：在部署docker stack时，容器将被唯一命名

$ docker stack ps teamspeak
CONTAINER ID        IMAGE               ...   NAMES
f97fe9827b08        mariadb:latest      ...   teamspeak_db.1.xbwjm6jcu5qow44u5i9da2hcv
f9c1538b9875        teamspeak:latest    ...   teamspeak_teamspeak.1.rr3sipmw6dhod92wuhgs3s1rn