add nullable option for json visitor

schmittjoh · Sep 21, 2012 · 8cb1e3c · 8cb1e3c
1 parent 4880923
commit 8cb1e3c
Show file tree

Hide file tree

Showing 8 changed files with 58 additions and 3 deletions.
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -115,6 +115,7 @@ private function addVisitorsSection(NodeBuilder $builder)
                     ->arrayNode('json')
                         ->addDefaultsIfNotSet()
                         ->children()
+                            ->booleanNode('serialize_null')->defaultFalse()->end()
                             ->scalarNode('options')
                                 ->defaultValue(0)
                                 ->beforeNormalization()

diff --git a/DependencyInjection/JMSSerializerExtension.php b/DependencyInjection/JMSSerializerExtension.php
@@ -149,6 +149,10 @@ public function loadInternal(array $config, ContainerBuilder $container)
         $container
             ->setParameter('jms_serializer.json_serialization_visitor.options', $config['visitors']['json']['options'])
         ;
+
+        $container
+            ->setParameter('jms_serializer.json_serialization_visitor.serialize_null', $config['visitors']['json']['serialize_null'])
+        ;
     }
 
     public function getConfiguration(array $config, ContainerBuilder $container)

diff --git a/Resources/config/services.xml b/Resources/config/services.xml
@@ -131,6 +131,9 @@
             <call method="setOptions">
                 <argument>%jms_serializer.json_serialization_visitor.options%</argument>
             </call>
+            <call method="setNullable">
+                <argument>%jms_serializer.json_serialization_visitor.serialize_null%</argument>
+            </call>
             <tag name="jms_serializer.serialization_visitor" format="json" />
         </service>
         <service id="jms_serializer.json_deserialization_visitor" class="%jms_serializer.json_deserialization_visitor.class%" public="false">

diff --git a/Serializer/GenericSerializationVisitor.php b/Serializer/GenericSerializationVisitor.php
@@ -90,7 +90,7 @@ public function visitArray($data, $type)
         foreach ($data as $k => $v) {
             $v = $this->navigator->accept($v, null, $this);
 
-            if (null === $v) {
+            if (null === $v && (!is_string($k) || !$this->isNullable())) {
                 continue;
             }
 
@@ -133,7 +133,7 @@ public function visitProperty(PropertyMetadata $metadata, $data)
                 : $data->{$metadata->getter}());
 
         $v = $this->navigator->accept($v, null, $this);
-        if (null === $v) {
+        if (null === $v && !$this->isNullable()) {
             return;
         }
 

diff --git a/Serializer/JsonSerializationVisitor.php b/Serializer/JsonSerializationVisitor.php
@@ -21,6 +21,7 @@
 class JsonSerializationVisitor extends GenericSerializationVisitor
 {
     private $options = 0;
+    private $nullable = false;
 
     public function getResult()
     {
@@ -36,4 +37,14 @@ public function setOptions($options)
     {
         $this->options = (integer) $options;
     }
+
+    public function setNullable($allowNull)
+    {
+        $this->nullable = (bool) $allowNull;
+    }
+
+    public function isNullable()
+    {
+        return (bool) $this->nullable;
+    }
 }
diff --git a/Tests/Fixtures/ObjectWithNullProperty.php b/Tests/Fixtures/ObjectWithNullProperty.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace JMS\SerializerBundle\Tests\Fixtures;
+
+use JMS\SerializerBundle\Tests\Fixtures\SimpleObject;
+
+class ObjectWithNullProperty extends SimpleObject
+{
+    private $nullProperty = null;
+}
diff --git a/Tests/Serializer/BaseSerializationTest.php b/Tests/Serializer/BaseSerializationTest.php
@@ -60,6 +60,7 @@
 use JMS\SerializerBundle\Tests\Fixtures\Order;
 use JMS\SerializerBundle\Tests\Fixtures\Price;
 use JMS\SerializerBundle\Tests\Fixtures\SimpleObject;
+use JMS\SerializerBundle\Tests\Fixtures\ObjectWithNullProperty;
 use JMS\SerializerBundle\Tests\Fixtures\SimpleObjectProxy;
 use Metadata\MetadataFactory;
 use Symfony\Component\Form\Form;
@@ -70,6 +71,24 @@
 
 abstract class BaseSerializationTest extends \PHPUnit_Framework_TestCase
 {
+    public function testNullableArray()
+    {
+        if ($this->getFormat() !== 'json') {
+            $this->markTestSkipped('nullable currently only supported by JSON');
+        }
+        $arr = array('foo' => 'bar', 'baz' => null, null);
+        $this->assertEquals($this->getContent('nullable'), $this->getSerializer(true)->serialize($arr, $this->getFormat()));
+    }
+
+    public function testNullableObject()
+    {
+        if ($this->getFormat() !== 'json') {
+            $this->markTestSkipped('nullable currently only supported by JSON');
+        }
+        $obj = new ObjectWithNullProperty('foo', 'bar');
+        $this->assertEquals($this->getContent('simple_object_nullable'), $this->getSerializer(true)->serialize($obj, $this->getFormat()));
+    }
+
     public function testString()
     {
         $this->assertEquals($this->getContent('string'), $this->serialize('foo'));
@@ -476,7 +495,7 @@ protected function deserialize($content, $type)
         return $this->getSerializer()->deserialize($content, $type, $this->getFormat());
     }
 
-    protected function getSerializer()
+    protected function getSerializer($serialize_null = false)
     {
         $factory = new MetadataFactory(new AnnotationDriver(new AnnotationReader()));
         $namingStrategy = new SerializedNameAnnotationStrategy(new CamelCaseNamingStrategy());
@@ -490,6 +509,11 @@ protected function getSerializer()
             'xml'  => new XmlSerializationVisitor($namingStrategy, $customSerializationHandlers),
             'yml'  => new YamlSerializationVisitor($namingStrategy, $customSerializationHandlers),
         );
+
+        if ($serialize_null) {
+            $serializationVisitors['json']->setNullable(true);
+        }
+
         $deserializationVisitors = array(
             'json' => new JsonDeserializationVisitor($namingStrategy, $customDeserializationHandlers, $objectConstructor),
             'xml'  => new XmlDeserializationVisitor($namingStrategy, $customDeserializationHandlers, $objectConstructor),

diff --git a/Tests/Serializer/JsonSerializationTest.php b/Tests/Serializer/JsonSerializationTest.php
@@ -68,6 +68,8 @@ protected function getContent($key)
             $outputs['virtual_properties_low'] = '{"low":1}';
             $outputs['virtual_properties_high'] = '{"high":8}';
             $outputs['virtual_properties_all'] = '{"low":1,"high":8}';
+            $outputs['nullable'] = '{"foo":"bar","baz":null}';
+            $outputs['simple_object_nullable'] = '{"foo":"foo","moo":"bar","camel_case":"boo","null_property":null}';
         }
 
         if (!isset($outputs[$key])) {