[Serializer] Add an option to skip null values #28661
Conversation
There was a problem hiding this comment.
Correct me if I am wrong, but utilizing $context for this most likely means you can't configure Serializer to enable this option by default? If somebody decides to go with this, they will want this to be enabled for whole instance by default. At least that happened in our case. App developer told us he does not want us to send null values and we could easily do that globally, since we used JMS serializer.
|
@ostrolucky you're right. I'll also add a constructor option. |
|
@ostrolucky done I also widened the visibility of |
|
|
||
| /** | ||
| * @var callable|null | ||
| */ | ||
| private $maxDepthHandler; | ||
| protected $maxDepthHandler; |
| /** | ||
| * @var bool | ||
| */ | ||
| protected $skipNullValues = false; |
There was a problem hiding this comment.
shouldbe private also (and the typehint looks useless to me, isn't it?)
There was a problem hiding this comment.
As it's an abstract class, making it private allows to reuse this property in child classes... and we need to do it in API Platform.
There was a problem hiding this comment.
that's still possible to interact with by decorating the skipNullValues method
protected properties are very hard to deprecate, that's why we really prefer not introducing new ones
There was a problem hiding this comment.
We need to access to the value too... in the hot path.
But I agree with your point, and it's why we need to improve the general design of this component.
As a compromise, can we keep it protected but mark it @internal? We'll use it "as is" in API Platform, and if it breaks at some point... we'll upgrade!
|
Last commit has been reverted, after discussing with @nicolas-grekas we had a better idea: we'll introduce soon an option to be able to easily set a default context. |
|
We just talked with @dunglas on Slack: he's going to make another PR that will provide a |
0e158f7 to
d3c5055
Compare
|
Thank you @dunglas. |
This PR was squashed before being merged into the 4.2-dev branch (closes #28661). Discussion ---------- [Serializer] Add an option to skip null values | Q | A | ------------- | --- | Branch? | master | Bug fix? |no | New feature? | yes <!-- don't forget to update src/**/CHANGELOG.md files --> | BC breaks? | no <!-- see https://symfony.com/bc --> | Deprecations? | no <!-- don't forget to update UPGRADE-*.md and src/**/CHANGELOG.md files --> | Tests pass? | yes <!-- please add some, will be required by reviewers --> | Fixed tickets | n/a <!-- #-prefixed issue number(s), if any --> | License | MIT | Doc PR | todo Adds a new option to not serialize `null` values: ```php $dummy = new class { public $foo; public $bar = 'notNull'; }; $normalizer = new ObjectNormalizer(); $result = $normalizer->normalize($dummy, 'json', ['skip_null_values' => true]); // ['bar' => 'notNull'] ``` This feature is the only missing part to add [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) support in [API Platform](https://api-platform.com). It will also help supporting this RFC in all other projects using the Symfony Serializer. Commits ------- d3c5055 [Serializer] Add an option to skip null values
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
Adds a new option to not serialize
nullvalues:This feature is the only missing part to add JSON Merge Patch support in API Platform.
It will also help supporting this RFC in all other projects using the Symfony Serializer.