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] Update serializer configuration reference #5333

Merged
merged 1 commit into from
Jul 7, 2015
Merged
Show file tree
Hide file tree
Changes from all 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
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
33 changes: 31 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,8 @@ Configuration
* `debug`_
* `serializer`_
* :ref:`enabled <reference-serializer-enabled>`
* :ref:`cache <reference-serializer-cache>`
* :ref:`enable_annotations <reference-serializer-enable_annotations>`

secret
~~~~~~
Expand Down Expand Up @@ -1372,6 +1374,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 +1482,32 @@ 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`.

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