From b3fe069c28d10eb86db0237bcb17456f57c1c0f9 Mon Sep 17 00:00:00 2001 From: repat Date: Thu, 17 Sep 2020 00:01:44 +1200 Subject: [PATCH] fix: return types (#94) --- .gitignore | 1 + src/API/AbstractAPI.php | 4 ++-- src/API/Blocks.php | 12 ++++++------ src/API/Bridgechains.php | 6 +++--- src/API/Businesses.php | 8 ++++---- src/API/Delegates.php | 8 ++++---- src/API/Locks.php | 8 ++++---- src/API/Node.php | 10 +++++----- src/API/Peers.php | 4 ++-- src/API/Rounds.php | 2 +- src/API/Transactions.php | 16 ++++++++-------- src/API/Votes.php | 4 ++-- src/API/Wallets.php | 18 +++++++++--------- src/Connection.php | 3 ++- 14 files changed, 53 insertions(+), 51 deletions(-) diff --git a/.gitignore b/.gitignore index 7cf8729..d6f39c9 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ composer.lock phpunit.xml vendor clover.xml +.phpunit.result.cache \ No newline at end of file diff --git a/src/API/AbstractAPI.php b/src/API/AbstractAPI.php index 6f63332..4747a24 100644 --- 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 index aaa8b2c..8209e3a 100644 --- 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 index b6d29bf..d0583a8 100644 --- 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 index 5aba033..23d61e7 100644 --- 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 index 3ee7674..2fe8edd 100644 --- 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 index 89e0568..de56ca6 100644 --- 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 index 716a914..b65310d 100644 --- 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 index d20180f..55fa830 100644 --- 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 index 2e19dd6..29c067e 100644 --- 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 index 351c579..d5851c3 100644 --- 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 index 6613a15..b73507b 100644 --- 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}"); } diff --git a/src/API/Wallets.php b/src/API/Wallets.php index 73d0559..fc03f94 100644 --- a/src/API/Wallets.php +++ b/src/API/Wallets.php @@ -27,7 +27,7 @@ class Wallets extends AbstractAPI * * @return array */ - public function all(array $query = []): array + public function all(array $query = []): ?array { return $this->get('wallets', $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("wallets/{$id}"); } @@ -52,7 +52,7 @@ public function show(string $id): array * * @return array */ - public function locks(string $id, array $query = []): array + public function locks(string $id, array $query = []): ?array { return $this->get("wallets/{$id}/locks", $query); } @@ -65,7 +65,7 @@ public function locks(string $id, array $query = []): array * * @return array */ - public function transactions(string $id, array $query = []): array + public function transactions(string $id, array $query = []): ?array { return $this->get("wallets/{$id}/transactions", $query); } @@ -78,7 +78,7 @@ public function transactions(string $id, array $query = []): array * * @return array */ - public function sentTransactions(string $id, array $query = []): array + public function sentTransactions(string $id, array $query = []): ?array { return $this->get("wallets/{$id}/transactions/sent", $query); } @@ -91,7 +91,7 @@ public function sentTransactions(string $id, array $query = []): array * * @return array */ - public function receivedTransactions(string $id, array $query = []): array + public function receivedTransactions(string $id, array $query = []): ?array { return $this->get("wallets/{$id}/transactions/received", $query); } @@ -104,7 +104,7 @@ public function receivedTransactions(string $id, array $query = []): array * * @return array */ - public function votes(string $id, array $query = []): array + public function votes(string $id, array $query = []): ?array { return $this->get("wallets/{$id}/votes", $query); } @@ -116,7 +116,7 @@ public function votes(string $id, array $query = []): array * * @return array */ - public function search(array $parameters): array + public function search(array $parameters): ?array { return $this->post('wallets/search', $parameters); } @@ -126,7 +126,7 @@ public function search(array $parameters): array * * @return array */ - public function top(): array + public function top(): ?array { return $this->get('wallets/top'); } diff --git a/src/Connection.php b/src/Connection.php index 9f83484..2905255 100644 --- a/src/Connection.php +++ b/src/Connection.php @@ -17,6 +17,7 @@ use GuzzleHttp\Client; use BadMethodCallException; use GuzzleHttp\HandlerStack; +use Illuminate\Support\Str; /** * This is the connection class. @@ -41,7 +42,7 @@ class Connection public function __construct(array $config, HandlerStack $handler = null) { $options = [ - 'base_uri' => $config['host'], + 'base_uri' => Str::finish($config['host'], '/'), 'headers' => [ 'Content-Type' => 'application/json', ],