Skip to content

Commit c50a05b

Browse files
committed
document default context for the serializer
1 parent 25b24d8 commit c50a05b

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

reference/configuration/framework.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2743,6 +2743,18 @@ paths
27432743
This option allows to define an array of paths with files or directories where
27442744
the component will look for additional serialization files.
27452745

2746+
default_context
2747+
...............
2748+
2749+
**type**: ``array`` **default**: ``[]``
2750+
2751+
A map with default context options that will be used with each ``serialize`` and ``deserialize``
2752+
call. This can be used for example to set the json encoding behaviour by setting ``json_encode_options``
2753+
to a `json_encode flags bitmask`_.
2754+
2755+
You can inspect the :ref:`serializer context builders <serializer-using-context-builders>`
2756+
to discover the available settings.
2757+
27462758
php_errors
27472759
~~~~~~~~~~
27482760

@@ -3573,6 +3585,7 @@ use the configuration of the first exception that matches ``instanceof``:
35733585
.. _`blue/green deployment`: https://martinfowler.com/bliki/BlueGreenDeployment.html
35743586
.. _`gulp-rev`: https://www.npmjs.com/package/gulp-rev
35753587
.. _`webpack-manifest-plugin`: https://www.npmjs.com/package/webpack-manifest-plugin
3588+
.. _`json_encode flags bitmask`: https://www.php.net/json_encode
35763589
.. _`error_reporting PHP option`: https://www.php.net/manual/en/errorfunc.configuration.php#ini.error-reporting
35773590
.. _`CSRF security attacks`: https://en.wikipedia.org/wiki/Cross-site_request_forgery
35783591
.. _`session.sid_length PHP option`: https://www.php.net/manual/session.configuration.php#ini.session.sid-length

serializer.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,14 +130,15 @@ configuration:
130130
serializer:
131131
default_context:
132132
enable_max_depth: true
133+
yaml_indentation: 2
133134
134135
.. code-block:: xml
135136
136137
<!-- config/packages/framework.xml -->
137138
<framework:config>
138139
<!-- ... -->
139140
<framework:serializer>
140-
<default-context enable-max-depth="true"/>
141+
<default-context enable-max-depth="true" yaml-indentation="2"/>
141142
</framework:serializer>
142143
</framework:config>
143144
@@ -146,11 +147,13 @@ configuration:
146147
// config/packages/framework.php
147148
use Symfony\Config\FrameworkConfig;
148149
use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
150+
use Symfony\Component\Serializer\Encoder\YamlEncoder;
149151
150152
return static function (FrameworkConfig $framework) {
151153
$framework->serializer()
152154
->defaultContext([
153-
AbstractObjectNormalizer::ENABLE_MAX_DEPTH => true
155+
AbstractObjectNormalizer::ENABLE_MAX_DEPTH => true,
156+
YamlEncoder::YAML_INDENTATION => 2,
154157
])
155158
;
156159
};

0 commit comments

Comments
 (0)