fix: return types (#94)

ArkEcosystem · Sep 16, 2020 · b3fe069 · b3fe069
1 parent 12dd044
commit b3fe069
Show file tree

Hide file tree

Showing 14 changed files with 53 additions and 51 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@ composer.lock
 phpunit.xml
 vendor
 clover.xml
+.phpunit.result.cache
diff --git a/src/API/AbstractAPI.php b/src/API/AbstractAPI.php
@@ -48,7 +48,7 @@ public function __construct(Connection $connection)
      * @param string $path
      * @param array  $query
      *
-     * @return array|string
+     * @return array|null|bool
      */
     protected function get(string $path, array $query = [])
     {
@@ -63,7 +63,7 @@ protected function get(string $path, array $query = [])
      * @param string $path
      * @param array  $parameters
      *
-     * @return array|string
+     * @return array|null|bool
      */
     protected function post(string $path, array $parameters = [])
     {

diff --git a/src/API/Blocks.php b/src/API/Blocks.php
@@ -27,7 +27,7 @@ class Blocks extends AbstractAPI
      *
      * @return array
      */
-    public function all(array $query = []): array
+    public function all(array $query = []): ?array
     {
         return $this->get('blocks', $query);
     }
@@ -39,7 +39,7 @@ public function all(array $query = []): array
      *
      * @return array
      */
-    public function show(string $id): array
+    public function show(string $id): ?array
     {
         return $this->get("blocks/{$id}");
     }
@@ -49,7 +49,7 @@ public function show(string $id): array
      *
      * @return array
      */
-    public function first(): array
+    public function first(): ?array
     {
         return $this->get('blocks/first');
     }
@@ -59,7 +59,7 @@ public function first(): array
      *
      * @return array
      */
-    public function last(): array
+    public function last(): ?array
     {
         return $this->get('blocks/last');
     }
@@ -72,7 +72,7 @@ public function last(): array
      *
      * @return array
      */
-    public function transactions(string $id, array $query = []): array
+    public function transactions(string $id, array $query = []): ?array
     {
         return $this->get("blocks/{$id}/transactions", $query);
     }
@@ -84,7 +84,7 @@ public function transactions(string $id, array $query = []): array
      *
      * @return array
      */
-    public function search(array $parameters): array
+    public function search(array $parameters): ?array
     {
         return $this->post('blocks/search', $parameters);
     }

diff --git a/src/API/Bridgechains.php b/src/API/Bridgechains.php
@@ -27,7 +27,7 @@ class Bridgechains extends AbstractAPI
      *
      * @return array
      */
-    public function all(array $query = []): array
+    public function all(array $query = []): ?array
     {
         return $this->get('bridgechains', $query);
     }
@@ -39,7 +39,7 @@ public function all(array $query = []): array
      *
      * @return array
      */
-    public function show(string $id): array
+    public function show(string $id): ?array
     {
         return $this->get("bridgechain/{$id}");
     }
@@ -51,7 +51,7 @@ public function show(string $id): array
      *
      * @return array
      */
-    public function search(array $parameters): array
+    public function search(array $parameters): ?array
     {
         return $this->post('bridgechain/search', $parameters);
     }

diff --git a/src/API/Businesses.php b/src/API/Businesses.php
@@ -27,7 +27,7 @@ class Businesses extends AbstractAPI
      *
      * @return array
      */
-    public function all(array $query = []): array
+    public function all(array $query = []): ?array
     {
         return $this->get('businesses', $query);
     }
@@ -39,7 +39,7 @@ public function all(array $query = []): array
      *
      * @return array
      */
-    public function show(string $id): array
+    public function show(string $id): ?array
     {
         return $this->get("businesses/{$id}");
     }
@@ -52,7 +52,7 @@ public function show(string $id): array
      *
      * @return array
      */
-    public function bridgechains(string $id, array $query = []): array
+    public function bridgechains(string $id, array $query = []): ?array
     {
         return $this->get("businesses/{$id}/bridgechains", $query);
     }
@@ -64,7 +64,7 @@ public function bridgechains(string $id, array $query = []): array
      *
      * @return array
      */
-    public function search(array $parameters): array
+    public function search(array $parameters): ?array
     {
         return $this->post('businesses/search', $parameters);
     }

diff --git a/src/API/Delegates.php b/src/API/Delegates.php
@@ -27,7 +27,7 @@ class Delegates extends AbstractAPI
      *
      * @return array
      */
-    public function all(array $query = []): array
+    public function all(array $query = []): ?array
     {
         return $this->get('delegates', $query);
     }
@@ -39,7 +39,7 @@ public function all(array $query = []): array
      *
      * @return array
      */
-    public function show(string $id): array
+    public function show(string $id): ?array
     {
         return $this->get("delegates/{$id}");
     }
@@ -52,7 +52,7 @@ public function show(string $id): array
      *
      * @return array
      */
-    public function blocks(string $id, array $query = []): array
+    public function blocks(string $id, array $query = []): ?array
     {
         return $this->get("delegates/{$id}/blocks", $query);
     }
@@ -65,7 +65,7 @@ public function blocks(string $id, array $query = []): array
      *
      * @return array
      */
-    public function voters(string $id, array $query = []): array
+    public function voters(string $id, array $query = []): ?array
     {
         return $this->get("delegates/{$id}/voters", $query);
     }

diff --git a/src/API/Locks.php b/src/API/Locks.php
@@ -27,7 +27,7 @@ class Locks extends AbstractAPI
      *
      * @return array
      */
-    public function all(array $query = []): array
+    public function all(array $query = []): ?array
     {
         return $this->get('locks', $query);
     }
@@ -39,7 +39,7 @@ public function all(array $query = []): array
      *
      * @return array
      */
-    public function show(string $id): array
+    public function show(string $id): ?array
     {
         return $this->get("locks/{$id}");
     }
@@ -51,7 +51,7 @@ public function show(string $id): array
      *
      * @return array
      */
-    public function search(array $parameters): array
+    public function search(array $parameters): ?array
     {
         return $this->post('locks/search', $parameters);
     }
@@ -63,7 +63,7 @@ public function search(array $parameters): array
      *
      * @return array
      */
-    public function unlocked(array $parameters): array
+    public function unlocked(array $parameters): ?array
     {
         return $this->post('locks/unlocked', $parameters);
     }

diff --git a/src/API/Node.php b/src/API/Node.php
@@ -25,7 +25,7 @@ class Node extends AbstractAPI
      *
      * @return array
      */
-    public function status(): array
+    public function status(): ?array
     {
         return $this->get('node/status');
     }
@@ -35,7 +35,7 @@ public function status(): array
      *
      * @return array
      */
-    public function syncing(): array
+    public function syncing(): ?array
     {
         return $this->get('node/syncing');
     }
@@ -45,7 +45,7 @@ public function syncing(): array
      *
      * @return array
      */
-    public function configuration(): array
+    public function configuration(): ?array
     {
         return $this->get('node/configuration');
     }
@@ -55,7 +55,7 @@ public function configuration(): array
      *
      * @return array
      */
-    public function crypto(): array
+    public function crypto(): ?array
     {
         return $this->get('node/configuration/crypto');
     }
@@ -67,7 +67,7 @@ public function crypto(): array
      *
      * @return array
      */
-    public function fees(int $days = null): array
+    public function fees(int $days = null): ?array
     {
         return $this->get('node/fees', ['days' => $days]);
     }

diff --git a/src/API/Peers.php b/src/API/Peers.php
@@ -27,7 +27,7 @@ class Peers extends AbstractAPI
      *
      * @return array
      */
-    public function all(array $query = []): array
+    public function all(array $query = []): ?array
     {
         return $this->get('peers', $query);
     }
@@ -39,7 +39,7 @@ public function all(array $query = []): array
      *
      * @return array
      */
-    public function show(string $ip): array
+    public function show(string $ip): ?array
     {
         return $this->get("peers/{$ip}");
     }

diff --git a/src/API/Rounds.php b/src/API/Rounds.php
@@ -27,7 +27,7 @@ class Rounds extends AbstractAPI
      *
      * @return array
      */
-    public function delegates(int $round_id): array
+    public function delegates(int $round_id): ?array
     {
         return $this->get("rounds/{$round_id}/delegates");
     }

diff --git a/src/API/Transactions.php b/src/API/Transactions.php
@@ -27,7 +27,7 @@ class Transactions extends AbstractAPI
      *
      * @return array
      */
-    public function all(array $query = []): array
+    public function all(array $query = []): ?array
     {
         return $this->get('transactions', $query);
     }
@@ -39,7 +39,7 @@ public function all(array $query = []): array
      *
      * @return array
      */
-    public function create(array $transactions): array
+    public function create(array $transactions): ?array
     {
         return $this->post('transactions', compact('transactions'));
     }
@@ -51,7 +51,7 @@ public function create(array $transactions): array
      *
      * @return array
      */
-    public function show(string $id): array
+    public function show(string $id): ?array
     {
         return $this->get("transactions/{$id}");
     }
@@ -61,7 +61,7 @@ public function show(string $id): array
      *
      * @return array
      */
-    public function allUnconfirmed(): array
+    public function allUnconfirmed(): ?array
     {
         return $this->get('transactions/unconfirmed');
     }
@@ -73,7 +73,7 @@ public function allUnconfirmed(): array
      *
      * @return array
      */
-    public function showUnconfirmed(string $id): array
+    public function showUnconfirmed(string $id): ?array
     {
         return $this->get("transactions/unconfirmed/{$id}");
     }
@@ -85,7 +85,7 @@ public function showUnconfirmed(string $id): array
      *
      * @return array
      */
-    public function search(array $parameters): array
+    public function search(array $parameters): ?array
     {
         return $this->post('transactions/search', $parameters);
     }
@@ -95,7 +95,7 @@ public function search(array $parameters): array
      *
      * @return array
      */
-    public function types(): array
+    public function types(): ?array
     {
         return $this->get('transactions/types');
     }
@@ -105,7 +105,7 @@ public function types(): array
      *
      * @return array
      */
-    public function fees(): array
+    public function fees(): ?array
     {
         return $this->get('transactions/fees');
     }

diff --git a/src/API/Votes.php b/src/API/Votes.php
@@ -27,7 +27,7 @@ class Votes extends AbstractAPI
      *
      * @return array
      */
-    public function all(array $query = []): array
+    public function all(array $query = []): ?array
     {
         return $this->get('votes', $query);
     }
@@ -39,7 +39,7 @@ public function all(array $query = []): array
      *
      * @return array
      */
-    public function show(string $id): array
+    public function show(string $id): ?array
     {
         return $this->get("votes/{$id}");
     }