Ignore null values in params

stripe · Sep 25, 2018 · cf172a6 · cf172a6
1 parent 7363430
commit cf172a6
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 0 deletions.
diff --git a/lib/HttpClient/CurlClient.php b/lib/HttpClient/CurlClient.php
@@ -127,6 +127,8 @@ public function request($method, $absUrl, $headers, $params, $hasFile)
             $opts = $this->defaultOptions;
         }
 
+        $params = Util\Util::objectsToIds($params);
+
         if ($method == 'get') {
             if ($hasFile) {
                 throw new Error\Api(

diff --git a/lib/Util/Util.php b/lib/Util/Util.php
@@ -206,6 +206,38 @@ public static function secureCompare($a, $b)
         }
     }
 
+    /**
+     * Recursively goes through an array of parameters. If a parameter is an instance of
+     * ApiResource, then it is replaced by the resource's ID.
+     * Also clears out null values.
+     *
+     * @param mixed $h
+     * @return mixed
+     */
+    public static function objectsToIds($h)
+    {
+        if ($h instanceof \Stripe\ApiResource) {
+            return $h->id;
+        } elseif (static::isList($h)) {
+            $results = [];
+            foreach ($h as $v) {
+                array_push($results, static::objectsToIds($v));
+            }
+            return $results;
+        } elseif (is_array($h)) {
+            $results = [];
+            foreach ($h as $k => $v) {
+                if (is_null($v)) {
+                    continue;
+                }
+                $results[$k] = static::objectsToIds($v);
+            }
+            return $results;
+        } else {
+            return $h;
+        }
+    }
+
     /**
      * @param array $params
      *

diff --git a/tests/Stripe/Util/UtilTest.php b/tests/Stripe/Util/UtilTest.php
@@ -46,6 +46,26 @@ public function testUtf8()
         $this->assertSame(Util\Util::utf8($x), $x);
     }
 
+    public function testObjectsToIds()
+    {
+        $params = [
+            'foo' => 'bar',
+            'customer' => Util\Util::convertToStripeObject([
+                'id' => 'cus_123',
+                'object' => 'customer',
+            ], null),
+            'null_value' => null,
+        ];
+
+        $this->assertSame(
+            [
+                'foo' => 'bar',
+                'customer' => 'cus_123',
+            ],
+            Util\Util::objectsToIds($params)
+        );
+    }
+
     public function testEncodeParameters()
     {
         $params = [