[Serializer] Allow to access to the format and context in circular ref handler

dunglas · dunglas · commit 99f829ec2b59 · 2018-07-03T22:17:49.000+02:00
diff --git a/src/Symfony/Component/Serializer/CHANGELOG.md b/src/Symfony/Component/Serializer/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.2.0
+-----
+
+* `AbstractNormalizer::handleCircularReference` is now final, and receives two optional extra arguments: the format and the context
+
 4.1.0
 -----
 
diff --git a/src/Symfony/Component/Serializer/Normalizer/AbstractNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/AbstractNormalizer.php
@@ -190,16 +190,23 @@ protected function isCircularReference($object, &$context)
      * If a circular reference handler is set, it will be called. Otherwise, a
      * {@class CircularReferenceException} will be thrown.
      *
-     * @param object $object
+     * @final since Symfony 4.2
+     *
+     * @param object      $object
+     * @param string|null $format
+     * @param array       $context
      *
      * @return mixed
      *
      * @throws CircularReferenceException
      */
-    protected function handleCircularReference($object)
+    protected function handleCircularReference($object/*, string $format = null, array $context = array()*/)
     {
+        $format = \func_num_args() > 1 ? func_get_arg(1) : null;
+        $context = \func_num_args() > 2 ? func_get_arg(2) : array();
+
         if ($this->circularReferenceHandler) {
-            return \call_user_func($this->circularReferenceHandler, $object);
+            return \call_user_func($this->circularReferenceHandler, $object, $format, $context);
         }
 
         throw new CircularReferenceException(sprintf('A circular reference has been detected when serializing the object of class "%s" (configured limit: %d)', \get_class($object), $this->circularReferenceLimit));
diff --git a/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php
@@ -79,13 +79,13 @@ public function normalize($object, $format = null, array $context = array())
         }
 
         if ($this->isCircularReference($object, $context)) {
-            return $this->handleCircularReference($object);
+            return $this->handleCircularReference($object, $format, $context);
         }
 
         $data = array();
         $stack = array();
         $attributes = $this->getAttributes($object, $format, $context);
-        $class = get_class($object);
+        $class = \get_class($object);
         $attributesMetadata = $this->classMetadataFactory ? $this->classMetadataFactory->getMetadataFor($class)->getAttributesMetadata() : null;
 
         foreach ($attributes as $attribute) {
@@ -154,7 +154,7 @@ protected function instantiateObject(array &$data, $class, array &$context, \Ref
      */
     protected function getAttributes($object, $format = null, array $context)
     {
-        $class = get_class($object);
+        $class = \get_class($object);
         $key = $class.'-'.$context['cache_key'];
 
         if (isset($this->attributesCache[$key])) {
@@ -248,7 +248,7 @@ public function denormalize($data, $class, $format = null, array $context = arra
                 $attribute = $this->nameConverter->denormalize($attribute);
             }
 
-            if ((false !== $allowedAttributes && !in_array($attribute, $allowedAttributes)) || !$this->isAllowedAttribute($class, $attribute, $format, $context)) {
+            if ((false !== $allowedAttributes && !\in_array($attribute, $allowedAttributes)) || !$this->isAllowedAttribute($class, $attribute, $format, $context)) {
                 if (isset($context[self::ALLOW_EXTRA_ATTRIBUTES]) && !$context[self::ALLOW_EXTRA_ATTRIBUTES]) {
                     $extraAttributes[] = $attribute;
                 }
@@ -345,7 +345,7 @@ private function validateAndDenormalize(string $currentClass, string $attribute,
                 return (float) $data;
             }
 
-            if (call_user_func('is_'.$builtinType, $data)) {
+            if (\call_user_func('is_'.$builtinType, $data)) {
                 return $data;
             }
         }
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/ObjectNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/ObjectNormalizerTest.php
@@ -544,6 +544,15 @@ public function testCircularReferenceHandler()
 
         $expected = array('me' => 'Symfony\Component\Serializer\Tests\Fixtures\CircularReferenceDummy');
         $this->assertEquals($expected, $this->normalizer->normalize($obj));
+
+        $this->normalizer->setCircularReferenceHandler(function ($obj, string $format, array $context) {
+            $this->assertInstanceOf(CircularReferenceDummy::class, $obj);
+            $this->assertSame('test', $format);
+            $this->arrayHasKey('foo', $context);
+
+            return \get_class($obj);
+        });
+        $this->assertEquals($expected, $this->normalizer->normalize($obj, 'test', array('foo' => 'bar')));
     }
 
     public function testDenormalizeNonExistingAttribute()

Original file line number	Diff line number	Diff line change
`@@ -190,16 +190,23 @@ protected function isCircularReference($object, &$context)`
`190`	`190`	`* If a circular reference handler is set, it will be called. Otherwise, a`
`191`	`191`	`* {@class CircularReferenceException} will be thrown.`
`192`	`192`	`*`
`193`		`- * @param object $object`
	`193`	`+ * @final since Symfony 4.2`
	`194`	`+ *`
	`195`	`+ * @param object $object`
	`196`	`+ * @param string\|null $format`
	`197`	`+ * @param array $context`
`194`	`198`	`*`
`195`	`199`	`* @return mixed`
`196`	`200`	`*`
`197`	`201`	`* @throws CircularReferenceException`
`198`	`202`	`*/`
`199`		`- protected function handleCircularReference($object)`
	`203`	`+ protected function handleCircularReference($object/, string $format = null, array $context = array()/)`
`200`	`204`	`{`
	`205`	`+ $format = \func_num_args() > 1 ? func_get_arg(1) : null;`
	`206`	`+ $context = \func_num_args() > 2 ? func_get_arg(2) : array();`
	`207`	`+`
`201`	`208`	`if ($this->circularReferenceHandler) {`
`202`		`- return \call_user_func($this->circularReferenceHandler, $object);`
	`209`	`+ return \call_user_func($this->circularReferenceHandler, $object, $format, $context);`
`203`	`210`	`}`
`204`	`211`
`205`	`212`	`throw new CircularReferenceException(sprintf('A circular reference has been detected when serializing the object of class "%s" (configured limit: %d)', \get_class($object), $this->circularReferenceLimit));`
Original file line number	Diff line number	Diff line change
`@@ -79,13 +79,13 @@ public function normalize($object, $format = null, array $context = array())`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`if ($this->isCircularReference($object, $context)) {`
`82`		`- return $this->handleCircularReference($object);`
	`82`	`+ return $this->handleCircularReference($object, $format, $context);`
`83`	`83`	`}`
`84`	`84`
`85`	`85`	`$data = array();`
`86`	`86`	`$stack = array();`
`87`	`87`	`$attributes = $this->getAttributes($object, $format, $context);`
`88`		`- $class = get_class($object);`
	`88`	`+ $class = \get_class($object);`
`89`	`89`	`$attributesMetadata = $this->classMetadataFactory ? $this->classMetadataFactory->getMetadataFor($class)->getAttributesMetadata() : null;`
`90`	`90`
`91`	`91`	`foreach ($attributes as $attribute) {`
`@@ -154,7 +154,7 @@ protected function instantiateObject(array &$data, $class, array &$context, \Ref`
`154`	`154`	`*/`
`155`	`155`	`protected function getAttributes($object, $format = null, array $context)`
`156`	`156`	`{`
`157`		`- $class = get_class($object);`
	`157`	`+ $class = \get_class($object);`
`158`	`158`	`$key = $class.'-'.$context['cache_key'];`
`159`	`159`
`160`	`160`	`if (isset($this->attributesCache[$key])) {`
`@@ -248,7 +248,7 @@ public function denormalize($data, $class, $format = null, array $context = arra`
`248`	`248`	`$attribute = $this->nameConverter->denormalize($attribute);`
`249`	`249`	`}`
`250`	`250`
`251`		`- if ((false !== $allowedAttributes && !in_array($attribute, $allowedAttributes)) \|\| !$this->isAllowedAttribute($class, $attribute, $format, $context)) {`
	`251`	`+ if ((false !== $allowedAttributes && !\in_array($attribute, $allowedAttributes)) \|\| !$this->isAllowedAttribute($class, $attribute, $format, $context)) {`
`252`	`252`	`if (isset($context[self::ALLOW_EXTRA_ATTRIBUTES]) && !$context[self::ALLOW_EXTRA_ATTRIBUTES]) {`
`253`	`253`	`$extraAttributes[] = $attribute;`
`254`	`254`	`}`
`@@ -345,7 +345,7 @@ private function validateAndDenormalize(string $currentClass, string $attribute,`
`345`	`345`	`return (float) $data;`
`346`	`346`	`}`
`347`	`347`
`348`		`- if (call_user_func('is_'.$builtinType, $data)) {`
	`348`	`+ if (\call_user_func('is_'.$builtinType, $data)) {`
`349`	`349`	`return $data;`
`350`	`350`	`}`
`351`	`351`	`}`