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.

Sign up for GitHub

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
Merged

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

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1b0e274
Add feature description
Feb 28, 2023
0b49d9b
Fix broken code example
Feb 28, 2023
b665eeb
Update components/serializer.rst
christian-kolb Feb 28, 2023
e1f5d7c
Update components/serializer.rst
christian-kolb Feb 28, 2023
3b24418
Update components/serializer.rst
christian-kolb Feb 28, 2023
ea5c341
Update components/serializer.rst
christian-kolb Mar 1, 2023
71a4ef4
Rename context flag
May 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions components/serializer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1242,6 +1242,33 @@ to ``true``::
$result = $normalizer->normalize($dummy, 'json', [AbstractObjectNormalizer::SKIP_NULL_VALUES => true]);
// ['bar' => 'notNull']

Require all Properties
----------------------

By default, the Serializer will add ``null`` to nullable properties when the parameters for those are not provided.
You can change this behavior by setting the ``AbstractNormalizer::REQUIRE_ALL_PROPERTIES`` context option
to ``true``::

class Dummy
{
public function __construct(
public string $foo,
public ?string $bar,
) {
}
}

$data = ['foo' => 'notNull'];

$normalizer = new ObjectNormalizer();
$result = $normalizer->denormalize($data, Dummy::class, 'json', [AbstractNormalizer::REQUIRE_ALL_PROPERTIES => true]);
// throws Symfony\Component\Serializer\Exception\MissingConstructorArgumentException

.. versionadded:: 6.3

The ``AbstractNormalizer::PREVENT_NULLABLE_FALLBACK`` context option
was introduced in Symfony 6.3.

Skipping Uninitialized Properties
---------------------------------

Expand Down