PHPDoc GuzzleException Throwable (#11)

hflabs · Apr 11, 2024 · b73e6dc · b73e6dc
1 parent cc85a59
commit b73e6dc
Show file tree

Hide file tree

Showing 5 changed files with 77 additions and 1 deletion.
diff --git a/src/CleanClient.php b/src/CleanClient.php
@@ -2,6 +2,8 @@
 
 namespace Dadata;
 
+use GuzzleHttp\Exception\GuzzleException;
+
 class CleanClient extends ClientBase
 {
     const BASE_URL = "https://cleaner.dadata.ru/api/v1/";
@@ -11,6 +13,9 @@ public function __construct($token, $secret)
         parent::__construct(self::BASE_URL, $token, $secret);
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function clean($name, $value)
     {
         $url = "clean/$name";
@@ -19,6 +24,9 @@ public function clean($name, $value)
         return $response[0];
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function cleanRecord($structure, $record)
     {
         $url = "clean";

diff --git a/src/ClientBase.php b/src/ClientBase.php
@@ -2,6 +2,9 @@
 
 namespace Dadata;
 
+use GuzzleHttp\Client;
+use GuzzleHttp\Exception\GuzzleException;
+
 abstract class ClientBase
 {
     public $client;
@@ -16,19 +19,25 @@ public function __construct($baseUrl, $token, $secret = null)
         if ($secret) {
             $headers["X-Secret"] = $secret;
         }
-        $this->client = new \GuzzleHttp\Client([
+        $this->client = new Client([
             "base_uri" => $baseUrl,
             "headers" => $headers,
             "timeout" => Settings::TIMEOUT_SEC
         ]);
     }
 
+    /**
+     * @throws GuzzleException
+     */
     protected function get($url, $query = [])
     {
         $response = $this->client->get($url, ["query" => $query]);
         return json_decode($response->getBody(), true);
     }
 
+    /**
+     * @throws GuzzleException
+     */
     protected function post($url, $data)
     {
         $response = $this->client->post($url, [

diff --git a/src/DadataClient.php b/src/DadataClient.php
@@ -2,6 +2,8 @@
 
 namespace Dadata;
 
+use GuzzleHttp\Exception\GuzzleException;
+
 class DadataClient
 {
     private $cleaner;
@@ -15,51 +17,81 @@ public function __construct($token, $secret)
         $this->suggestions = new SuggestClient($token, $secret);
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function clean($name, $value)
     {
         return $this->cleaner->clean($name, $value);
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function cleanRecord($structure, $record)
     {
         return $this->cleaner->cleanRecord($structure, $record);
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function findAffiliated($query, $count = Settings::SUGGESTION_COUNT, $kwargs = [])
     {
         return $this->suggestions->findAffiliated($query, $count, $kwargs);
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function findById($name, $query, $count = Settings::SUGGESTION_COUNT, $kwargs = [])
     {
         return $this->suggestions->findById($name, $query, $count, $kwargs);
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function geolocate($name, $lat, $lon, $radiusMeters = 100, $count = Settings::SUGGESTION_COUNT, $kwargs = [])
     {
         return $this->suggestions->geolocate($name, $lat, $lon, $radiusMeters, $count, $kwargs);
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function getBalance()
     {
         return $this->profile->getBalance();
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function getDailyStats($date = null)
     {
         return $this->profile->getDailyStats($date);
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function getVersions()
     {
         return $this->profile->getVersions();
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function iplocate($ip, $kwargs = [])
     {
         return $this->suggestions->iplocate($ip, $kwargs);
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function suggest($name, $query, $count = Settings::SUGGESTION_COUNT, $kwargs = [])
     {
         return $this->suggestions->suggest($name, $query, $count, $kwargs);

diff --git a/src/ProfileClient.php b/src/ProfileClient.php
@@ -3,6 +3,7 @@
 namespace Dadata;
 
 use DateTime;
+use GuzzleHttp\Exception\GuzzleException;
 
 class ProfileClient extends ClientBase
 {
@@ -13,13 +14,19 @@ public function __construct($token, $secret)
         parent::__construct(self::BASE_URL, $token, $secret);
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function getBalance()
     {
         $url = "profile/balance";
         $response = $this->get($url);
         return $response["balance"];
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function getDailyStats($date = null)
     {
         $url = "stat/daily";
@@ -31,6 +38,9 @@ public function getDailyStats($date = null)
         return $response;
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function getVersions()
     {
         $url = "version";

diff --git a/src/SuggestClient.php b/src/SuggestClient.php
@@ -2,6 +2,8 @@
 
 namespace Dadata;
 
+use GuzzleHttp\Exception\GuzzleException;
+
 class SuggestClient extends ClientBase
 {
     const BASE_URL = "https://suggestions.dadata.ru/suggestions/api/4_1/rs/";
@@ -11,6 +13,9 @@ public function __construct($token, $secret = null)
         parent::__construct(self::BASE_URL, $token, $secret);
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function findAffiliated($query, $count = Settings::SUGGESTION_COUNT, $kwargs = [])
     {
         $url = "findAffiliated/party";
@@ -20,6 +25,9 @@ public function findAffiliated($query, $count = Settings::SUGGESTION_COUNT, $kwa
         return $response["suggestions"];
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function findById($name, $query, $count = Settings::SUGGESTION_COUNT, $kwargs = [])
     {
         $url = "findById/$name";
@@ -29,6 +37,9 @@ public function findById($name, $query, $count = Settings::SUGGESTION_COUNT, $kw
         return $response["suggestions"];
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function geolocate($name, $lat, $lon, $radiusMeters = 100, $count = Settings::SUGGESTION_COUNT, $kwargs = [])
     {
         $url = "geolocate/$name";
@@ -43,6 +54,9 @@ public function geolocate($name, $lat, $lon, $radiusMeters = 100, $count = Setti
         return $response["suggestions"];
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function iplocate($ip, $kwargs = [])
     {
         $url = "iplocate/address";
@@ -52,6 +66,9 @@ public function iplocate($ip, $kwargs = [])
         return $response["location"];
     }
 
+    /**
+     * @throws GuzzleException
+     */
     public function suggest($name, $query, $count = Settings::SUGGESTION_COUNT, $kwargs = [])
     {
         $url = "suggest/$name";