feature #22011 [FrameworkBundle][Serializer] Add option to register a circular_reference_handler (lyrixx)

fabpot · fabpot · commit 065bf489fa35 · 2017-03-22T12:06:37.000-07:00
This PR was merged into the 3.3-dev branch. Discussion ---------- [FrameworkBundle][Serializer] Add option to register a circular_reference_handler | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - --- Right now, it's quite hard (especially for new comers) to register a CircularReferenceHandler: ![screenshot1](https://cloud.githubusercontent.com/assets/408368/23959193/ce19bcec-09a4-11e7-82c7-80abd7b7f602.png) --- This PR introduce an option to wire a service to the internal Object Normalizer. Commits ------- 0a638f5 [FrameworkBundle][Serializer] Add option to register a "circular_reference_handler"
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -686,6 +686,7 @@ private function addSerializerSection(ArrayNodeDefinition $rootNode)
                         ->booleanNode('enable_annotations')->{!class_exists(FullStack::class) && class_exists(Annotation::class) ? 'defaultTrue' : 'defaultFalse'}()->end()
                         ->scalarNode('cache')->end()
                         ->scalarNode('name_converter')->end()
+                        ->scalarNode('circular_reference_handler')->end()
                     ->end()
                 ->end()
             ->end()
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -1294,6 +1294,10 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder
         if (isset($config['name_converter']) && $config['name_converter']) {
             $container->getDefinition('serializer.normalizer.object')->replaceArgument(1, new Reference($config['name_converter']));
         }
+
+        if (isset($config['circular_reference_handler']) && $config['circular_reference_handler']) {
+            $container->getDefinition('serializer.normalizer.object')->addMethodCall('setCircularReferenceHandler', array(new Reference($config['circular_reference_handler'])));
+        }
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -1294,6 +1294,10 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder`
`1294`	`1294`	`if (isset($config['name_converter']) && $config['name_converter']) {`
`1295`	`1295`	`$container->getDefinition('serializer.normalizer.object')->replaceArgument(1, new Reference($config['name_converter']));`
`1296`	`1296`	`}`
	`1297`	`+`
	`1298`	`+ if (isset($config['circular_reference_handler']) && $config['circular_reference_handler']) {`
	`1299`	`+ $container->getDefinition('serializer.normalizer.object')->addMethodCall('setCircularReferenceHandler', array(new Reference($config['circular_reference_handler'])));`
	`1300`	`+ }`
`1297`	`1301`	`}`
`1298`	`1302`
`1299`	`1303`	`/**`