Skip to content

[Serializer] Add feature description for AbstractNormalizer::REQUIRE_ALL_PROPERTIES context option #17979

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Nov 21, 2023

Conversation

christian-kolb
Copy link
Contributor

This PR adds the feature description for the new context flag for the Serializer component introduced here: symfony/symfony#49553

@OskarStark OskarStark added the Waiting Code Merge Docs for features pending to be merged label Feb 28, 2023
@carsonbot carsonbot modified the milestones: 6.3, next Feb 28, 2023
christian-kolb and others added 3 commits February 28, 2023 09:40
Co-authored-by: Oskar Stark <oskarstark@googlemail.com>
Co-authored-by: Oskar Stark <oskarstark@googlemail.com>
Co-authored-by: Oskar Stark <oskarstark@googlemail.com>
Co-authored-by: Oskar Stark <oskarstark@googlemail.com>
@christian-kolb christian-kolb changed the title [Serializer] Add feature description for AbstractNormalizer::PREVENT_NULLABLE_FALLBACK context option [Serializer] Add feature description for AbstractNormalizer::REQUIRE_ALL_PROPERTIES context option May 5, 2023
nicolas-grekas added a commit to symfony/symfony that referenced this pull request May 5, 2023
…listed in the input (Christian Kolb)

This PR was merged into the 6.3 branch.

Discussion
----------

[Serializer] Add flag to require all properties to be listed in the input

| Q             | A
| ------------- | ---
| Branch?       | 6.3
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Tickets       | Fix #49504
| License       | MIT
| Doc PR        | symfony/symfony-docs#17979

The PR #40522 introduced a fallback for nullable properties to be set to `null` when they aren't provided as parameters.

A drawback of that approach is that it easier for bugs to appear through typos or renamings of those properties. I think the current implementation makes perfect sense as a default. Therefore, this PR introduces a new context flag that prevents that fallback behaviour. This way nothing changes for existing systems, but for people wanting more control, it's possible to set a flag.

### Example

```php
final class Product
{
    public function __construct(
        public string $name,
        public ?int $costsInCent,
    ) {
    }
}

// This works and results in $costsInCent as null
$product = $this->serializer->deserialize(
    '{"name": "foo"}',
    Product::class,
    JsonEncoder::FORMAT,
);

// When using the flag, only the following JSON is valid
$product = $this->serializer->deserialize(
    '{"name": "foo", "costsInCent": null}',
    Product::class,
    JsonEncoder::FORMAT,
    [
        AbstractNormalizer::PREVENT_NULLABLE_FALLBACK => true,
    ],
);

// This would result in an error due to missing parameters
$product = $this->serializer->deserialize(
    '{"name": "foo"}',
    Product::class,
    JsonEncoder::FORMAT,
    [
        AbstractNormalizer::PREVENT_NULLABLE_FALLBACK => true,
    ],
);
```

Commits
-------

d62410a [Serializer] Add flag to require all properties to be listed in the input
@christian-kolb
Copy link
Contributor Author

@OskarStark The connected PR was just merged 🙂
Can this also be merged? I saw that there have been a lot of commits in the meantime. Otherwise I do the changes again on the current version if that helps.

@xabbuh xabbuh removed the Waiting Code Merge Docs for features pending to be merged label Nov 21, 2023
@xabbuh xabbuh modified the milestones: next, 6.3 Nov 21, 2023
@xabbuh
Copy link
Member

xabbuh commented Nov 21, 2023

Thank you @christian-kolb.

@xabbuh xabbuh merged commit c0eb95c into symfony:6.3 Nov 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants