[Serializer] Allow to access to the context and various other infos in callbacks and max depth handler

dunglas · dunglas · commit 0e5f74071a41 · 2018-04-23T16:28:06.000+02:00
diff --git a/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php
@@ -97,11 +97,11 @@ public function normalize($object, $format = null, array $context = array())
 
             $attributeValue = $this->getAttributeValue($object, $attribute, $format, $context);
             if ($maxDepthReached) {
-                $attributeValue = \call_user_func($this->maxDepthHandler, $attributeValue);
+                $attributeValue = \call_user_func($this->maxDepthHandler, $attributeValue, $object, $attribute, $format, $context);
             }
 
             if (isset($this->callbacks[$attribute])) {
-                $attributeValue = call_user_func($this->callbacks[$attribute], $attributeValue);
+                $attributeValue = \call_user_func($this->callbacks[$attribute], $attributeValue, $object, $attribute, $format, $context);
             }
 
             if (null !== $attributeValue && !is_scalar($attributeValue)) {
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/ObjectNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/ObjectNormalizerTest.php
@@ -426,6 +426,8 @@ public function provideCallbacks()
             array(
                 array(
                     'bar' => function ($bar) {
+                        $this->assertEquals('baz', $bar);
+
                         return 'baz';
                     },
                 ),
@@ -435,8 +437,12 @@ public function provideCallbacks()
             ),
             array(
                 array(
-                    'bar' => function ($bar) {
-                        return;
+                    'bar' => function ($value, $object, $attributeName, $format, $context) {
+                        $this->assertSame('baz', $value);
+                        $this->assertInstanceOf(ObjectConstructorDummy::class, $object);
+                        $this->assertSame('bar', $attributeName);
+                        $this->assertSame('any', $format);
+                        $this->assertArrayHasKey('circular_reference_limit', $context);
                     },
                 ),
                 'baz',
@@ -634,6 +640,18 @@ public function testMaxDepth()
 
         $result = $serializer->normalize($level1, null, array(ObjectNormalizer::ENABLE_MAX_DEPTH => true));
         $this->assertEquals($expected, $result);
+
+        $this->normalizer->setMaxDepthHandler(function ($object, $parentObject, $attributeName, $format, $context) {
+            $this->assertSame('level3', $object);
+            $this->assertInstanceOf(MaxDepthDummy::class, $parentObject);
+            $this->assertSame('foo', $attributeName);
+            $this->assertSame('test', $format);
+            $this->assertArrayHasKey(ObjectNormalizer::ENABLE_MAX_DEPTH, $context);
+
+            return 'handler';
+        });
+
+        $serializer->normalize($level1, 'test', array(ObjectNormalizer::ENABLE_MAX_DEPTH => true));
     }
 
     /**
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/PropertyNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/PropertyNormalizerTest.php
@@ -276,7 +276,6 @@ public function provideCallbacks()
             array(
                 array(
                     'bar' => function ($bar) {
-                        return;
                     },
                 ),
                 'baz',

Original file line number	Diff line number	Diff line change
`@@ -97,11 +97,11 @@ public function normalize($object, $format = null, array $context = array())`
`97`	`97`
`98`	`98`	`$attributeValue = $this->getAttributeValue($object, $attribute, $format, $context);`
`99`	`99`	`if ($maxDepthReached) {`
`100`		`- $attributeValue = \call_user_func($this->maxDepthHandler, $attributeValue);`
	`100`	`+ $attributeValue = \call_user_func($this->maxDepthHandler, $attributeValue, $object, $attribute, $format, $context);`
`101`	`101`	`}`
`102`	`102`
`103`	`103`	`if (isset($this->callbacks[$attribute])) {`
`104`		`- $attributeValue = call_user_func($this->callbacks[$attribute], $attributeValue);`
	`104`	`+ $attributeValue = \call_user_func($this->callbacks[$attribute], $attributeValue, $object, $attribute, $format, $context);`
`105`	`105`	`}`
`106`	`106`
`107`	`107`	`if (null !== $attributeValue && !is_scalar($attributeValue)) {`
-Original file line number
+Diff line change
             array(
                 array(
                     'bar' => function ($bar) {
 -                        return;
                     },
                 ),
                 'baz',