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

Skip to content

[Serializer] Document support of canners #16782

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 1 commit into from
May 5, 2022
Merged

[Serializer] Document support of canners #16782

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 10 additions & 6 deletions components/serializer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -746,8 +746,12 @@ If you are using isser methods (methods prefixed by ``is``, like
``App\Model\Person::isSportsperson()``), the Serializer component will
automatically detect and use it to serialize related attributes.

The ``ObjectNormalizer`` also takes care of methods starting with ``has``, ``add``
and ``remove``.
The ``ObjectNormalizer`` also takes care of methods starting with ``has``, ``can``,
``add`` and ``remove``.

.. versionadded:: 6.1

The support of canners (methods prefixed by ``can``) was introduced in Symfony 6.1.

Using Callbacks to Serialize Properties with Object Instances
-------------------------------------------------------------
Expand Down Expand Up @@ -811,12 +815,12 @@ The Serializer component provides several built-in normalizers:
:class:`Symfony\\Component\\Serializer\\Normalizer\\ObjectNormalizer`
This normalizer leverages the :doc:`PropertyAccess Component </components/property_access>`
to read and write in the object. It means that it can access to properties
directly and through getters, setters, hassers, issers, adders and removers. It supports
calling the constructor during the denormalization process.
directly and through getters, setters, hassers, issers, canners, adders and removers.
It supports calling the constructor during the denormalization process.

Objects are normalized to a map of property names and values (names are
generated by removing the ``get``, ``set``, ``has``, ``is``, ``add`` or ``remove`` prefix from
the method name and transforming the first letter to lowercase; e.g.
generated by removing the ``get``, ``set``, ``has``, ``is``, ``can``, ``add`` or ``remove``
prefix from the method name and transforming the first letter to lowercase; e.g.
``getFirstName()`` -> ``firstName``).

The ``ObjectNormalizer`` is the most powerful normalizer. It is configured by
Expand Down