Merge pull request #339 from saloonphp/feature/v3-remove-distrating-@throws

Fix | V3 - Remove Distracting @throws from PHPDocs

Author: Sammyjo20

src/Exceptions/Request/FatalRequestException.php

@@ -8,6 +8,15 @@
 use Saloon\Http\PendingRequest;
 use Saloon\Exceptions\SaloonException;
 
+/**
+ * FatalRequestException
+ *
+ * This exception is thrown when the sender encountered a problem before the API
+ * was able to respond. For example: An issue with connecting to the API or
+ * an SSL error.
+ *
+ * @see https://docs.saloon.dev/the-basics/handling-failures
+ */
 class FatalRequestException extends SaloonException
 {
     /**

src/Exceptions/Request/RequestException.php

@@ -10,6 +10,13 @@
 use Saloon\Helpers\StatusCodeHelper;
 use Saloon\Exceptions\SaloonException;
 
+/**
+ * RequestException
+ *
+ * This exception is thrown when the response from a request is a failed response.
+ *
+ * See @https://docs.saloon.dev/the-basics/handling-failures
+ */
 class RequestException extends SaloonException
 {
     /**

src/Http/PendingRequest.php

@@ -75,8 +75,6 @@ class PendingRequest
 
     /**
      * Build up the request payload.
-     *
-     * @throws \Saloon\Exceptions\DuplicatePipeNameException
      */
     public function __construct(Connector $connector, Request $request, MockClient $mockClient = null)
     {

src/Traits/Connector/SendsRequests.php

@@ -25,8 +25,6 @@ trait SendsRequests
      * Send a request synchronously
      *
      * @param callable(\Throwable, \Saloon\Http\Request): (bool)|null $handleRetry
-     * @throws \ReflectionException
-     * @throws \Throwable
      */
     public function send(Request $request, MockClient $mockClient = null, callable $handleRetry = null): Response
     {
@@ -152,8 +150,6 @@ public function sendAsync(Request $request, MockClient $mockClient = null): Prom
      * Send a synchronous request and retry if it fails
      *
      * @param callable(\Throwable, \Saloon\Http\Request): (bool)|null $handleRetry
-     * @throws \ReflectionException
-     * @throws \Throwable
      */
     public function sendAndRetry(Request $request, int $tries, int $interval = 0, callable $handleRetry = null, bool $throw = true, MockClient $mockClient = null): Response
     {
@@ -166,8 +162,6 @@ public function sendAndRetry(Request $request, int $tries, int $interval = 0, ca
 
     /**
      * Create a new PendingRequest
-     *
-     * @throws \ReflectionException
      */
     public function createPendingRequest(Request $request, MockClient $mockClient = null): PendingRequest
     {

src/Traits/ManagesExceptions.php

@@ -18,19 +18,19 @@ public function hasRequestFailed(Response $response): ?bool
     }
 
     /**
-     * Determine if we should throw an exception if the `$response->throw()` ({@see \Saloon\Http\Response::throw()})
-     * is used, or when AlwaysThrowOnErrors is used.
+     * Get the request exception.
      */
-    public function shouldThrowRequestException(Response $response): bool
+    public function getRequestException(Response $response, ?Throwable $senderException): ?Throwable
     {
-        return $response->failed();
+        return null;
     }
 
     /**
-     * Get the request exception.
+     * Determine if we should throw an exception if the `$response->throw()` is
+     * used, or when the `AlwaysThrowOnErrors` trait is used.
      */
-    public function getRequestException(Response $response, ?Throwable $senderException): ?Throwable
+    public function shouldThrowRequestException(Response $response): bool
     {
-        return null;
+        return $response->failed();
     }
 }