feature #6926 [Serializer] Add information about name converter parameter (michaelperrin)

xabbuh · xabbuh · commit cb50d14108f8 · 2016-09-21T19:27:35.000+02:00
This PR was merged into the 2.8 branch. Discussion ---------- [Serializer] Add information about name converter parameter The `name_converter` option for the Serializer component configuration is only documented in the [configuration reference](http://symfony.com/doc/current/reference/configuration/framework.html#name-converter). It is not visible when reading the Serializer [How to use](http://symfony.com/doc/current/serializer.html) chapter, which makes difficult to find this option (hence an issue like this: https://github.com/symfony/symfony-standard/issues/902). Should I mention that the option was added in Symfony 2.8 (something that is not mentioned in the Configuration reference)? Commits ------- 299ac85 [Serializer] Add information about name converter parameter
diff --git a/serializer.rst b/serializer.rst
@@ -226,6 +226,41 @@ A service leveraging `APCu`_ (and APC for PHP < 5.5) is built-in.
             ),
         ));
 
+Enabling a name converter
+-------------------------
+
+The use of a :ref:`name converter <component-serializer-converting-property-names-when-serializing-and-deserializing>` service can be defined in the configuration using the `name_converter` serializer parameter.
+
+The built-in :ref:`CamelCase to snake_case name converter <using-camelized-method-names-for-underscored-attributes>` can be enabled by using the `serializer.name_converter.camel_case_to_snake_case` value:
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        # app/config/config.yml
+        framework:
+            # ...
+            serializer:
+                name_converter: 'serializer.name_converter.camel_case_to_snake_case'
+
+    .. code-block:: xml
+
+        <!-- app/config/config.xml -->
+        <framework:config>
+            <!-- ... -->
+            <framework:serializer name-converter="serializer.name_converter.camel_case_to_snake_case" />
+        </framework:config>
+
+    .. code-block:: php
+
+        // app/config/config.php
+        $container->loadFromExtension('framework', array(
+            // ...
+            'serializer' => array(
+                'name_converter' => 'serializer.name_converter.camel_case_to_snake_case,
+            ),
+        ));
+
 Going Further with the Serializer
 ---------------------------------
 
