Allow serializer default context configuration

soyuka · soyuka · commit fc79c7294214 · 2018-10-23T10:21:29.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -809,6 +809,12 @@ private function addSerializerSection(ArrayNodeDefinition $rootNode)
                                 ->end()
                             ->end()
                         ->end()
+                        ->arrayNode('default_context')
+                            ->normalizeKeys(false)
+                            ->useAttributeAsKey('name')
+                            ->defaultValue(array())
+                            ->prototype('variable')->end()
+                        ->end()
                     ->end()
                 ->end()
             ->end()
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -1374,6 +1374,10 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder
         if ($config['max_depth_handler'] ?? false) {
             $container->getDefinition('serializer.normalizer.object')->addMethodCall('setMaxDepthHandler', array(new Reference($config['max_depth_handler'])));
         }
+
+        if ($config['default_context'] ?? false) {
+            $container->getDefinition('serializer.normalizer.object')->setArgument('default_context', $config['default_context']);
+        }
     }
 
     private function registerPropertyInfoConfiguration(ContainerBuilder $container, XmlFileLoader $loader)
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd b/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd
@@ -236,6 +236,7 @@
     <xsd:complexType name="serializer">
         <xsd:choice minOccurs="0" maxOccurs="unbounded">
             <xsd:element name="mapping" type="file_mapping" />
+            <xsd:element name="default_context" type="metadata" minOccurs="0" maxOccurs="unbounded" />
         </xsd:choice>
         <xsd:attribute name="enabled" type="xsd:boolean" />
         <xsd:attribute name="cache" type="xsd:string" />
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
@@ -209,6 +209,7 @@ protected static function getBundleDefaultConfig()
                 'enabled' => true,
             ),
             'serializer' => array(
+                'default_context' => array(),
                 'enabled' => !class_exists(FullStack::class),
                 'enable_annotations' => !class_exists(FullStack::class),
                 'mapping' => array('paths' => array()),
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/full.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/full.php
@@ -70,6 +70,7 @@
         'name_converter' => 'serializer.name_converter.camel_case_to_snake_case',
         'circular_reference_handler' => 'my.circular.reference.handler',
         'max_depth_handler' => 'my.max.depth.handler',
+        'default_context' => array('enable_max_depth' => true),
     ),
     'property_info' => true,
     'ide' => 'file%%link%%format',
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/full.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/full.xml
@@ -41,7 +41,11 @@
         </framework:translator>
         <framework:validation enabled="true" />
         <framework:annotations cache="file" debug="true" file-cache-dir="%kernel.cache_dir%/annotations" />
-        <framework:serializer enabled="true" enable-annotations="true" name-converter="serializer.name_converter.camel_case_to_snake_case" circular-reference-handler="my.circular.reference.handler" max-depth-handler="my.max.depth.handler" />
+        <framework:serializer enabled="true" enable-annotations="true" name-converter="serializer.name_converter.camel_case_to_snake_case" circular-reference-handler="my.circular.reference.handler" max-depth-handler="my.max.depth.handler">
+            <framework:default_context>
+                <framework:enable_max_depth>true</framework:enable_max_depth>
+            </framework:default_context>
+        </framework:serializer>
         <framework:property-info />
     </framework:config>
 </container>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml
@@ -56,6 +56,8 @@ framework:
          name_converter:             serializer.name_converter.camel_case_to_snake_case
          circular_reference_handler: my.circular.reference.handler
          max_depth_handler:          my.max.depth.handler
+         default_context:
+             enable_max_depth: true
     property_info: ~
     ide: file%%link%%format
     request:
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -980,6 +980,7 @@ public function testSerializerEnabled()
         $this->assertEquals(new Reference('property_info', ContainerBuilder::IGNORE_ON_INVALID_REFERENCE), $container->getDefinition('serializer.normalizer.object')->getArgument(3));
         $this->assertEquals(array('setCircularReferenceHandler', array(new Reference('my.circular.reference.handler'))), $container->getDefinition('serializer.normalizer.object')->getMethodCalls()[0]);
         $this->assertEquals(array('setMaxDepthHandler', array(new Reference('my.max.depth.handler'))), $container->getDefinition('serializer.normalizer.object')->getMethodCalls()[1]);
+        $this->assertEquals(array('enable_max_depth' => true), $container->getDefinition('serializer.normalizer.object')->getArgument('default_context'));
     }
 
     public function testRegisterSerializerExtractor()

Original file line number	Diff line number	Diff line change
`@@ -1374,6 +1374,10 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder`
`1374`	`1374`	`if ($config['max_depth_handler'] ?? false) {`
`1375`	`1375`	`$container->getDefinition('serializer.normalizer.object')->addMethodCall('setMaxDepthHandler', array(new Reference($config['max_depth_handler'])));`
`1376`	`1376`	`}`
	`1377`	`+`
	`1378`	`+ if ($config['default_context'] ?? false) {`
	`1379`	`+ $container->getDefinition('serializer.normalizer.object')->setArgument('default_context', $config['default_context']);`
	`1380`	`+ }`
`1377`	`1381`	`}`
`1378`	`1382`
`1379`	`1383`	`private function registerPropertyInfoConfiguration(ContainerBuilder $container, XmlFileLoader $loader)`
Original file line number	Diff line number	Diff line change
`@@ -980,6 +980,7 @@ public function testSerializerEnabled()`
`980`	`980`	`$this->assertEquals(new Reference('property_info', ContainerBuilder::IGNORE_ON_INVALID_REFERENCE), $container->getDefinition('serializer.normalizer.object')->getArgument(3));`
`981`	`981`	`$this->assertEquals(array('setCircularReferenceHandler', array(new Reference('my.circular.reference.handler'))), $container->getDefinition('serializer.normalizer.object')->getMethodCalls()[0]);`
`982`	`982`	`$this->assertEquals(array('setMaxDepthHandler', array(new Reference('my.max.depth.handler'))), $container->getDefinition('serializer.normalizer.object')->getMethodCalls()[1]);`
	`983`	`+ $this->assertEquals(array('enable_max_depth' => true), $container->getDefinition('serializer.normalizer.object')->getArgument('default_context'));`
`983`	`984`	`}`
`984`	`985`
`985`	`986`	`public function testRegisterSerializerExtractor()`