Merge pull request #24 from webmozart/empty-keys

Added support for empty properties (fixes #19)
webmozart · Aug 10, 2016 · c0696e3 · c0696e3
2 parents 51bf9f4 + 9ff9408
commit c0696e3
Show file tree

Hide file tree

Showing 4 changed files with 110 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,7 @@ Changelog
  * added support for `$ref` to external schema
  * added support for validation against `$schema` property
  * added `LocalUriRetriever`
+ * added support for empty properties before PHP 7.1
 
 * 1.2.2 (2016-01-14)
 

diff --git a/src/JsonEncoder.php b/src/JsonEncoder.php
@@ -178,6 +178,21 @@ public function encode($data, $schema = null)
             }
         }
 
+        if (PHP_VERSION_ID < 71000) {
+            // PHP before 7.1 decodes empty properties as "_empty_". Make
+            // sure the encoding of these properties works again.
+            if (is_object($data) && isset($data->{'_empty_'})) {
+                $data = (array) $data;
+            }
+
+            if (is_array($data) && isset($data['_empty_'])) {
+                // Maintain key order
+                $keys = array_keys($data);
+                $keys[array_search('_empty_', $keys, true)] = '';
+                $data = array_combine($keys, $data);
+            }
+        }
+
         if (PHP_VERSION_ID >= 50500) {
             $maxDepth = $this->maxDepth;
 

diff --git a/tests/JsonDecoderTest.php b/tests/JsonDecoderTest.php
@@ -148,6 +148,54 @@ public function testDecodeObjectAsArray()
         $this->assertEquals(array('name' => 'Bernhard'), $decoded);
     }
 
+    public function testDecodeEmptyArrayKey()
+    {
+        $data = array('' => 'Bernhard');
+
+        $this->decoder->setObjectDecoding(JsonDecoder::ASSOC_ARRAY);
+
+        $this->assertEquals($data, $this->decoder->decode('{"":"Bernhard"}'));
+    }
+
+    public function testDecodeEmptyProperty()
+    {
+        if (version_compare(PHP_VERSION, '7.1.0', '<')) {
+            $this->markTestSkipped('PHP >= 7.1.0 only');
+
+            return;
+        }
+
+        $data = (object) array('' => 'Bernhard');
+
+        $this->assertEquals($data, $this->decoder->decode('{"":"Bernhard"}'));
+    }
+
+    public function testDecodeMagicEmptyPropertyAfter71()
+    {
+        if (version_compare(PHP_VERSION, '7.1.0', '<')) {
+            $this->markTestSkipped('PHP >= 7.1.0 only');
+
+            return;
+        }
+
+        $data = (object) array('_empty_' => 'Bernhard');
+
+        $this->assertEquals($data, $this->decoder->decode('{"_empty_":"Bernhard"}'));
+    }
+
+    public function testDecodeMagicEmptyPropertyBefore71()
+    {
+        if (version_compare(PHP_VERSION, '7.1.0', '>=')) {
+            $this->markTestSkipped('PHP < 7.1.0 only');
+
+            return;
+        }
+
+        $data = (object) array('a' => 'b', '_empty_' => 'Bernhard', 'c' => 'd');
+
+        $this->assertEquals($data, $this->decoder->decode('{"a":"b","":"Bernhard","c":"d"}'));
+    }
+
     public function provideInvalidObjectDecoding()
     {
         return array(

diff --git a/tests/JsonEncoderTest.php b/tests/JsonEncoderTest.php
@@ -151,6 +151,52 @@ public function testEncodeFailsForBinaryValue()
         $this->encoder->encode(self::BINARY_INPUT);
     }
 
+    public function testEncodeEmptyArrayKey()
+    {
+        $data = array('' => 'Bernhard');
+
+        $this->assertSame('{"":"Bernhard"}', $this->encoder->encode($data));
+    }
+
+    public function testEncodeEmptyProperty()
+    {
+        if (version_compare(PHP_VERSION, '7.1.0', '<')) {
+            $this->markTestSkipped('PHP >= 7.1.0 only');
+
+            return;
+        }
+
+        $data = (object) array('' => 'Bernhard');
+
+        $this->assertSame('{"":"Bernhard"}', $this->encoder->encode($data));
+    }
+
+    public function testEncodeMagicEmptyPropertyAfter71()
+    {
+        if (version_compare(PHP_VERSION, '7.1.0', '<')) {
+            $this->markTestSkipped('PHP >= 7.1.0 only');
+
+            return;
+        }
+
+        $data = (object) array('_empty_' => 'Bernhard');
+
+        $this->assertSame('{"_empty_":"Bernhard"}', $this->encoder->encode($data));
+    }
+
+    public function testEncodeMagicEmptyPropertyBefore71()
+    {
+        if (version_compare(PHP_VERSION, '7.1.0', '>=')) {
+            $this->markTestSkipped('PHP < 7.1.0 only');
+
+            return;
+        }
+
+        $data = (object) array('a' => 'b', '_empty_' => 'Bernhard', 'c' => 'd');
+
+        $this->assertSame('{"a":"b","":"Bernhard","c":"d"}', $this->encoder->encode($data));
+    }
+
     public function testEncodeArrayAsArray()
     {
         $data = array('one', 'two');