chore(deprecation): symfony normalizer/encoder context

soyuka · soyuka · commit 5c1ff9634844 · 2022-06-27T15:31:41.000+02:00
diff --git a/src/Core/Bridge/Symfony/Bundle/Command/SwaggerCommand.php b/src/Core/Bridge/Symfony/Bundle/Command/SwaggerCommand.php
diff --git a/src/Elasticsearch/Serializer/DocumentNormalizer.php b/src/Elasticsearch/Serializer/DocumentNormalizer.php
@@ -45,9 +45,9 @@ public function __construct(ResourceMetadataCollectionFactoryInterface $resource
     /**
      * {@inheritdoc}
      */
-    public function supportsDenormalization($data, $type, $format = null): bool
+    public function supportsDenormalization($data, $type, $format = null, array $context = []): bool
     {
-        return self::FORMAT === $format && parent::supportsDenormalization($data, $type, $format);
+        return self::FORMAT === $format && parent::supportsDenormalization($data, $type, $format, $context);
     }
 
     /**
@@ -67,7 +67,7 @@ public function denormalize($data, $class, $format = null, array $context = [])
     /**
      * {@inheritdoc}
      */
-    public function supportsNormalization($data, $format = null): bool
+    public function supportsNormalization($data, $format = null, array $context = []): bool
     {
         // prevent the use of lower priority normalizers (e.g. serializer.normalizer.object) for this format
         return self::FORMAT === $format;
diff --git a/src/Elasticsearch/Serializer/ItemNormalizer.php b/src/Elasticsearch/Serializer/ItemNormalizer.php
@@ -72,13 +72,13 @@ public function denormalize($data, $type, $format = null, array $context = [])
      *
      * @throws LogicException
      */
-    public function supportsDenormalization($data, $type, $format = null): bool
+    public function supportsDenormalization($data, $type, $format = null, array $context = []): bool
     {
         if (!$this->decorated instanceof DenormalizerInterface) {
             throw new LogicException(sprintf('The decorated normalizer must be an instance of "%s".', DenormalizerInterface::class));
         }
 
-        return DocumentNormalizer::FORMAT !== $format && $this->decorated->supportsDenormalization($data, $type, $format);
+        return DocumentNormalizer::FORMAT !== $format && $this->decorated->supportsDenormalization($data, $type, $format, $context);
     }
 
     /**
@@ -92,7 +92,7 @@ public function normalize($object, $format = null, array $context = []): array
     /**
      * {@inheritdoc}
      */
-    public function supportsNormalization($data, $format = null): bool
+    public function supportsNormalization($data, $format = null, array $context = []): bool
     {
         return DocumentNormalizer::FORMAT !== $format && $this->decorated->supportsNormalization($data, $format);
     }
diff --git a/src/GraphQl/Serializer/Exception/ErrorNormalizer.php b/src/GraphQl/Serializer/Exception/ErrorNormalizer.php
@@ -35,7 +35,7 @@ public function normalize($object, $format = null, array $context = []): array
     /**
      * {@inheritdoc}
      */
-    public function supportsNormalization($data, $format = null): bool
+    public function supportsNormalization($data, $format = null, array $context = []): bool
     {
         return $data instanceof Error;
     }
diff --git a/src/GraphQl/Serializer/Exception/HttpExceptionNormalizer.php b/src/GraphQl/Serializer/Exception/HttpExceptionNormalizer.php
@@ -43,7 +43,7 @@ public function normalize($object, $format = null, array $context = []): array
     /**
      * {@inheritdoc}
      */
-    public function supportsNormalization($data, $format = null): bool
+    public function supportsNormalization($data, $format = null, array $context = []): bool
     {
         return $data instanceof Error && $data->getPrevious() instanceof HttpExceptionInterface;
     }
diff --git a/src/GraphQl/Serializer/Exception/RuntimeExceptionNormalizer.php b/src/GraphQl/Serializer/Exception/RuntimeExceptionNormalizer.php
@@ -40,7 +40,7 @@ public function normalize($object, $format = null, array $context = []): array
     /**
      * {@inheritdoc}
      */
-    public function supportsNormalization($data, $format = null): bool
+    public function supportsNormalization($data, $format = null, array $context = []): bool
     {
         return $data instanceof Error && $data->getPrevious() instanceof \RuntimeException;
     }
diff --git a/src/GraphQl/Serializer/Exception/ValidationExceptionNormalizer.php b/src/GraphQl/Serializer/Exception/ValidationExceptionNormalizer.php
@@ -73,7 +73,7 @@ public function normalize($object, $format = null, array $context = []): array
     /**
      * {@inheritdoc}
      */
-    public function supportsNormalization($data, $format = null): bool
+    public function supportsNormalization($data, $format = null, array $context = []): bool
     {
         return $data instanceof Error && $data->getPrevious() instanceof ValidationException;
     }
diff --git a/src/Hal/Serializer/EntrypointNormalizer.php b/src/Hal/Serializer/EntrypointNormalizer.php
@@ -76,7 +76,7 @@ public function normalize($object, $format = null, array $context = []): array
     /**
      * {@inheritdoc}
      */
-    public function supportsNormalization($data, $format = null): bool
+    public function supportsNormalization($data, $format = null, array $context = []): bool
     {
         return self::FORMAT === $format && $data instanceof Entrypoint;
     }
diff --git a/src/Hydra/Serializer/CollectionFiltersNormalizer.php b/src/Hydra/Serializer/CollectionFiltersNormalizer.php
@@ -49,9 +49,9 @@ public function __construct(NormalizerInterface $collectionNormalizer, ResourceM
     /**
      * {@inheritdoc}
      */
-    public function supportsNormalization($data, $format = null): bool
+    public function supportsNormalization($data, $format = null, array $context = []): bool
     {
-        return $this->collectionNormalizer->supportsNormalization($data, $format);
+        return $this->collectionNormalizer->supportsNormalization($data, $format, $context);
     }
 
     /**
diff --git a/src/Hydra/Serializer/ErrorNormalizer.php b/src/Hydra/Serializer/ErrorNormalizer.php
@@ -68,7 +68,7 @@ public function normalize($object, $format = null, array $context = [])
     /**
      * {@inheritdoc}
      */
-    public function supportsNormalization($data, $format = null): bool
+    public function supportsNormalization($data, $format = null, array $context = []): bool
     {
         return self::FORMAT === $format && ($data instanceof \Exception || $data instanceof FlattenException || $data instanceof LegacyFlattenException);
     }
diff --git a/src/Hydra/Serializer/PartialCollectionViewNormalizer.php b/src/Hydra/Serializer/PartialCollectionViewNormalizer.php
@@ -108,9 +108,9 @@ public function normalize($object, $format = null, array $context = [])
     /**
      * {@inheritdoc}
      */
-    public function supportsNormalization($data, $format = null): bool
+    public function supportsNormalization($data, $format = null, array $context = []): bool
     {
-        return $this->collectionNormalizer->supportsNormalization($data, $format);
+        return $this->collectionNormalizer->supportsNormalization($data, $format, $context);
     }
 
     /**
diff --git a/src/JsonApi/Serializer/ConstraintViolationListNormalizer.php b/src/JsonApi/Serializer/ConstraintViolationListNormalizer.php
@@ -63,7 +63,7 @@ public function normalize($object, $format = null, array $context = [])
     /**
      * {@inheritdoc}
      */
-    public function supportsNormalization($data, $format = null): bool
+    public function supportsNormalization($data, $format = null, array $context = []): bool
     {
         return self::FORMAT === $format && $data instanceof ConstraintViolationListInterface;
     }
diff --git a/src/JsonApi/Serializer/EntrypointNormalizer.php b/src/JsonApi/Serializer/EntrypointNormalizer.php
@@ -80,7 +80,7 @@ public function normalize($object, $format = null, array $context = [])
     /**
      * {@inheritdoc}
      */
-    public function supportsNormalization($data, $format = null): bool
+    public function supportsNormalization($data, $format = null, array $context = []): bool
     {
         return self::FORMAT === $format && $data instanceof Entrypoint;
     }
diff --git a/src/JsonApi/Serializer/ErrorNormalizer.php b/src/JsonApi/Serializer/ErrorNormalizer.php
@@ -69,7 +69,7 @@ public function normalize($object, $format = null, array $context = [])
     /**
      * {@inheritdoc}
      */
-    public function supportsNormalization($data, $format = null): bool
+    public function supportsNormalization($data, $format = null, array $context = []): bool
     {
         return self::FORMAT === $format && ($data instanceof \Exception || $data instanceof FlattenException || $data instanceof LegacyFlattenException);
     }
diff --git a/src/OpenApi/Serializer/ApiGatewayNormalizer.php b/src/OpenApi/Serializer/ApiGatewayNormalizer.php
@@ -120,7 +120,7 @@ public function normalize($object, $format = null, array $context = [])
     /**
      * {@inheritdoc}
      */
-    public function supportsNormalization($data, $format = null): bool
+    public function supportsNormalization($data, $format = null, array $context = []): bool
     {
         return $this->documentationNormalizer->supportsNormalization($data, $format);
     }
diff --git a/src/OpenApi/Serializer/OpenApiNormalizer.php b/src/OpenApi/Serializer/OpenApiNormalizer.php
@@ -74,7 +74,7 @@ private function recursiveClean($data): array
     /**
      * {@inheritdoc}
      */
-    public function supportsNormalization($data, $format = null): bool
+    public function supportsNormalization($data, $format = null, array $context = []): bool
     {
         return self::FORMAT === $format && $data instanceof OpenApi;
     }
diff --git a/src/Problem/Serializer/ErrorNormalizer.php b/src/Problem/Serializer/ErrorNormalizer.php
@@ -65,7 +65,7 @@ public function normalize($object, $format = null, array $context = []): array
     /**
      * {@inheritdoc}
      */
-    public function supportsNormalization($data, $format = null): bool
+    public function supportsNormalization($data, $format = null, array $context = []): bool
     {
         return self::FORMAT === $format && ($data instanceof \Exception || $data instanceof FlattenException || $data instanceof LegacyFlattenException);
     }
diff --git a/src/RamseyUuid/Serializer/UuidDenormalizer.php b/src/RamseyUuid/Serializer/UuidDenormalizer.php
@@ -37,7 +37,7 @@ public function denormalize($data, $type, $format = null, array $context = [])
         }
     }
 
-    public function supportsDenormalization($data, $type, $format = null): bool
+    public function supportsDenormalization($data, $type, $format = null, array $context = []): bool
     {
         return \is_string($data) && is_a($type, UuidInterface::class, true);
     }
diff --git a/src/Serializer/AbstractCollectionNormalizer.php b/src/Serializer/AbstractCollectionNormalizer.php
@@ -53,10 +53,8 @@ public function __construct(ResourceClassResolverInterface $resourceClassResolve
 
     /**
      * {@inheritdoc}
-     *
-     * @return bool
      */
-    public function supportsNormalization($data, $format = null)
+    public function supportsNormalization($data, $format = null, array $context = []): bool
     {
         return static::FORMAT === $format && is_iterable($data);
     }
diff --git a/src/Serializer/AbstractConstraintViolationListNormalizer.php b/src/Serializer/AbstractConstraintViolationListNormalizer.php
@@ -42,7 +42,7 @@ public function __construct(array $serializePayloadFields = null, NameConverterI
     /**
      * {@inheritdoc}
      */
-    public function supportsNormalization($data, $format = null): bool
+    public function supportsNormalization($data, $format = null, array $context = []): bool
     {
         return static::FORMAT === $format && $data instanceof ConstraintViolationListInterface;
     }
diff --git a/src/Serializer/JsonEncoder.php b/src/Serializer/JsonEncoder.php
@@ -55,7 +55,7 @@ public function __construct(string $format, BaseJsonEncoder $jsonEncoder = null)
     /**
      * {@inheritdoc}
      */
-    public function supportsEncoding($format): bool
+    public function supportsEncoding($format, array $context = []): bool
     {
         return $this->format === $format;
     }
diff --git a/tests/Elasticsearch/Serializer/ItemNormalizerTest.php b/tests/Elasticsearch/Serializer/ItemNormalizerTest.php
@@ -17,6 +17,7 @@
 use ApiPlatform\Elasticsearch\Serializer\ItemNormalizer;
 use ApiPlatform\Tests\ProphecyTrait;
 use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
 use Symfony\Component\Serializer\Exception\LogicException;
 use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
@@ -68,8 +69,8 @@ public function testDenormalize(): void
 
     public function testSupportsDenormalization(): void
     {
-        $this->normalizerProphecy->supportsDenormalization('foo', 'string', 'json')->willReturn(true)->shouldBeCalledOnce();
-        $this->normalizerProphecy->supportsDenormalization('foo', 'string', DocumentNormalizer::FORMAT)->shouldNotBeCalled();
+        $this->normalizerProphecy->supportsDenormalization('foo', 'string', 'json', Argument::type('array'))->willReturn(true)->shouldBeCalledOnce();
+        $this->normalizerProphecy->supportsDenormalization('foo', 'string', DocumentNormalizer::FORMAT, Argument::type('array'))->shouldNotBeCalled();
 
         self::assertTrue($this->itemNormalizer->supportsDenormalization('foo', 'string', 'json'));
         self::assertFalse($this->itemNormalizer->supportsDenormalization('foo', 'string', DocumentNormalizer::FORMAT));
diff --git a/tests/Hydra/Serializer/CollectionFiltersNormalizerTest.php b/tests/Hydra/Serializer/CollectionFiltersNormalizerTest.php
@@ -44,7 +44,7 @@ public function testSupportsNormalization()
     {
         $decoratedProphecy = $this->prophesize(NormalizerInterface::class);
         $decoratedProphecy->willImplement(CacheableSupportsMethodInterface::class);
-        $decoratedProphecy->supportsNormalization('foo', 'abc')->willReturn(true)->shouldBeCalled();
+        $decoratedProphecy->supportsNormalization('foo', 'abc', Argument::type('array'))->willReturn(true)->shouldBeCalled();
         $decoratedProphecy->hasCacheableSupportsMethod()->willReturn(true)->shouldBeCalled();
 
         $normalizer = new CollectionFiltersNormalizer(
diff --git a/tests/Hydra/Serializer/PartialCollectionViewNormalizerTest.php b/tests/Hydra/Serializer/PartialCollectionViewNormalizerTest.php
@@ -162,7 +162,7 @@ public function testSupportsNormalization()
     {
         $decoratedNormalizerProphecy = $this->prophesize(NormalizerInterface::class);
         $decoratedNormalizerProphecy->willImplement(CacheableSupportsMethodInterface::class);
-        $decoratedNormalizerProphecy->supportsNormalization(Argument::any(), null)->willReturn(true)->shouldBeCalled();
+        $decoratedNormalizerProphecy->supportsNormalization(Argument::any(), null, Argument::type('array'))->willReturn(true)->shouldBeCalled();
         $decoratedNormalizerProphecy->hasCacheableSupportsMethod()->willReturn(true)->shouldBeCalled();
         $resourceMetadataFactory = $this->prophesize(ResourceMetadataCollectionFactoryInterface::class);
 

Original file line number	Diff line number	Diff line change
`@@ -45,9 +45,9 @@ public function __construct(ResourceMetadataCollectionFactoryInterface $resource`
`45`	`45`	`/**`
`46`	`46`	`* {@inheritdoc}`
`47`	`47`	`*/`
`48`		`- public function supportsDenormalization($data, $type, $format = null): bool`
	`48`	`+ public function supportsDenormalization($data, $type, $format = null, array $context = []): bool`
`49`	`49`	`{`
`50`		`- return self::FORMAT === $format && parent::supportsDenormalization($data, $type, $format);`
	`50`	`+ return self::FORMAT === $format && parent::supportsDenormalization($data, $type, $format, $context);`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`/**`
`@@ -67,7 +67,7 @@ public function denormalize($data, $class, $format = null, array $context = [])`
`67`	`67`	`/**`
`68`	`68`	`* {@inheritdoc}`
`69`	`69`	`*/`
`70`		`- public function supportsNormalization($data, $format = null): bool`
	`70`	`+ public function supportsNormalization($data, $format = null, array $context = []): bool`
`71`	`71`	`{`
`72`	`72`	`// prevent the use of lower priority normalizers (e.g. serializer.normalizer.object) for this format`
`73`	`73`	`return self::FORMAT === $format;`
Original file line number	Diff line number	Diff line change
`@@ -72,13 +72,13 @@ public function denormalize($data, $type, $format = null, array $context = [])`
`72`	`72`	`*`
`73`	`73`	`* @throws LogicException`
`74`	`74`	`*/`
`75`		`- public function supportsDenormalization($data, $type, $format = null): bool`
	`75`	`+ public function supportsDenormalization($data, $type, $format = null, array $context = []): bool`
`76`	`76`	`{`
`77`	`77`	`if (!$this->decorated instanceof DenormalizerInterface) {`
`78`	`78`	`throw new LogicException(sprintf('The decorated normalizer must be an instance of "%s".', DenormalizerInterface::class));`
`79`	`79`	`}`
`80`	`80`
`81`		`- return DocumentNormalizer::FORMAT !== $format && $this->decorated->supportsDenormalization($data, $type, $format);`
	`81`	`+ return DocumentNormalizer::FORMAT !== $format && $this->decorated->supportsDenormalization($data, $type, $format, $context);`
`82`	`82`	`}`
`83`	`83`
`84`	`84`	`/**`
`@@ -92,7 +92,7 @@ public function normalize($object, $format = null, array $context = []): array`
`92`	`92`	`/**`
`93`	`93`	`* {@inheritdoc}`
`94`	`94`	`*/`
`95`		`- public function supportsNormalization($data, $format = null): bool`
	`95`	`+ public function supportsNormalization($data, $format = null, array $context = []): bool`
`96`	`96`	`{`
`97`	`97`	`return DocumentNormalizer::FORMAT !== $format && $this->decorated->supportsNormalization($data, $format);`
`98`	`98`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public function normalize($object, $format = null, array $context = []): array`
`35`	`35`	`/**`
`36`	`36`	`* {@inheritdoc}`
`37`	`37`	`*/`
`38`		`- public function supportsNormalization($data, $format = null): bool`
	`38`	`+ public function supportsNormalization($data, $format = null, array $context = []): bool`
`39`	`39`	`{`
`40`	`40`	`return $data instanceof Error;`
`41`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public function normalize($object, $format = null, array $context = []): array`
`43`	`43`	`/**`
`44`	`44`	`* {@inheritdoc}`
`45`	`45`	`*/`
`46`		`- public function supportsNormalization($data, $format = null): bool`
	`46`	`+ public function supportsNormalization($data, $format = null, array $context = []): bool`
`47`	`47`	`{`
`48`	`48`	`return $data instanceof Error && $data->getPrevious() instanceof HttpExceptionInterface;`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public function normalize($object, $format = null, array $context = []): array`
`40`	`40`	`/**`
`41`	`41`	`* {@inheritdoc}`
`42`	`42`	`*/`
`43`		`- public function supportsNormalization($data, $format = null): bool`
	`43`	`+ public function supportsNormalization($data, $format = null, array $context = []): bool`
`44`	`44`	`{`
`45`	`45`	`return $data instanceof Error && $data->getPrevious() instanceof \RuntimeException;`
`46`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ public function normalize($object, $format = null, array $context = []): array`
`73`	`73`	`/**`
`74`	`74`	`* {@inheritdoc}`
`75`	`75`	`*/`
`76`		`- public function supportsNormalization($data, $format = null): bool`
	`76`	`+ public function supportsNormalization($data, $format = null, array $context = []): bool`
`77`	`77`	`{`
`78`	`78`	`return $data instanceof Error && $data->getPrevious() instanceof ValidationException;`
`79`	`79`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ public function normalize($object, $format = null, array $context = []): array`
`76`	`76`	`/**`
`77`	`77`	`* {@inheritdoc}`
`78`	`78`	`*/`
`79`		`- public function supportsNormalization($data, $format = null): bool`
	`79`	`+ public function supportsNormalization($data, $format = null, array $context = []): bool`
`80`	`80`	`{`
`81`	`81`	`return self::FORMAT === $format && $data instanceof Entrypoint;`
`82`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,9 +49,9 @@ public function __construct(NormalizerInterface $collectionNormalizer, ResourceM`
`49`	`49`	`/**`
`50`	`50`	`* {@inheritdoc}`
`51`	`51`	`*/`
`52`		`- public function supportsNormalization($data, $format = null): bool`
	`52`	`+ public function supportsNormalization($data, $format = null, array $context = []): bool`
`53`	`53`	`{`
`54`		`- return $this->collectionNormalizer->supportsNormalization($data, $format);`
	`54`	`+ return $this->collectionNormalizer->supportsNormalization($data, $format, $context);`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ public function normalize($object, $format = null, array $context = [])`
`68`	`68`	`/**`
`69`	`69`	`* {@inheritdoc}`
`70`	`70`	`*/`
`71`		`- public function supportsNormalization($data, $format = null): bool`
	`71`	`+ public function supportsNormalization($data, $format = null, array $context = []): bool`
`72`	`72`	`{`
`73`	`73`	`return self::FORMAT === $format && ($data instanceof \Exception \|\| $data instanceof FlattenException \|\| $data instanceof LegacyFlattenException);`
`74`	`74`	`}`