Download the PHP package prestige-solution/ts-x-php-framework without Composer
On this page you can find all versions of the php package prestige-solution/ts-x-php-framework. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download prestige-solution/ts-x-php-framework
More information about prestige-solution/ts-x-php-framework
Files in prestige-solution/ts-x-php-framework
Package ts-x-php-framework
Short Description A modern, refactored PHP framework for Teamspeak 3 and Teamspeak 6 servers, offering full SSH support and extensive unit tests.
License GPL-3.0
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package ts-x-php-framework
TeamSpeak X PHP Framework
[!CAUTION] IMPORTANT CHANGE
Starting with Version 3.x, the framework has been refactored to integratephpseclib3. These changes affect how TCP connections are established. The "raw" mode has been removed, and only SSH mode is supported to handle TeamSpeak 3 and TeamSpeak 6 Server API connections.
The "X" stands for a non-version-specific TeamSpeak server implementation, allowing support for all current and future versions of TeamSpeak Server.
As the original repository is no longer maintained, this project was created to bring the framework up to date, ensure PHP 8.x compatibility, and provide extensive unit test suites that can also be executed against a live server.
Installation
With the refactoring in version 3.x, the framework underwent substantial internal changes, while preserving most functionality and public namespaces.
Required PHP Extensions
apt install php8.3 php8.3-{common,mbstring,ssh2} -y
Via Composer
Current Version:
composer require prestige-solution/ts-x-php-framework
Or with a specific release:
composer require prestige-solution/ts-x-php-framework:latest
composer require prestige-solution/ts-x-php-framework:3.0.0-beta
Or with a specific branch:
composer require prestige-solution/ts-x-php-framework:dev-ts-x-refactoring-dev
If your TeamSpeak 3 server is not running with version 3.x, check the RSA host key configuration
See make-ts3-ssh-compatible.md for instructions on setting up a compatible RSA host key. It supports both Docker and non-Docker setups.
Test Routines for Live Server Testing
Prepare your Environment
Before running unit tests, ensure that all required environment variables are set. For more details, see testing-live-server.
Permissions for Query User
The recommended way to test all functionality is using the serveradmin query user.
Note: serveradmin is distinct from the Server Admin group found in the TeamSpeak client UI:
| serveradmin (Query) | Server Admin (GUI) |
|---|---|
| Max. permission value: 100 (=grant) | Max. permission value: 75 (=grant) |
For further details, see testing-live-server.
Additional Notes
- Using
serveradmincredentials over public networks poses a security risk. Support for SSH public key authentication is planned. - In the meantime, protect your instance using
fail2ban,query_ip_whitelist, andquery_ip_blacklist.
Run Tests
To run all tests, execute composer test.
Build Factory URI
Default URI Options
| Option | Default Value |
|---|---|
| timeout | 10 |
If you build the ServerQuery connection without specifying the parameter above, default values will be applied.
Note: Do not set timeout to 0. For more information, see php.net stream_select.
Examples
-
URI Example:
-
Verify your host with a fingerprint:
- If your username or password contains special characters such as
+, userawurlencode():
Recommendation: Avoid special characters in ServerQuery passwords and usernames where possible by generating plain alphanumeric credentials.
- Support IPv4, IPv6, or hostnames:
Important Note
We have no intention of abandoning compatibility with the original upstream repository. The namespace is preserved so that integration with the original PlanetTeamspeak repository remains possible if upstream maintenance resumes.
