minor #34340 Allow returning null from NormalizerInterface::normalize (teohhanhui)

nicolas-grekas · nicolas-grekas · commit 53dc7818142e · 2019-11-13T08:26:33.000+01:00
This PR was merged into the 3.4 branch. Discussion ---------- Allow returning null from NormalizerInterface::normalize | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes? | New feature? | no | Deprecations? | no | Tickets | N/A | License | MIT | Doc PR | N/A Looking at the code, it seems that a normalizer might be called with a `null` value for `$data`, and thus it's only sensible that it be allowed to return `null` too: https://github.com/symfony/symfony/blob/7064ff35f2539e2c915257a50eb37839b485dbeb/src/Symfony/Component/Serializer/Serializer.php#L141-L148 Updating the phpdoc to match. Commits ------- 1c8edc5 Allow returning null from NormalizerInterface::normalize
diff --git a/src/Symfony/Component/Serializer/Normalizer/NormalizerInterface.php b/src/Symfony/Component/Serializer/Normalizer/NormalizerInterface.php
@@ -30,9 +30,9 @@ interface NormalizerInterface
      * @param string $format  Format the normalization result will be encoded as
      * @param array  $context Context options for the normalizer
      *
-     * @return array|string|int|float|bool
+     * @return array|string|int|float|bool|null
      *
-     * @throws InvalidArgumentException   Occurs when the object given is not an attempted type for the normalizer
+     * @throws InvalidArgumentException   Occurs when the object given is not a supported type for the normalizer
      * @throws CircularReferenceException Occurs when the normalizer detects a circular reference when no circular
      *                                    reference handler can fix it
      * @throws LogicException             Occurs when the normalizer is not called in an expected context

Original file line number	Diff line number	Diff line change
`@@ -30,9 +30,9 @@ interface NormalizerInterface`
`30`	`30`	`* @param string $format Format the normalization result will be encoded as`
`31`	`31`	`* @param array $context Context options for the normalizer`
`32`	`32`	`*`
`33`		`- * @return array\|string\|int\|float\|bool`
	`33`	`+ * @return array\|string\|int\|float\|bool\|null`
`34`	`34`	`*`
`35`		`- * @throws InvalidArgumentException Occurs when the object given is not an attempted type for the normalizer`
	`35`	`+ * @throws InvalidArgumentException Occurs when the object given is not a supported type for the normalizer`
`36`	`36`	`* @throws CircularReferenceException Occurs when the normalizer detects a circular reference when no circular`
`37`	`37`	`* reference handler can fix it`
`38`	`38`	`* @throws LogicException Occurs when the normalizer is not called in an expected context`