code cleanup

Author: Jhut89

src/Resources/ApiResource.php

@@ -28,7 +28,8 @@ abstract class ApiResource
 
     /**
      * ApiResource constructor.
-     * @param MailchimpRequest $request
+     *
+     * @param MailchimpRequest       $request
      * @param MailchimpSettings|null $settings
      */
     public function __construct(MailchimpRequest $request, MailchimpSettings $settings = null)
@@ -75,7 +76,9 @@ public function setSettings($settings)
 
     /**
      * Makes a get request using the current request
+     *
      * @param array $query_params an array of query parameters you want to send
+     *
      * @return MailchimpResponse
      * @throws MailchimpException
      */
@@ -94,7 +97,9 @@ public function get($query_params = [])
 
     /**
      * Makes a post request using the current request
+     *
      * @param array $params the payload you want to send
+     *
      * @return MailchimpResponse
      * @throws MailchimpException
      */
@@ -112,7 +117,9 @@ public function post($params = [])
 
     /**
      * Makes a patch request using the current request
+     *
      * @param array $params the payload you want to send
+     *
      * @return MailchimpResponse
      * @throws MailchimpException
      */
@@ -130,7 +137,9 @@ public function patch($params = [])
 
     /**
      * Makes a put request using the current request
+     *
      * @param array $params the payload you want to send
+     *
      * @return MailchimpResponse
      * @throws MailchimpException
      */
@@ -168,9 +177,12 @@ public function delete()
 
     /**
      * Returns a new connection from a request and settings
-     * @param MailchimpRequest $request
+     *
+     * @param MailchimpRequest  $request
      * @param MailchimpSettings $settings
+     *
      * @return MailchimpConnection
+     * @throws MailchimpException
      */
     protected function getConnection(MailchimpRequest $request, MailchimpSettings $settings)
     {
@@ -189,8 +201,10 @@ private function resetRequest()
 
     /**
      * Throws an exception if $check evaluates false
-     * @param string $type the type of check
-     * @param mixed $check the variable under test
+     *
+     * @param string $type  the type of check
+     * @param mixed  $check the variable under test
+     *
      * @throws MailchimpException
      */
     protected function throwIfNot($type, $check)
@@ -209,8 +223,10 @@ protected function throwIfNot($type, $check)
 
     /**
      * Makes a post request to an action endpoint on an API resource
-     * @param $endpoint
+     *
+     * @param       $endpoint
      * @param array $params
+     *
      * @return MailchimpResponse
      * @throws MailchimpException
      */

src/Responses/FailureResponse.php

@@ -4,8 +4,6 @@
 namespace MailchimpAPI\Responses;
 
 
-use MailchimpAPI\MailchimpException;
-
 /**
  * Class FailureResponse
  * @package MailchimpAPI\Responses
@@ -14,9 +12,10 @@ class FailureResponse extends MailchimpResponse
 {
     /**
      * FailureResponse constructor.
-     * @param $headers
-     * @param $body
-     * @param $http_code
+     *
+     * @param array         $headers
+     * @param string        $body
+     * @param int           $http_code
      * @param callable|null $failure_callback
      */
     public function __construct($headers, $body, $http_code, callable $failure_callback = null)

src/Responses/MailchimpResponse.php

@@ -30,6 +30,7 @@ abstract class MailchimpResponse
 
     /**
      * MailchimpResponse constructor.
+     *
      * @param $headers
      * @param $body
      * @param $http_code
@@ -51,7 +52,8 @@ public function getHeaders()
     }
 
     /**
-     * Sets the headers on thsi response object
+     * Sets the headers on this response object
+     *
      * @param array $headers
      */
     public function setHeaders($headers)
@@ -70,6 +72,7 @@ public function getHttpCode()
 
     /**
      * Sets the http response code for this response object
+     *
      * @param mixed $http_code
      */
     public function setHttpCode($http_code)
@@ -78,7 +81,8 @@ public function setHttpCode($http_code)
     }
 
     /**
-     * Sets the body for this resposne object
+     * Sets the body for this response object
+     *
      * @param mixed $body
      */
     public function setBody($body)
@@ -97,13 +101,15 @@ public function getBody()
 
     /**
      * Deserializes the response body to PHP object or array
+     *
      * @param bool $to_array should we deserialize to an array
+     *
      * @return mixed
      * @throws MailchimpException when cant deserialize response
      */
     public function deserialize($to_array = false)
     {
-        $decoded = json_decode($this->body, (bool) $to_array);
+        $decoded = json_decode($this->body, (bool)$to_array);
         if (!$decoded) {
             throw new MailchimpException("Unable to deserialize response");
         }

src/Responses/SuccessResponse.php

@@ -4,8 +4,6 @@
 namespace MailchimpAPI\Responses;
 
 
-use MailchimpAPI\MailchimpException;
-
 /**
  * Class SuccessResponse
  * @package MailchimpAPI\Responses
@@ -14,9 +12,10 @@ class SuccessResponse extends MailchimpResponse
 {
     /**
      * SuccessResponse constructor.
-     * @param $headers
-     * @param $body
-     * @param $http_code
+     *
+     * @param array         $headers
+     * @param string        $body
+     * @param int           $http_code
      * @param callable|null $success_callback
      */
     public function __construct($headers, $body, $http_code, callable $success_callback = null)

src/Settings/MailchimpSettings.php

@@ -82,13 +82,15 @@ public function getCustomCurlSettings()
      */
     public function setDebug($debug)
     {
-        $this->debug = (bool) $debug;
+        $this->debug = (bool)$debug;
     }
 
     /**
      * Set the log file from an absolute path to a writable file
      * log file must already exist to be writable
+     *
      * @param null $log_file
+     *
      * @throws MailchimpException
      */
     public function setLogFile($log_file)
@@ -105,7 +107,7 @@ public function setLogFile($log_file)
      */
     public function setVerifySsl($verify_ssl)
     {
-        $this->verify_ssl = (bool) $verify_ssl;
+        $this->verify_ssl = (bool)$verify_ssl;
     }
 
     /**