Skip to content
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

[FrameworkBundle] Name converter of Serializer #5483

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
2 changes: 2 additions & 0 deletions components/serializer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,8 @@ method on the normalizer definition::
$serializer = new Serializer(array($normalizer), array($encoder));
$serializer->serialize($person, 'json'); // Output: {"name":"foo","sportsman":false}

.. _component-serializer-converting-property-names-when-serializing-and-deserializing:

Converting Property Names when Serializing and Deserializing
------------------------------------------------------------

Expand Down
4 changes: 4 additions & 0 deletions cookbook/serializer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,8 @@ Here is an example on how to load the
$definition->addTag('serializer.normalizer');
$container->setDefinition('get_set_method_normalizer', $definition);

.. _cookbook-serializer-using-serialization-groups-annotations:

Using Serialization Groups Annotations
--------------------------------------

Expand Down Expand Up @@ -170,6 +172,8 @@ to your class and choose which groups to use when serializing::
'json', array('groups' => array('group1')
);

.. _cookbook-serializer-enabling-metadata-cache:

Enabling the Metadata Cache
---------------------------

Expand Down
47 changes: 45 additions & 2 deletions reference/configuration/framework.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Configuration
* `validation`_
* :ref:`enabled <reference-validation-enabled>`
* :ref:`cache <reference-validation-cache>`
* `enable_annotations`_
* :ref:`enable_annotations <reference-validation-enable_annotations>`
* `translation_domain`_
* `strict_email`_
* `api`_
Expand All @@ -102,6 +102,9 @@ Configuration
* `debug`_
* `serializer`_
* :ref:`enabled <reference-serializer-enabled>`
* :ref:`cache <reference-serializer-cache>`
* :ref:`enable_annotations <reference-serializer-enable_annotations>`
* `name_converter`_

secret
~~~~~~
Expand Down Expand Up @@ -1372,6 +1375,8 @@ cache
The service that is used to persist class metadata in a cache. The service
has to implement the :class:`Symfony\\Component\\Validator\\Mapping\\Cache\\CacheInterface`.

.. _reference-validation-enable_annotations:

enable_annotations
..................

Expand Down Expand Up @@ -1478,7 +1483,45 @@ enabled

Whether to enable the ``serializer`` service or not in the service container.

For more details, see :doc:`/cookbook/serializer`.
.. _reference-serializer-cache:

cache
.....

**type**: ``string``

The service that is used to persist class metadata in a cache. The service
has to implement the :class:`Doctrine\\Common\\Cache\\Cache` interface.

.. seealso::

For more information, see :ref:`cookbook-serializer-enabling-metadata-cache`.

.. _reference-serializer-enable_annotations:

enable_annotations
..................

**type**: ``boolean`` **default**: ``false``

If this option is enabled, serialization groups can be defined using annotations.

.. seealso::

For more information, see :ref:`cookbook-serializer-using-serialization-groups-annotations`.

name_converter
..............

**type**: ``string``

The name converter to use.
The :class:`Symfony\\Component\\Serializer\\NameConverter\\CamelCaseToSnakeCaseNameConverter` name converter can enabled by using the ``serializer.name_converter.camel_case_to_snake_case``
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this line has to be broken after the first word that crosses the 72th character

value.

.. seealso::

For more information, see :ref:`component-serializer-converting-property-names-when-serializing-and-deserializing`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here (the ref should be placed on its own line). I would also prefer if the ref pointer can be a little bit smaller.


Full Default Configuration
--------------------------
Expand Down