PHPDoc

Author: ivan770

src/Buildable.php

@@ -23,42 +23,85 @@ protected function returnAndResetBuilderState()
         return $request;
     }
 
+    /**
+     * Add authentication to request
+     *
+     * @param string $type Authentication type
+     * @param array|string $credentials Authentication credentials
+     * @return $this
+     */
     public function auth($type, $credentials)
     {
         $this->applyRequestOptions([$type => $credentials]);
         return $this;
     }
 
+    /**
+     * Add HTTP basic auth to request
+     *
+     * @param array|string $credentials "Authentication credentials"
+     * @return $this
+     */
     public function authBasic($credentials)
     {
         $this->applyRequestOptions(["auth_basic" => $credentials]);
         return $this;
     }
 
+    /**
+     * Add Bearer token to request
+     *
+     * @param string $credentials "Bearer token"
+     * @return $this
+     */
     public function authBearer($credentials)
     {
         $this->applyRequestOptions(["auth_bearer" => $credentials]);
         return $this;
     }
 
+    /**
+     * Add headers to request
+     *
+     * @param array $headers Headers
+     * @return $this
+     */
     public function headers($headers)
     {
         $this->applyRequestOptions(["headers" => $headers]);
         return $this;
     }
 
+    /**
+     * Add body to request
+     *
+     * @param array|string|resource|\Traversable|\Closure $body Request body
+     * @return $this
+     */
     public function body($body)
     {
         $this->applyRequestOptions(["body" => $body]);
         return $this;
     }
 
+    /**
+     * Add JSON to request
+     *
+     * @param array|\JsonSerializable $json JSON-compatible value
+     * @return $this
+     */
     public function json($json)
     {
         $this->applyRequestOptions(["json" => $json]);
         return $this;
     }
 
+    /**
+     * Add query string values to request
+     *
+     * @param array $query Query string values
+     * @return $this
+     */
     public function query($query)
     {
         $this->applyRequestOptions(["query" => $query]);

src/HttpClient.php

@@ -6,11 +6,11 @@
 use Symfony\Component\HttpClient\HttpClient as Client;
 
 /**
- * @method get(string $url, array $arguments) Send a GET request
- * @method head(string $url, array $arguments) Send a HEAD request
- * @method post(string $url, array $arguments) Send a POST request
- * @method put(string $url, array $arguments) Send a PUT request
- * @method delete(string $url, array $arguments) Send a DELETE request
+ * @method Response get(string $url, array $arguments) Send a GET request
+ * @method Response head(string $url, array $arguments) Send a HEAD request
+ * @method Response post(string $url, array $arguments) Send a POST request
+ * @method Response put(string $url, array $arguments) Send a PUT request
+ * @method Response delete(string $url, array $arguments) Send a DELETE request
  */
 class HttpClient
 {

src/Response.php

@@ -4,6 +4,12 @@
 
 use Symfony\Component\HttpClient\Exception\JsonException;
 
+/**
+ * @method int getStatusCode() Get response status code
+ * @method array getHeaders(bool $throw = true) Get response headers
+ * @method array toArray(bool $throw = true) Get array from response
+ * @method array|mixed|null getInfo(string $type = null) Get info from transport layer
+ */
 class Response
 {
     protected $baseResponse;
@@ -23,6 +29,12 @@ public function toCollection()
         return collect($this->baseResponse->toArray());
     }
 
+    /**
+     * Get body of response, or collection, if response is JSON-compatible
+     *
+     * @param bool $throw
+     * @return \Illuminate\Support\Collection|string
+     */
     public function getContent($throw = true)
     {
         try {