Merge pull request #141 from bc-bfenton/cleanup

Cleanup

Author: mattolson

src/Bigcommerce/Api/Client.php

@@ -91,6 +91,8 @@ public function __construct()
     /**
      * Controls whether requests and responses should be treated
      * as XML. Defaults to false (using JSON).
+     *
+     * @param bool $option the new state of this feature
      */
     public function useXml($option = true)
     {
@@ -109,6 +111,8 @@ public function useXml($option = true)
      *
      * <p><em>Note that this doesn't use the builtin CURL_FAILONERROR option,
      * as this fails fast, making the HTTP body and headers inaccessible.</em></p>
+     *
+     * @param bool $option the new state of this feature
      */
     public function failOnError($option = true)
     {
@@ -117,6 +121,9 @@ public function failOnError($option = true)
 
     /**
      * Sets the HTTP basic authentication.
+     *
+     * @param string $username
+     * @param string $password
      */
     public function authenticate($username, $password)
     {
@@ -137,6 +144,9 @@ public function setTimeout($timeout)
 
     /**
      * Set a proxy server for outgoing requests to tunnel through.
+     *
+     * @param string $server
+     * @param int|bool $port optional port number
      */
     public function useProxy($server, $port = false)
     {
@@ -249,7 +259,7 @@ public function getLastError()
     }
 
     /**
-     * Recursively follow redirect until an OK response is recieved or
+     * Recursively follow redirect until an OK response is received or
      * the maximum redirects limit is reached.
      *
      * Only 301 and 302 redirects are handled. Redirects from POST and PUT requests will
@@ -260,9 +270,7 @@ private function followRedirectPath()
         $this->redirectsFollowed++;
 
         if ($this->getStatus() == 301 || $this->getStatus() == 302) {
-
             if ($this->redirectsFollowed < $this->maxRedirects) {
-
                 $location = $this->getHeader('Location');
                 $forwardTo = parse_url($location);
 
@@ -286,6 +294,11 @@ private function followRedirectPath()
 
     /**
      * Make an HTTP GET request to the specified endpoint.
+     *
+     * @param string $url URL to retrieve
+     * @param array|bool $query Optional array of query string parameters
+     *
+     * @return mixed
      */
     public function get($url, $query = false)
     {
@@ -305,6 +318,11 @@ public function get($url, $query = false)
 
     /**
      * Make an HTTP POST request to the specified endpoint.
+     *
+     * @param string $url URL to which we send the request
+     * @param mixed $body Data payload (JSON string or raw data)
+     *
+     * @return mixed
      */
     public function post($url, $body)
     {
@@ -328,8 +346,8 @@ public function post($url, $body)
     /**
      * Make an HTTP HEAD request to the specified endpoint.
      *
-     * @param $url
-     * @return bool|mixed|string
+     * @param string $url URL to which we send the request
+     * @return mixed
      */
     public function head($url)
     {
@@ -349,9 +367,9 @@ public function head($url)
      * Requires a tmpfile() handle to be opened on the system, as the cURL
      * API requires it to send data.
      *
-     * @param $url
-     * @param $body
-     * @return bool|mixed|string
+     * @param string $url URL to which we send the request
+     * @param mixed $body Data payload (JSON string or raw data)
+     * @return mixed
      */
     public function put($url, $body)
     {
@@ -383,8 +401,8 @@ public function put($url, $body)
     /**
      * Make an HTTP DELETE request to the specified endpoint.
      *
-     * @param $url
-     * @return bool|mixed|string
+     * @param string $url URL to which we send the request
+     * @return mixed
      */
     public function delete($url)
     {
@@ -400,8 +418,8 @@ public function delete($url)
     /**
      * Method that appears unused, but is in fact called by curl
      *
-     * @param $curl
-     * @param $body
+     * @param resource $curl
+     * @param string $body
      * @return int
      */
     private function parseBody($curl, $body)
@@ -413,8 +431,8 @@ private function parseBody($curl, $body)
     /**
      * Method that appears unused, but is in fact called by curl
      *
-     * @param $curl
-     * @param $headers
+     * @param resource $curl
+     * @param string $headers
      * @return int
      */
     private function parseHeader($curl, $headers)
@@ -432,6 +450,8 @@ private function parseHeader($curl, $headers)
 
     /**
      * Access the status code of the response.
+     *
+     * @return mixed
      */
     public function getStatus()
     {
@@ -440,6 +460,8 @@ public function getStatus()
 
     /**
      * Access the message string from the status line of the response.
+     *
+     * @return string
      */
     public function getStatusMessage()
     {
@@ -448,6 +470,8 @@ public function getStatusMessage()
 
     /**
      * Access the content body of the response
+     *
+     * @return string
      */
     public function getBody()
     {
@@ -456,6 +480,8 @@ public function getBody()
 
     /**
      * Access given header from the response.
+     *
+     * @return string|void
      */
     public function getHeader($header)
     {

src/Bigcommerce/Api/Connection.php

@@ -7,5 +7,4 @@
  */
 class NetworkError extends Error
 {
-
-}
+}

src/Bigcommerce/Api/NetworkError.php

@@ -5,8 +5,7 @@
 class Resource
 {
     /**
-     *
-     * @var stdclass
+     * @var \stdClass
      */
     protected $fields;
 
@@ -72,7 +71,7 @@ public function getCreateFields()
         $resource = $this->fields;
 
         foreach ($this->ignoreOnCreate as $field) {
-            if (isset($resource->$field)) unset($resource->$field);
+            unset($resource->$field);
         }
 
         return $resource;
@@ -83,23 +82,31 @@ public function getUpdateFields()
         $resource = $this->fields;
 
         foreach ($this->ignoreOnUpdate as $field) {
-            if (isset($resource->$field)) unset($resource->$field);
+            unset($resource->$field);
         }
 
         foreach ($resource as $field => $value) {
-            if ($this->isIgnoredField($field, $value)) unset($resource->$field);
+            if ($this->isIgnoredField($field, $value)) {
+                unset($resource->$field);
+            }
         }
 
         return $resource;
     }
 
     private function isIgnoredField($field, $value)
     {
-        if ($value === null) return true;
+        if ($value === null) {
+            return true;
+        }
 
-        if ((strpos($field, "date") !== FALSE) && $value === "") return true;
+        if (strpos($field, "date") !== false && $value === "") {
+            return true;
+        }
 
-        if (in_array($field, $this->ignoreIfZero) && $value === 0) return true;
+        if (in_array($field, $this->ignoreIfZero, true) && $value === 0) {
+            return true;
+        }
 
         return false;
     }

src/Bigcommerce/Api/Resource.php

@@ -7,5 +7,4 @@
  */
 class ServerError extends Error
 {
-
-}
+}