Merge pull request #7 from php-http/refine-phpdoc

Refine PHPDoc

Author: GeLoLabs

src/HttpAdapter.php

@@ -11,6 +11,7 @@
 
 namespace Http\Adapter;
 
+use Psr\Http\Message\StreamInterface;
 use Psr\Http\Message\UriInterface;
 use Psr\Http\Message\ResponseInterface;
 
@@ -25,7 +26,8 @@ interface HttpAdapter extends PsrHttpAdapter
      * @param string|UriInterface $uri
      * @param string[]            $headers
      *
-     * @throws HttpAdapterException If an error occurred.
+     * @throws \InvalidArgumentException
+     * @throws HttpAdapterException
      *
      * @return ResponseInterface
      */
@@ -37,7 +39,8 @@ public function get($uri, array $headers = []);
      * @param string|UriInterface $uri
      * @param string[]            $headers
      *
-     * @throws HttpAdapterException If an error occurred.
+     * @throws \InvalidArgumentException
+     * @throws HttpAdapterException
      *
      * @return ResponseInterface
      */
@@ -49,7 +52,8 @@ public function head($uri, array $headers = []);
      * @param string|UriInterface $uri
      * @param string[]            $headers
      *
-     * @throws HttpAdapterException If an error occurred.
+     * @throws \InvalidArgumentException
+     * @throws HttpAdapterException
      *
      * @return ResponseInterface
      */
@@ -58,12 +62,13 @@ public function trace($uri, array $headers = []);
     /**
      * Sends a POST request
      *
-     * @param string|UriInterface $uri
-     * @param string[]            $headers
-     * @param array|string        $data
-     * @param array               $files
+     * @param string|UriInterface          $uri
+     * @param string[]                     $headers
+     * @param array|string|StreamInterface $data
+     * @param array                        $files
      *
-     * @throws HttpAdapterException If an error occurred.
+     * @throws \InvalidArgumentException
+     * @throws HttpAdapterException
      *
      * @return ResponseInterface
      */
@@ -72,12 +77,13 @@ public function post($uri, array $headers = [], $data = [], array $files = []);
     /**
      * Sends a PUT request
      *
-     * @param string|UriInterface $uri
-     * @param string[]            $headers
-     * @param array|string        $data
-     * @param array               $files
+     * @param string|UriInterface          $uri
+     * @param string[]                     $headers
+     * @param array|string|StreamInterface $data
+     * @param array                        $files
      *
-     * @throws HttpAdapterException If an error occurred.
+     * @throws \InvalidArgumentException
+     * @throws HttpAdapterException
      *
      * @return ResponseInterface
      */
@@ -86,12 +92,13 @@ public function put($uri, array $headers = [], $data = [], array $files = []);
     /**
      * Sends a PATCH request
      *
-     * @param string|UriInterface $uri
-     * @param string[]            $headers
-     * @param array|string        $data
-     * @param array               $files
+     * @param string|UriInterface          $uri
+     * @param string[]                     $headers
+     * @param array|string|StreamInterface $data
+     * @param array                        $files
      *
-     * @throws HttpAdapterException If an error occurred.
+     * @throws \InvalidArgumentException
+     * @throws HttpAdapterException
      *
      * @return ResponseInterface
      */
@@ -100,12 +107,13 @@ public function patch($uri, array $headers = [], $data = [], array $files = []);
     /**
      * Sends a DELETE request
      *
-     * @param string|UriInterface $uri
-     * @param string[]            $headers
-     * @param array|string        $data
-     * @param array               $files
+     * @param string|UriInterface          $uri
+     * @param string[]                     $headers
+     * @param array|string|StreamInterface $data
+     * @param array                        $files
      *
-     * @throws HttpAdapterException If an error occurred.
+     * @throws \InvalidArgumentException
+     * @throws HttpAdapterException
      *
      * @return ResponseInterface
      */
@@ -114,12 +122,13 @@ public function delete($uri, array $headers = [], $data = [], array $files = [])
     /**
      * Sends an OPTIONS request
      *
-     * @param string|UriInterface $uri
-     * @param string[]            $headers
-     * @param array|string        $data
-     * @param array               $files
+     * @param string|UriInterface          $uri
+     * @param string[]                     $headers
+     * @param array|string|StreamInterface $data
+     * @param array                        $files
      *
-     * @throws HttpAdapterException If an error occurred.
+     * @throws \InvalidArgumentException
+     * @throws HttpAdapterException
      *
      * @return ResponseInterface
      */
@@ -128,13 +137,14 @@ public function options($uri, array $headers = [], $data = [], array $files = []
     /**
      * Sends a request
      *
-     * @param string              $method
-     * @param string|UriInterface $uri
-     * @param string[]            $headers
-     * @param array|string        $data
-     * @param array               $files
+     * @param string                       $method
+     * @param string|UriInterface          $uri
+     * @param string[]                     $headers
+     * @param array|string|StreamInterface $data
+     * @param array                        $files
      *
-     * @throws HttpAdapterException If an error occurred.
+     * @throws \InvalidArgumentException
+     * @throws HttpAdapterException
      *
      * @return ResponseInterface
      */

src/PsrHttpAdapter.php

@@ -26,7 +26,8 @@ interface PsrHttpAdapter
      *
      * @return ResponseInterface
      *
-     * @throws HttpAdapterException If an error occurred.
+     * @throws \InvalidArgumentException
+     * @throws HttpAdapterException
      */
     public function sendRequest(RequestInterface $request);
 
@@ -37,7 +38,8 @@ public function sendRequest(RequestInterface $request);
      *
      * @return ResponseInterface[]
      *
-     * @throws MultiHttpAdapterException If an error occurred.
+     * @throws \InvalidArgumentException
+     * @throws MultiHttpAdapterException
      */
     public function sendRequests(array $requests);