Merge pull request #20 from swaggest/class-pointer

Add support for PHP classes in JsonPointer

Author: vearutop

Makefile

@@ -3,7 +3,7 @@ phar:
 
 docker56-composer-update:
 	test -f ./composer.phar || wget https://getcomposer.org/composer.phar
-	docker run -v $$(pwd):/code php:5.6-cli bash -c "apt-get update;apt-get install -y unzip;cd /code;php composer.phar update --prefer-source"
+	docker run --rm -v $$(pwd):/code php:5.6-cli bash -c "apt-get update;apt-get install -y unzip;cd /code;php composer.phar update --prefer-source"
 
 docker56-test:
-	docker run -v $$(pwd):/code php:5.6-cli bash -c "cd /code;php vendor/bin/phpunit"
+	docker run --rm -v $$(pwd):/code -w /code php:5.6-cli php vendor/bin/phpunit

README.md

@@ -231,6 +231,12 @@ $patch->apply($original);
 $this->assertEquals($diff->getRearranged(), $original);
 ```
 
+## PHP Classes as JSON objects
+
+Due to magical methods and other restrictions PHP classes can not be reliably mapped to/from JSON objects.
+There is support for objects of PHP classes in `JsonPointer` with limitations:
+* `null` is equal to non-existent
+
 ## CLI tool
 
 Moved to [`swaggest/json-cli`](https://github.com/swaggest/json-cli)

composer.lock

@@ -98,7 +98,7 @@ public static function add(&$holder, $pathItems, $value, $flags = self::RECURSIV
     {
         $ref = &$holder;
         while (null !== $key = array_shift($pathItems)) {
-            if ($ref instanceof \stdClass) {
+            if ($ref instanceof \stdClass || is_object($ref)) {
                 if (PHP_VERSION_ID < 71000 && '' === $key) {
                     throw new Exception('Empty property name is not supported by PHP <7.1',
                         Exception::EMPTY_PROPERTY_NAME_UNSUPPORTED);
@@ -208,6 +208,12 @@ public static function get($holder, $pathItems)
                 } else {
                     throw new Exception('Key not found: ' . $key);
                 }
+            } elseif (is_object($ref)) {
+                if (isset($ref->$key)) {
+                    $ref = $ref->$key;
+                } else {
+                    throw new Exception('Key not found: ' . $key);
+                }
             } else {
                 throw new Exception('Key not found: ' . $key);
             }
@@ -244,6 +250,12 @@ public static function remove(&$holder, $pathItems)
                 } else {
                     throw new Exception('Key not found: ' . $key);
                 }
+            } elseif (is_object($ref)) {
+                if (isset($ref->$key)) {
+                    $ref = &$ref->$key;
+                } else {
+                    throw new Exception('Key not found: ' . $key);
+                }
             } else {
                 if (array_key_exists($key, $ref)) {
                     $ref = &$ref[$key];
@@ -254,7 +266,7 @@ public static function remove(&$holder, $pathItems)
         }
 
         if (isset($parent) && isset($refKey)) {
-            if ($parent instanceof \stdClass) {
+            if ($parent instanceof \stdClass || is_object($parent)) {
                 unset($parent->$refKey);
             } else {
                 unset($parent[$refKey]);

src/JsonPointer.php

@@ -14,7 +14,7 @@ class JsonPointerTest extends \PHPUnit_Framework_TestCase
     public function testProcess()
     {
         $json = new \stdClass();
-        JsonPointer::add($json, ['l1','l2','l3'], 'hello!');
+        JsonPointer::add($json, ['l1', 'l2', 'l3'], 'hello!');
         $this->assertSame('{"l1":{"l2":{"l3":"hello!"}}}', json_encode($json));
 
         JsonPointer::add($json, ['l1', 'l2', 'l3'], 'hello again!', JsonPointer::SKIP_IF_ISSET);
@@ -34,7 +34,7 @@ public function testProcess()
             $this->assertSame('Key not found: non-existent', $exception->getMessage());
         }
 
-        JsonPointer::remove($json, ['l1','l2']);
+        JsonPointer::remove($json, ['l1', 'l2']);
         $this->assertSame('{"l1":{}}', json_encode($json));
 
         JsonPointer::add($json, JsonPointer::splitPath('/l1/l2/0/0'), 0);
@@ -71,4 +71,61 @@ public function testBuildPath()
         $this->assertSame('#/key1/~1project~1%7Busername%7D~1%7Bproject%7D/key2',
             JsonPointer::buildPath($pathItems, true));
     }
+
+    public function testGetSetDeleteObject()
+    {
+        $s = new Sample();
+        $s->one = new Sample();
+        $s->one->two = 2;
+
+        $this->assertEquals(2, JsonPointer::get($s, ['one', 'two']));
+
+
+        JsonPointer::add($s, ['one', 'two'], 22);
+        $this->assertEquals(22, JsonPointer::get($s, ['one', 'two']));
+        $this->assertEquals(22, $s->one->two);
+
+        JsonPointer::remove($s, ['one', 'two']);
+        try {
+            JsonPointer::get($s, ['one', 'two']);
+            $this->fail('Exception expected');
+        } catch (Exception $e) {
+            $this->assertEquals('Key not found: two', $e->getMessage());
+        }
+        $this->assertEquals(null, $s->one->two);
+    }
+
+}
+
+class Sample
+{
+    public $declared;
+
+    private $_data = [];
+
+    public function __isset($name)
+    {
+        return isset($this->_data[$name]);
+    }
+
+    public function &__get($name)
+    {
+        if (array_key_exists($name, $this->_data)) {
+            return $this->_data[$name];
+        } else {
+            $tmp = null;
+            return $tmp;;
+        }
+    }
+
+    public function __set($name, $value)
+    {
+        $this->_data[$name] = $value;
+    }
+
+    public function __unset($name)
+    {
+        unset($this->_data[$name]);
+    }
+
 }