Road to 3.0.0-beta-2

.env.testing.example

@@ -9,3 +9,4 @@ DEV_LIVE_SERVER_UNIT_TEST_CHANNEL=UnitTest
 DEV_LIVE_SERVER_UNIT_TEST_USER_ACTIVE=false
 DEV_LIVE_SERVER_UNIT_TEST_USER=UnitTestUser
 DEV_LIVE_SERVER_UNIT_TEST_SIGNALS=false
+DEV_LIVE_SERVER_UNIT_TEST_USER_EXTEND=

CONTRIBUTING.md

@@ -1,24 +1,3 @@
-# How to contribute
-
-We are open to contributions from everyone! 3rd-party support goes a long way
-towards maintaining and improving the framework. Nothing is too small, from pull
-requests to reporting bugs, everything helps!
-
 ## Ways to contribute
 
-* Having trouble or find a bug? [Open an
-issue!](https://github.com/planetteamspeak/ts3phpframework/issues/new)
-* Add a feature or fix a bug:
-  * Check for existing issue or create a new one.
-  * Fork the repo, make your changes.
-  * Create a pull request, and reference the issue.
-* Add examples, tests, or improve documentation.
-
-## Test
-
-When committing code, please make sure to test before creating a pull request.
-
-We use PHPUnit for testing, feel free to add new tests. This is not a
-requirement, but helps us maintain code coverage.
-
-@ToDo: Add sections: test environment setup, running tests, examples
+* Having trouble or find a bug? [Open an issue!](https://github.com/Prestige-Solution/ts-x-php-framework/issues)

phpunit.xml.dist

@@ -27,6 +27,14 @@
       <directory>./tests</directory>
       <directory>./build</directory>
       <directory>./vendor</directory>
+      <file>./src/Exception/AdapterException.php</file>
+      <file>./src/Exception/FileTransferException.php</file>
+      <file>./src/Exception/HelperException.php</file>
+      <file>./src/Exception/NodeException.php</file>
+      <file>./src/Exception/ProfilerException.php</file>
+      <file>./src/Exception/SignalException.php</file>
+      <file>./src/Exception/TransportException.php</file>
+      <file>./src/Helper/Signal/SignalInterface.php</file>
     </exclude>
   </source>
   <coverage ignoreDeprecatedCodeUnits="true"

src/Helper/Char.php

@@ -26,8 +26,8 @@ class Char
      */
     public function __construct(string $char)
     {
-        if (strlen($char) != 1) {
-            throw new HelperException('char parameter may not contain more or less than one character');
+        if (mb_strlen($char, 'UTF-8') !== 1) {
+            throw new HelperException('char parameter may not contain more or less than one UTF-8 character');
         }
 
         $this->char = $char;
@@ -167,7 +167,7 @@ public function toUnicode(): int
         if ($h <= 0x7F) {
             return $h;
         } elseif ($h < 0xC2) {
-            return false;
+            return -1;
         } elseif ($h <= 0xDF) {
             return ($h & 0x1F) << 6 | (ord($this->char[1]) & 0x3F);
         } elseif ($h <= 0xEF) {
@@ -198,11 +198,18 @@ public function toHex(): string
      */
     public static function fromHex(string $hex): self
     {
-        if (strlen($hex) != 2) {
+        // Check: only even numbers of hex characters allowed, all must be valid
+        if (strlen($hex) % 2 !== 0 || ! ctype_xdigit($hex)) {
             throw new HelperException("given parameter '".$hex."' is not a valid hexadecimal number");
         }
 
-        return new self(chr(hexdec($hex)));
+        // Hex → Binary string (UTF-8 compatible)
+        $bytes = hex2bin($hex);
+        if ($bytes === false) {
+            throw new HelperException("given parameter '".$hex."' could not be converted to binary data");
+        }
+
+        return new self($bytes);
     }
 
     /**

src/Node/Channel.php

@@ -17,10 +17,6 @@
  */
 class Channel extends Node
 {
-    private array|null $clientList = null;
-
-    private array $channelList = [];
-
     /**
      * Channel constructor.
      *
@@ -558,16 +554,6 @@ protected function fetchNodeInfo(): void
         $this->nodeInfo = array_merge($this->nodeInfo, $this->execute('channelinfo', ['cid' => $this->getId()])->toList());
     }
 
-    /**
-     * Returns a unique identifier for the node which can be used as an HTML property.
-     *
-     * @return string
-     */
-    public function getUniqueId(): string
-    {
-        return $this->getParent()->getUniqueId().'_ch'.$this->getId();
-    }
-
     /**
      * Returns the name of a possible icon to display the node object.
      *

src/Node/ChannelGroup.php

@@ -98,14 +98,14 @@ public function permList(bool $permsid = false): array
      * Adds a set of specified permissions to the channel group. Multiple permissions
      * can be added by providing the two parameters of each permission in separate arrays.
      *
-     * @param  int  $permid
-     * @param  int  $permvalue
+     * @param  int|array  $permid
+     * @param  int|array  $permvalue
      * @return void
      * @throws AdapterException
      * @throws ServerQueryException
      * @throws TransportException
      */
-    public function permAssign(int $permid, int $permvalue): void
+    public function permAssign(int|array $permid, int|array $permvalue): void
     {
         $this->getParent()->channelGroupPermAssign($this->getId(), $permid, $permvalue);
     }
@@ -114,13 +114,13 @@ public function permAssign(int $permid, int $permvalue): void
      * Removes a set of specified permissions from the channel group. Multiple
      * permissions can be removed at once.
      *
-     * @param  int  $permid
+     * @param  int|array  $permid
      * @return void
      * @throws AdapterException
      * @throws ServerQueryException
      * @throws TransportException
      */
-    public function permRemove(int $permid): void
+    public function permRemove(int|array $permid): void
     {
         $this->getParent()->channelGroupPermRemove($this->getId(), $permid);
     }
@@ -172,16 +172,6 @@ protected function fetchNodeList(): void
         }
     }
 
-    /**
-     * Returns a unique identifier for the node which can be used as an HTML property.
-     *
-     * @return string
-     */
-    public function getUniqueId(): string
-    {
-        return $this->getParent()->getUniqueId().'_cg'.$this->getId();
-    }
-
     /**
      * Returns the name of a possible icon to display the node object.
      *

src/Node/Client.php

@@ -293,13 +293,13 @@ public function permAssign(int|array $permid, int|array $permvalue, array|bool $
     /**
      * Removes a set of specified permissions from a client. Multiple permissions can be removed at once.
      *
-     * @param  int  $permid
+     * @param  array|int  $permid
      * @return void
      * @throws AdapterException
      * @throws ServerQueryException
      * @throws TransportException
      */
-    public function permRemove(int $permid): void
+    public function permRemove(array|int $permid): void
     {
         $this->getParent()->clientPermRemove($this['client_database_id'], $permid);
     }
@@ -527,16 +527,6 @@ protected function fetchNodeInfo(): void
         }
     }
 
-    /**
-     * Returns a unique identifier for the node which can be used as an HTML property.
-     *
-     * @return string
-     */
-    public function getUniqueId(): string
-    {
-        return $this->getParent()->getUniqueId().'_cl'.$this->getId();
-    }
-
     /**
      * Returns the name of a possible icon to display the node object.
      *

src/Node/Group.php

@@ -23,9 +23,14 @@ abstract class Group extends Node
      */
     public function message(string $msg): void
     {
-        foreach ($this as $client) {
+        // get all clients in this group
+        $clients = $this->getParent()->channelGroupClientList($this->getId());
+
+        // get client id from dbid and send a textmessage
+        foreach ($clients as $client) {
             try {
-                $this->execute('sendtextmessage', ['msg' => $msg, 'target' => $client, 'targetmode' => TeamSpeak3::TEXTMSG_CLIENT]);
+                $targetClientID = $this->getParent()->clientgetbydbid($client['cldbid'])->getId();
+                $this->execute('sendtextmessage', ['msg' => $msg, 'target' => $targetClientID, 'targetmode' => TeamSpeak3::TEXTMSG_CLIENT]);
             } catch (ServerQueryException $e) {
                 /* ERROR_client_invalid_id */
                 if ($e->getCode() != 0x0200) {