Merge pull request #33 from zumba/undeclared-property-mode

Allowing to change the undeclared property unserialization mode

Author: jrbasso

.travis.yml

@@ -17,4 +17,4 @@ script:
   - if [ $TRAVIS_PHP_VERSION = '7.0' ]; then vendor/bin/phpunit --coverage-clover build/logs/clover.xml; else vendor/bin/phpunit; fi
 
 after_success:
-  - if [ $TRAVIS_PHP_VERSION = '7.0' ]; then php vendor/bin/coveralls; fi
+  - if [ $TRAVIS_PHP_VERSION = '7.0' ]; then php vendor/bin/php-coveralls; fi

src/JsonSerializer/JsonSerializer.php

@@ -2,6 +2,7 @@
 
 namespace Zumba\JsonSerializer;
 
+use InvalidArgumentException;
 use ReflectionClass;
 use ReflectionException;
 use SplObjectStorage;
@@ -20,6 +21,10 @@ class JsonSerializer
     const KEY_UTF8ENCODED = 1;
     const VALUE_UTF8ENCODED = 2;
 
+    const UNDECLARED_PROPERTY_MODE_SET = 1;
+    const UNDECLARED_PROPERTY_MODE_IGNORE = 2;
+    const UNDECLARED_PROPERTY_MODE_EXCEPTION = 3;
+
     /**
      * Storage for object
      *
@@ -64,6 +69,13 @@ class JsonSerializer
      */
     protected $customObjectSerializerMap;
 
+    /**
+     * Undefined Attribute Mode
+     *
+     * @var integer
+     */
+    protected $undefinedAttributeMode = self::UNDECLARED_PROPERTY_MODE_SET;
+
     /**
      * Constructor.
      *
@@ -200,6 +212,27 @@ public function unserialize($value)
         return $this->unserializeData($data);
     }
 
+    /**
+     * Set unserialization mode for undeclared class properties
+     *
+     * @param integer $value One of the JsonSerializer::UNDECLARED_PROPERTY_MODE_*
+     * @return self
+     * @throws InvalidArgumentException When the value is not one of the UNDECLARED_PROPERTY_MODE_* options
+     */
+    public function setUnserializeUndeclaredPropertyMode($value)
+    {
+        $availableOptions = [
+            static::UNDECLARED_PROPERTY_MODE_SET,
+            static::UNDECLARED_PROPERTY_MODE_IGNORE,
+            static::UNDECLARED_PROPERTY_MODE_EXCEPTION
+        ];
+        if (!in_array($value, $availableOptions)) {
+            throw new InvalidArgumentException('Invalid value.');
+        }
+        $this->undefinedAttributeMode = $value;
+        return $this;
+    }
+
     /**
      * Parse the data to be json encoded
      *
@@ -431,7 +464,16 @@ protected function unserializeObject($value)
                 $propRef->setAccessible(true);
                 $propRef->setValue($obj, $this->unserializeData($propertyValue));
             } catch (ReflectionException $e) {
-                $obj->$property = $this->unserializeData($propertyValue);
+                switch ($this->undefinedAttributeMode) {
+                case static::UNDECLARED_PROPERTY_MODE_SET:
+                    $obj->$property = $this->unserializeData($propertyValue);
+                    break;
+                case static::UNDECLARED_PROPERTY_MODE_IGNORE:
+                    break;
+                case static::UNDECLARED_PROPERTY_MODE_EXCEPTION:
+                    throw new JsonSerializerException('Undefined attribute detected during unserialization');
+                    break;
+                }
             }
         }
         if (method_exists($obj, '__wakeup')) {

tests/JsonSerializerTest.php

@@ -375,6 +375,66 @@ public function testSerializationUndeclaredProperties()
         $this->assertSame('value', $obj->sub->key);
     }
 
+    /**
+     * Test undeclared properties setter (valid)
+     *
+     * @return void
+     */
+    public function testSetUnserializeUndeclaredPropertyModeValid() {
+        $value = $this->serializer->setUnserializeUndeclaredPropertyMode(JsonSerializer::UNDECLARED_PROPERTY_MODE_SET);
+        $this->assertSame($value, $this->serializer);
+    }
+
+    /**
+     * Test undeclared properties setter (invalid)
+     *
+     * @return void
+     */
+    public function testSetUnserializeUndeclaredPropertyModeInvalid() {
+        $this->setExpectedException('InvalidArgumentException');
+        $value = $this->serializer->setUnserializeUndeclaredPropertyMode('bad value');
+    }
+
+    /**
+     * Test unserialization of undeclared properties in SET mode
+     *
+     * @return void
+     */
+    public function testUnserializeUndeclaredPropertySet() {
+        $this->serializer->setUnserializeUndeclaredPropertyMode(JsonSerializer::UNDECLARED_PROPERTY_MODE_SET);
+
+        $serialized = '{"@type":"stdClass","sub":{"@type":"stdClass","key":"value"}}';
+        $obj = $this->serializer->unserialize($serialized);
+        $this->assertInstanceOf('stdClass', $obj->sub);
+        $this->assertSame('value', $obj->sub->key);
+    }
+
+    /**
+     * Test unserialization of undeclared properties in IGNORE mode
+     *
+     * @return void
+     */
+    public function testUnserializeUndeclaredPropertyIgnore() {
+        $this->serializer->setUnserializeUndeclaredPropertyMode(JsonSerializer::UNDECLARED_PROPERTY_MODE_IGNORE);
+
+        $serialized = '{"@type":"stdClass","sub":{"@type":"stdClass","key":"value"}}';
+        $obj = $this->serializer->unserialize($serialized);
+        $this->assertFalse(isset($obj->sub));
+    }
+
+    /**
+     * Test unserialization of undeclared properties in EXCEPTION mode
+     *
+     * @return void
+     */
+    public function testUnserializeUndeclaredPropertyException() {
+        $this->serializer->setUnserializeUndeclaredPropertyMode(JsonSerializer::UNDECLARED_PROPERTY_MODE_EXCEPTION);
+
+        $this->setExpectedException('Zumba\Exception\JsonSerializerException');
+        $serialized = '{"@type":"stdClass","sub":{"@type":"stdClass","key":"value"}}';
+        $obj = $this->serializer->unserialize($serialized);
+    }
+
     /**
      * Test serialize with recursion
      *