Added version to composer.json and a couple of small (hopefully non-breaking) changes

[irc/unrealircd/unrealircd-rpc-php.git] / lib / Ban.php

diff --git a/lib/Ban.php b/lib/Ban.php
index 66db0e6d12c4ddcb3b75541b730a4307f235d7f3..2a2272caeb4254a99f511e3f4e17a8606720657f 100644 (file)
--- a/lib/Ban.php
+++ b/lib/Ban.php
@@ -3,6 +3,7 @@
 namespace UnrealIRCd;
 
 use Exception;
+use stdClass;
 
 class Ban implements Contracts\Ban
 {
@@ -15,54 +16,46 @@ class Ban implements Contracts\Ban
     }
 
     /**
+     * Add a ban.
+     *
      * @param  string  $user
-     * @param  string  $type
      * @param  array  $params
-     * @return bool
+     * @return stdClass
      * @throws Exception
      */
-    public function add(string $user, string $type, array $params): bool
+    public function add(string $user, array $params): stdClass
     {
-        $response = $this->connection->query('server_ban.add', [
-            'name' => $params['name'],
+        return $this->connection->query('server_ban.add', [
+            'name' => $user,
             'type' => $params['type'],
             'reason' => $params['reason'],
-            'length' => $params['length'] ?? '1d',
+            'duration_string' => $params['length'] ?? '1d',
         ]);
-
-        if (is_bool($response)) {
-            return $response;
-        }
-
-        throw new Exception('Invalid JSON Response from UnrealIRCd RPC.');
     }
 
     /**
+     * Delete a ban.
+     *
      * @param  string  $user
-     * @param  string  $type
      * @param  array  $params
-     * @return bool
+     * @return stdClass
      * @throws Exception
      */
-    public function delete(string $user, string $type, array $params): bool
+    public function delete(string $user, array $params): stdClass
     {
-        $response = $this->connection->query('server_ban.del', [
-            'name' => $params['name'],
+        return $this->connection->query('server_ban.del', [
+            'name' => $user,
             'type' => $params['type'],
         ]);
-
-        if (is_bool($response)) {
-            return $response;
-        }
-
-        throw new Exception('Invalid JSON Response from UnrealIRCd RPC.');
     }
 
     /**
-     * @return array|bool
+     * Return a list of all bans.
+     *
+     * @return stdClass
      * @throws Exception
      */
-    public function get(): array|bool
+    public function get(): stdClass
     {
         $response = $this->connection->query('server_ban.list');
 
@@ -74,11 +67,13 @@ class Ban implements Contracts\Ban
     }
 
     /**
+     * Show a specific ban.
+     *
      * @param  array  $params
-     * @return object|bool
+     * @return stdClass
      * @throws Exception
      */
-    public function show(array $params): object|bool
+    public function show(array $params): stdClass
     {
         $response = $this->connection->query('server_ban.get', [
             'name' => $params['name'],