minor #10427 [Serializer] Add an option to skip null values (dunglas)

javiereguiluz · javiereguiluz · commit 9e6cab0859d1 · 2018-10-03T08:41:49.000+02:00
This PR was merged into the master branch. Discussion ---------- [Serializer] Add an option to skip null values symfony/symfony#28661 Commits ------- 6349bd3 [Serializer] Add an option to skip null values
diff --git a/components/serializer.rst b/components/serializer.rst
@@ -754,6 +754,25 @@ This encoder requires the :doc:`Yaml Component </components/yaml>` and
 transforms from and to Yaml.
 
 
+Skipping ``null`` Values
+------------------------
+
+By default, the Serializer will preserve properties containing a ``null`` value.
+You can change this behavior by setting the ``skip_null_values`` context option
+to ``true``::
+
+    $dummy = new class {
+        public $foo;
+        public $bar = 'notNull';
+    };
+
+    $normalizer = new ObjectNormalizer();
+    $result = $normalizer->normalize($dummy, 'json', ['skip_null_values' => true]);
+    // ['bar' => 'notNull']
+
+.. versionadded:: 4.2
+    The ``skip_null_values`` option was introduced in Symfony 4.2.
+
 .. _component-serializer-handling-circular-references:
 
 Handling Circular References
