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

This commit is contained in:
Kévin Dunglas 2018-04-23 16:51:34 +02:00
parent 26989d4e73
commit 99f829ec2b
No known key found for this signature in database
GPG Key ID: 4D04EBEF06AAF3A6
4 changed files with 29 additions and 8 deletions

View File

@ -1,6 +1,11 @@
CHANGELOG CHANGELOG
========= =========
4.2.0
-----
* `AbstractNormalizer::handleCircularReference` is now final, and receives two optional extra arguments: the format and the context
4.1.0 4.1.0
----- -----

View File

@ -190,16 +190,23 @@ abstract class AbstractNormalizer implements NormalizerInterface, DenormalizerIn
* If a circular reference handler is set, it will be called. Otherwise, a * If a circular reference handler is set, it will be called. Otherwise, a
* {@class CircularReferenceException} will be thrown. * {@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 * @return mixed
* *
* @throws CircularReferenceException * @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) { 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)); 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));

View File

@ -79,13 +79,13 @@ abstract class AbstractObjectNormalizer extends AbstractNormalizer
} }
if ($this->isCircularReference($object, $context)) { if ($this->isCircularReference($object, $context)) {
return $this->handleCircularReference($object); return $this->handleCircularReference($object, $format, $context);
} }
$data = array(); $data = array();
$stack = array(); $stack = array();
$attributes = $this->getAttributes($object, $format, $context); $attributes = $this->getAttributes($object, $format, $context);
$class = get_class($object); $class = \get_class($object);
$attributesMetadata = $this->classMetadataFactory ? $this->classMetadataFactory->getMetadataFor($class)->getAttributesMetadata() : null; $attributesMetadata = $this->classMetadataFactory ? $this->classMetadataFactory->getMetadataFor($class)->getAttributesMetadata() : null;
foreach ($attributes as $attribute) { foreach ($attributes as $attribute) {
@ -154,7 +154,7 @@ abstract class AbstractObjectNormalizer extends AbstractNormalizer
*/ */
protected function getAttributes($object, $format = null, array $context) protected function getAttributes($object, $format = null, array $context)
{ {
$class = get_class($object); $class = \get_class($object);
$key = $class.'-'.$context['cache_key']; $key = $class.'-'.$context['cache_key'];
if (isset($this->attributesCache[$key])) { if (isset($this->attributesCache[$key])) {
@ -248,7 +248,7 @@ abstract class AbstractObjectNormalizer extends AbstractNormalizer
$attribute = $this->nameConverter->denormalize($attribute); $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]) { if (isset($context[self::ALLOW_EXTRA_ATTRIBUTES]) && !$context[self::ALLOW_EXTRA_ATTRIBUTES]) {
$extraAttributes[] = $attribute; $extraAttributes[] = $attribute;
} }
@ -345,7 +345,7 @@ abstract class AbstractObjectNormalizer extends AbstractNormalizer
return (float) $data; return (float) $data;
} }
if (call_user_func('is_'.$builtinType, $data)) { if (\call_user_func('is_'.$builtinType, $data)) {
return $data; return $data;
} }
} }

View File

@ -544,6 +544,15 @@ class ObjectNormalizerTest extends TestCase
$expected = array('me' => 'Symfony\Component\Serializer\Tests\Fixtures\CircularReferenceDummy'); $expected = array('me' => 'Symfony\Component\Serializer\Tests\Fixtures\CircularReferenceDummy');
$this->assertEquals($expected, $this->normalizer->normalize($obj)); $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() public function testDenormalizeNonExistingAttribute()