feature #7633 [FrameworkBundle][Serializer] Add new framework bundle option to reference: circular_reference_handler (Nek-)

xabbuh · xabbuh · commit 27df5085b5cb · 2017-04-15T14:26:46.000+02:00
This PR was merged into the master branch. Discussion ---------- [FrameworkBundle][Serializer] Add new framework bundle option to reference: circular_reference_handler This PR provides documentation for this other PR symfony/symfony#22011 It should not be merged before the related Symfony PR is merged. It also fixes missing options in the example YAML config file. Commits ------- 964c31e Add new framework bundle option to reference: circular_reference_handler
diff --git a/components/serializer.rst b/components/serializer.rst
@@ -587,6 +587,8 @@ with the serializer enabled.
 .. versionadded:: 3.2
     The ``YamlEncoder`` and ``CsvEncoder`` encoders were introduced in Symfony 3.2
 
+.. _component-serializer-handling-circular-references:
+
 Handling Circular References
 ----------------------------
 
diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst
@@ -104,6 +104,7 @@ Configuration
     * :ref:`cache <reference-serializer-cache>`
     * :ref:`enable_annotations <reference-serializer-enable_annotations>`
     * :ref:`name_converter <reference-serializer-name_converter>`
+    * :ref:`circular_reference_handler <reference-serializer-circular_reference_handler>`
 * `php_errors`_
     * `log`_
     * `throw`_
@@ -1481,6 +1482,20 @@ value.
     For more information, see
     :ref:`component-serializer-converting-property-names-when-serializing-and-deserializing`.
 
+.. _reference-serializer-circular_reference_handler:
+
+circular_reference_handler
+..........................
+
+**type** ``string``
+
+The service id that is used as circular reference handler of the default serializer. The
+service has to implement the ``__invoke($object)`` method.
+
+.. seealso::
+    For more information, see
+    :ref:`component-serializer-handling-circular-references`.
+
 php_errors
 ~~~~~~~~~~
 
@@ -1610,7 +1625,10 @@ Full Default Configuration
 
             # serializer configuration
             serializer:
-               enabled: false
+               enabled:                   false
+               cache:                      ~
+               name_converter:             ~
+               circular_reference_handler: ~
 
             # assets configuration
             assets:
