Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Serializer] Documenting the new SKIP_UNINITIALIZED_VALUES option #15823

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 2 commits into from
Oct 26, 2022
Merged

[Serializer] Documenting the new SKIP_UNINITIALIZED_VALUES option #15823

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
034f0f6
[Serializer] Documenting the new SKIP_UNINITIALIZED_VALUES option
vuryss Sep 16, 2021
08599e8
Update serializer.rst
ivannemets-sravniru Oct 14, 2021
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
29 changes: 29 additions & 0 deletions components/serializer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1174,6 +1174,35 @@ to ``true``::
$result = $normalizer->normalize($dummy, 'json', [AbstractObjectNormalizer::SKIP_NULL_VALUES => true]);
// ['bar' => 'notNull']

Skipping uninitialized properties
---------------------------------

PHP 7.4 introduced typed properties, which have a new state - ``uninitialized``.
This is different from the default ``null`` of untyped properties.
When you try to access it before giving it an explicit value - you get an error.

By default, to avoid the Serializer throwing an error when serializing or normalizing an object with
uninitialized properties, object normalizer catches these errors and ignores such properties.

You can disable this behavior by setting the ``AbstractObjectNormalizer::SKIP_UNINITIALIZED_VALUES`` context option to ``false``::

class Dummy {
public string $foo = 'initialized';
public string $bar; // uninitialized
}

$normalizer = new ObjectNormalizer();
$result = $normalizer->normalize(new Dummy(), 'json', [AbstractObjectNormalizer::SKIP_UNINITIALIZED_VALUES => false]);
// throws Symfony\Component\PropertyAccess\Exception\UninitializedPropertyException as normalizer cannot read uninitialized properties

.. note::

Calling ``PropertyNormalizer::normalize`` or ``GetSetMethodNormalizer::normalize`` with ``AbstractObjectNormalizer::SKIP_UNINITIALIZED_VALUES`` context option set to ``false`` will throw an ``\Error`` instance if the given object has uninitialized properties as the normalizer cannot read them (directly or via getter/isser methods).

.. versionadded:: 5.4

The ``AbstractObjectNormalizer::SKIP_UNINITIALIZED_VALUES`` constant was introduced in Symfony 5.4.

.. _component-serializer-handling-circular-references:

Handling Circular References
Expand Down