Return rate-limit info as object when returnformat=object

Author: mynetx

CHANGELOG

@@ -15,6 +15,7 @@ codebird-php - changelog
 + #120 Support Ads API
 + Support WebP media format
 + Fixes for non-multipart media uploads, see #141
++ Return rate-limiting info as object, when return format = object
 
 2.7.2 (2015-09-23)
 - #135 Invalid HTTP request headers in non-cURL mode

src/codebird.php

@@ -1312,18 +1312,22 @@ protected function _parseBearerReply($result, $httpstatus)
    *
    * @param array $headers The CURL response headers
    *
-   * @return null|array The rate-limiting information
+   * @return null|array|object The rate-limiting information
    */
   protected function _getRateLimitInfo($headers)
   {
     if (! isset($headers['x-rate-limit-limit'])) {
       return null;
     }
-    return [
+    $rate = [
       'limit'     => $headers['x-rate-limit-limit'],
       'remaining' => $headers['x-rate-limit-remaining'],
       'reset'     => $headers['x-rate-limit-reset']
     ];
+    if ($this->_return_format === CODEBIRD_RETURNFORMAT_OBJECT) {
+      return (object) $rate;
+    }
+    return $rate;
   }
 
   /**
@@ -1698,7 +1702,7 @@ protected function _getMultipartRequestFromParams($method_template, $border, $pa
    *
    * @param string $method_template The method template to call
    * @param string $key             The parameter name
-   * @param array  $value           The possible file name or URL
+   * @param string $value           The possible file name or URL
    *
    * @return mixed
    */
@@ -2034,16 +2038,7 @@ protected function _callApiCurl(
     $reply                 = $this->_parseApiReply($reply);
     $rate                  = $this->_getRateLimitInfo($headers);
 
-    switch ($this->_return_format) {
-      case CODEBIRD_RETURNFORMAT_ARRAY:
-        $reply['httpstatus'] = $httpstatus;
-        $reply['rate']       = $rate;
-        break;
-      case CODEBIRD_RETURNFORMAT_OBJECT:
-        $reply->httpstatus = $httpstatus;
-        $reply->rate       = $rate;
-        break;
-    }
+    $reply = $this->_appendHttpStatusAndRate($reply, $httpstatus, $rate);
     return $reply;
   }
 
@@ -2111,16 +2106,8 @@ protected function _callApiNoCurl(
     $reply                 = $this->_parseApiReplyPrefillHeaders($headers, $reply);
     $reply                 = $this->_parseApiReply($reply);
     $rate                  = $this->_getRateLimitInfo($headers);
-    switch ($this->_return_format) {
-      case CODEBIRD_RETURNFORMAT_ARRAY:
-        $reply['httpstatus'] = $httpstatus;
-        $reply['rate']       = $rate;
-        break;
-      case CODEBIRD_RETURNFORMAT_OBJECT:
-        $reply->httpstatus = $httpstatus;
-        $reply->rate       = $rate;
-        break;
-    }
+
+    $reply = $this->_appendHttpStatusAndRate($reply, $httpstatus, $rate);
     return $reply;
   }
 
@@ -2213,6 +2200,34 @@ protected function _callApiPreparationsPost(
     return [$authorization, $params, $request_headers];
   }
 
+  /**
+   * Appends HTTP status and rate limiting info to the reply
+   *
+   * @param array|object $reply      The reply to append to
+   * @param string       $httpstatus The HTTP status code to append
+   * @param mixed        $rate       The rate limiting info to append
+   */
+  protected function _appendHttpStatusAndRate($reply, $httpstatus, $rate)
+  {
+    switch ($this->_return_format) {
+      case CODEBIRD_RETURNFORMAT_ARRAY:
+        $reply['httpstatus'] = $httpstatus;
+        $reply['rate']       = $rate;
+        break;
+      case CODEBIRD_RETURNFORMAT_OBJECT:
+        $reply->httpstatus = $httpstatus;
+        $reply->rate       = $rate;
+        break;
+      case CODEBIRD_RETURNFORMAT_JSON:
+        $reply             = json_decode($reply);
+        $reply->httpstatus = $httpstatus;
+        $reply->rate       = $rate;
+        $reply             = json_encode($reply);
+        break;
+    }
+    return $reply;
+  }
+
   /**
    * Get Bearer authorization string
    *