TeamSpeak-API 3.0.0

Dieses Plugin dient als Schnittstelle zwischen weiteren Plugins und Ihrem TeamSpeak-Server. Dieses Plugin ist vor allem für Entwickler relevant. Es kann allerdings auch als Basis-Plugin für andere Plugins dienen.

Es können verschiedenen Server-Verbindungen eingestellt werden, auf diese dann von anderen Plugins zugegriffen werden können.

Fragen und Antworten

Wie erstelle ich eine neue Verbindung?

Gehe ins ACP -> Konfiguration -> TeamSpeak -> Server -> TeamSpeak-Server hinzufügen.

Wie kann ich die API in meinem Plugin implementieren?

Füge die Abhängigkeit zu diesem Plugin in deiner package.xml ein:

XML: package.xml
<requiredpackage minversion="1.5.2">eu.hanashi.wsc.teamspeak-api</requiredpackage>

Lass deine Nutzer die Serververbindung im ACP mit Hilfe der option.xml auswählen:

XML: option.xml
<option name="my_plugin_teamspeak_identity">
    <categoryname>my_category</categoryname>
    <optiontype>TeamSpeakConnectionSelect</optiontype>
</option>

Den Namen (im Beispiel my_plugin_teamspeak_identity) und die richtige Kategorie (im Beispiel my_category) musst du natürlich selbst wählen.

Nun erstellst du eine PHP-Klasse im Verzeichnis lib/system/teamspeak welche die Klasse AbstractTeamSpeakHandler erbt:

PHP: MyPluginTeamSpeakHandler.class.php
<?php
namespace wcf\system\teamspeak;

class MyPluginTeamSpeakHandler extends AbstractTeamSpeakHandler {
    protected $teamspeakID = MY_PLUGIN_TEAMSPEAK_IDENTITIY;
}

Den Datei- und Klassennamen darfst du natürlich selbst wählen. Vergiss dabei nicht die richtige Konstante anstatt MY_PLUGIN_TEAMSPEAK_IDENTITIY einzusetzen.

Nun kannst du in anderen Klassen auf die TeamSpeak-API zugreifen. Hier ein Beispiel in einer Action-Klasse:

Wie führe ich einen TeamSpeak-Befehl aus?

Der TeamSpeak-Befehl ist immer gleich der Methode. Die Parameter werden als Array an die Parameter übergeben. Hier einige Beispiele:

Bilder

  • Version 3.0.0

    Achtung: Es wird nun mindestens WoltLab Suite 5.3 vorausgesetzt.

    • CHANGE: Umstellung auf Database PHP API
    • CHANGE: Umstellung auf FormBuilder
    • CHANGE: ungenutzte uses entfernt
    • CHANGE: Umstellung auf GuzzleHttp für HTTP/HTTPS-Query
    • CHANGE: Umstellung des JavaScript-Codes auf TypeScript
    • CHANGE: phpseclib2 auf phpseclib3 aktualisiert
    • FEATURE: Query-Passwort wird beim Bearbeiten des Servers im ACP nicht mehr ausgegeben
    • FEATURE: bessere Auswahl der TeamSpeak-Server
    • FEATURE: bessere Fehlerausgabe wenn Server nicht angelegt werden kann
  • Version 2.1.1

    • CHANGE: Umstellung auf PSR-12
  • Version 2.1.0

    • FIX: Parameter bei HTTP/HTTPS-Query wurden falsch übergeben
    • FIX: Infinite Loop
    • FEATURE: Voraussetzungen für multiplen Server Select eingebaut
  • Version 2.0.0

    • FEATURE: die Nutzung von HTTP- und HTTPS-Server-Querys ist nun möglich
    • CHANGE: Rohe Rückgaben beim execute wurden entfernt
    • CHANGE: Code-Optimierungen
  • Version 1.5.7

    FIX: Deprecated PHP 7.4 function

  • Version 1.5.6

    Mit SSH wurde fälschlicherweise eine ErrorException anstatt einer TeamSpeakException ausgegeben

  • Version 1.5.5

    Verbesserte Ausgabe bei Fehlern zum Besseren Debugging.

  • Version 1.5.4

    • CHANGE; Umstellung auf MEDIUMINT damit höhere Ports verwendet werden können
  • Version 1.5.3

    • FIX: Behebt Fehlermeldung wenn keine Verbindung zum TS-Server aufgebaut werden konnte
  • Version 1.5.2

    • FIX: Download und Upload von Dateien