feat(serializer): support for getSupportedTypes (symfony 6.3) (#5672)

api-platform · Jul 24, 2023 · db2cc95 · db2cc95
1 parent 26bf8ae
commit db2cc95
Show file tree

Hide file tree

Showing 53 changed files with 363 additions and 0 deletions.
diff --git a/src/Elasticsearch/Serializer/ItemNormalizer.php b/src/Elasticsearch/Serializer/ItemNormalizer.php
@@ -90,6 +90,19 @@ public function supportsNormalization(mixed $data, string $format = null, array
         return DocumentNormalizer::FORMAT !== $format && $this->decorated->supportsNormalization($data, $format);
     }
 
+    public function getSupportedTypes($format): array
+    {
+        // @deprecated remove condition when support for symfony versions under 6.3 is dropped
+        if (!method_exists($this->decorated, 'getSupportedTypes')) {
+            return [
+                DocumentNormalizer::FORMAT => null,
+                '*' => $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod(),
+            ];
+        }
+
+        return DocumentNormalizer::FORMAT !== $format ? $this->decorated->getSupportedTypes($format) : [];
+    }
+
     /**
      * {@inheritdoc}
      *

diff --git a/src/GraphQl/Serializer/Exception/ErrorNormalizer.php b/src/GraphQl/Serializer/Exception/ErrorNormalizer.php
@@ -39,4 +39,11 @@ public function supportsNormalization(mixed $data, string $format = null, array
     {
         return $data instanceof Error;
     }
+
+    public function getSupportedTypes($format): array
+    {
+        return [
+            Error::class => true,
+        ];
+    }
 }
diff --git a/src/GraphQl/Serializer/Exception/HttpExceptionNormalizer.php b/src/GraphQl/Serializer/Exception/HttpExceptionNormalizer.php
@@ -50,4 +50,11 @@ public function supportsNormalization(mixed $data, string $format = null, array
     {
         return $data instanceof Error && $data->getPrevious() instanceof HttpExceptionInterface;
     }
+
+    public function getSupportedTypes($format): array
+    {
+        return [
+            Error::class => false,
+        ];
+    }
 }
diff --git a/src/GraphQl/Serializer/Exception/RuntimeExceptionNormalizer.php b/src/GraphQl/Serializer/Exception/RuntimeExceptionNormalizer.php
@@ -44,4 +44,11 @@ public function supportsNormalization(mixed $data, string $format = null, array
     {
         return $data instanceof Error && $data->getPrevious() instanceof \RuntimeException;
     }
+
+    public function getSupportedTypes($format): array
+    {
+        return [
+            Error::class => false,
+        ];
+    }
 }
diff --git a/src/GraphQl/Serializer/Exception/ValidationExceptionNormalizer.php b/src/GraphQl/Serializer/Exception/ValidationExceptionNormalizer.php
@@ -77,4 +77,11 @@ public function supportsNormalization(mixed $data, string $format = null, array
     {
         return $data instanceof Error && $data->getPrevious() instanceof ValidationException;
     }
+
+    public function getSupportedTypes($format): array
+    {
+        return [
+            Error::class => false,
+        ];
+    }
 }
diff --git a/src/GraphQl/Serializer/ItemNormalizer.php b/src/GraphQl/Serializer/ItemNormalizer.php
@@ -56,6 +56,11 @@ public function supportsNormalization(mixed $data, string $format = null, array
         return self::FORMAT === $format && parent::supportsNormalization($data, $format, $context);
     }
 
+    public function getSupportedTypes($format): array
+    {
+        return self::FORMAT === $format ? parent::getSupportedTypes($format) : [];
+    }
+
     /**
      * {@inheritdoc}
      *

diff --git a/src/GraphQl/Serializer/ObjectNormalizer.php b/src/GraphQl/Serializer/ObjectNormalizer.php
@@ -44,11 +44,25 @@ public function supportsNormalization(mixed $data, string $format = null, array
         return self::FORMAT === $format && $this->decorated->supportsNormalization($data, $format, $context);
     }
 
+    public function getSupportedTypes($format): array
+    {
+        // @deprecated remove condition when support for symfony versions under 6.3 is dropped
+        if (!method_exists($this->decorated, 'getSupportedTypes')) {
+            return [
+                '*' => $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod(),
+            ];
+        }
+
+        return self::FORMAT === $format ? $this->decorated->getSupportedTypes($format) : [];
+    }
+
     /**
      * {@inheritdoc}
      */
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();
     }
 

diff --git a/src/Hal/Serializer/EntrypointNormalizer.php b/src/Hal/Serializer/EntrypointNormalizer.php
@@ -74,8 +74,15 @@ public function supportsNormalization(mixed $data, string $format = null, array
         return self::FORMAT === $format && $data instanceof Entrypoint;
     }
 
+    public function getSupportedTypes($format): array
+    {
+        return self::FORMAT === $format ? [Entrypoint::class => true] : [];
+    }
+
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return true;
     }
 }
diff --git a/src/Hal/Serializer/ItemNormalizer.php b/src/Hal/Serializer/ItemNormalizer.php
@@ -46,6 +46,11 @@ public function supportsNormalization(mixed $data, string $format = null, array
         return self::FORMAT === $format && parent::supportsNormalization($data, $format, $context);
     }
 
+    public function getSupportedTypes($format): array
+    {
+        return self::FORMAT === $format ? parent::getSupportedTypes($format) : [];
+    }
+
     /**
      * {@inheritdoc}
      */

diff --git a/src/Hal/Serializer/ObjectNormalizer.php b/src/Hal/Serializer/ObjectNormalizer.php
@@ -39,11 +39,25 @@ public function supportsNormalization(mixed $data, string $format = null, array
         return self::FORMAT === $format && $this->decorated->supportsNormalization($data, $format, $context);
     }
 
+    public function getSupportedTypes($format): array
+    {
+        // @deprecated remove condition when support for symfony versions under 6.3 is dropped
+        if (!method_exists($this->decorated, 'getSupportedTypes')) {
+            return [
+                '*' => $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod(),
+            ];
+        }
+
+        return self::FORMAT === $format ? $this->decorated->getSupportedTypes($format) : [];
+    }
+
     /**
      * {@inheritdoc}
      */
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();
     }
 

diff --git a/src/Hydra/Serializer/CollectionFiltersNormalizer.php b/src/Hydra/Serializer/CollectionFiltersNormalizer.php
@@ -50,8 +50,20 @@ public function supportsNormalization(mixed $data, string $format = null, array
         return $this->collectionNormalizer->supportsNormalization($data, $format, $context);
     }
 
+    public function getSupportedTypes($format): array
+    {
+        // @deprecated remove condition when support for symfony versions under 6.3 is dropped
+        if (!method_exists($this->collectionNormalizer, 'getSupportedTypes')) {
+            return ['*' => $this->collectionNormalizer instanceof CacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod()];
+        }
+
+        return $this->collectionNormalizer->getSupportedTypes($format);
+    }
+
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return $this->collectionNormalizer instanceof CacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod();
     }
 

diff --git a/src/Hydra/Serializer/DocumentationNormalizer.php b/src/Hydra/Serializer/DocumentationNormalizer.php
@@ -544,8 +544,15 @@ public function supportsNormalization(mixed $data, string $format = null, array
         return self::FORMAT === $format && $data instanceof Documentation;
     }
 
+    public function getSupportedTypes($format): array
+    {
+        return self::FORMAT === $format ? [Documentation::class => true] : [];
+    }
+
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return true;
     }
 }
diff --git a/src/Hydra/Serializer/EntrypointNormalizer.php b/src/Hydra/Serializer/EntrypointNormalizer.php
@@ -83,8 +83,15 @@ public function supportsNormalization(mixed $data, string $format = null, array
         return self::FORMAT === $format && $data instanceof Entrypoint;
     }
 
+    public function getSupportedTypes($format): array
+    {
+        return self::FORMAT === $format ? [Entrypoint::class => true] : [];
+    }
+
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return true;
     }
 }
diff --git a/src/Hydra/Serializer/ErrorNormalizer.php b/src/Hydra/Serializer/ErrorNormalizer.php
@@ -65,8 +65,22 @@ public function supportsNormalization(mixed $data, string $format = null, array
         return self::FORMAT === $format && ($data instanceof \Exception || $data instanceof FlattenException);
     }
 
+    public function getSupportedTypes($format): array
+    {
+        if (self::FORMAT === $format) {
+            return [
+                \Exception::class => true,
+                FlattenException::class => true,
+            ];
+        }
+
+        return [];
+    }
+
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return true;
     }
 }
diff --git a/src/Hydra/Serializer/PartialCollectionViewNormalizer.php b/src/Hydra/Serializer/PartialCollectionViewNormalizer.php
@@ -106,8 +106,22 @@ public function supportsNormalization(mixed $data, string $format = null, array
         return $this->collectionNormalizer->supportsNormalization($data, $format, $context);
     }
 
+    public function getSupportedTypes($format): array
+    {
+        // @deprecated remove condition when support for symfony versions under 6.3 is dropped
+        if (!method_exists($this->collectionNormalizer, 'getSupportedTypes')) {
+            return [
+                '*' => $this->collectionNormalizer instanceof CacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod(),
+            ];
+        }
+
+        return $this->collectionNormalizer->getSupportedTypes($format);
+    }
+
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return $this->collectionNormalizer instanceof CacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod();
     }
 

diff --git a/src/JsonApi/Serializer/ConstraintViolationListNormalizer.php b/src/JsonApi/Serializer/ConstraintViolationListNormalizer.php
@@ -59,8 +59,15 @@ public function supportsNormalization(mixed $data, string $format = null, array
         return self::FORMAT === $format && $data instanceof ConstraintViolationListInterface;
     }
 
+    public function getSupportedTypes($format): array
+    {
+        return (self::FORMAT === $format) ? [ConstraintViolationListInterface::class => true] : [];
+    }
+
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return true;
     }
 

diff --git a/src/JsonApi/Serializer/EntrypointNormalizer.php b/src/JsonApi/Serializer/EntrypointNormalizer.php
@@ -74,8 +74,15 @@ public function supportsNormalization(mixed $data, string $format = null, array
         return self::FORMAT === $format && $data instanceof Entrypoint;
     }
 
+    public function getSupportedTypes($format): array
+    {
+        return self::FORMAT === $format ? [Entrypoint::class => true] : [];
+    }
+
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return true;
     }
 }
diff --git a/src/JsonApi/Serializer/ErrorNormalizer.php b/src/JsonApi/Serializer/ErrorNormalizer.php
@@ -67,8 +67,22 @@ public function supportsNormalization(mixed $data, string $format = null, array
         return self::FORMAT === $format && ($data instanceof \Exception || $data instanceof FlattenException);
     }
 
+    public function getSupportedTypes($format): array
+    {
+        if (self::FORMAT === $format) {
+            return [
+                \Exception::class => true,
+                FlattenException::class => true,
+            ];
+        }
+
+        return [];
+    }
+
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return true;
     }
 }
diff --git a/src/JsonApi/Serializer/ItemNormalizer.php b/src/JsonApi/Serializer/ItemNormalizer.php
@@ -65,6 +65,11 @@ public function supportsNormalization(mixed $data, string $format = null, array
         return self::FORMAT === $format && parent::supportsNormalization($data, $format, $context);
     }
 
+    public function getSupportedTypes($format): array
+    {
+        return self::FORMAT === $format ? parent::getSupportedTypes($format) : [];
+    }
+
     /**
      * {@inheritdoc}
      */

diff --git a/src/JsonApi/Serializer/ObjectNormalizer.php b/src/JsonApi/Serializer/ObjectNormalizer.php
@@ -42,8 +42,22 @@ public function supportsNormalization(mixed $data, string $format = null, array
         return self::FORMAT === $format && $this->decorated->supportsNormalization($data, $format, $context);
     }
 
+    public function getSupportedTypes($format): array
+    {
+        // @deprecated remove condition when support for symfony versions under 6.3 is dropped
+        if (!method_exists($this->decorated, 'getSupportedTypes')) {
+            return [
+                '*' => $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod(),
+            ];
+        }
+
+        return self::FORMAT === $format ? $this->decorated->getSupportedTypes($format) : [];
+    }
+
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();
     }
 

diff --git a/src/JsonLd/Serializer/ItemNormalizer.php b/src/JsonLd/Serializer/ItemNormalizer.php
@@ -58,6 +58,11 @@ public function supportsNormalization(mixed $data, string $format = null, array
         return self::FORMAT === $format && parent::supportsNormalization($data, $format, $context);
     }
 
+    public function getSupportedTypes($format): array
+    {
+        return self::FORMAT === $format ? parent::getSupportedTypes($format) : [];
+    }
+
     /**
      * {@inheritdoc}
      *

diff --git a/src/JsonLd/Serializer/ObjectNormalizer.php b/src/JsonLd/Serializer/ObjectNormalizer.php
@@ -41,8 +41,22 @@ public function supportsNormalization(mixed $data, string $format = null, array
         return self::FORMAT === $format && $this->decorated->supportsNormalization($data, $format, $context);
     }
 
+    public function getSupportedTypes($format): array
+    {
+        // @deprecated remove condition when support for symfony versions under 6.3 is dropped
+        if (!method_exists($this->decorated, 'getSupportedTypes')) {
+            return [
+                '*' => $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod(),
+            ];
+        }
+
+        return self::FORMAT === $format ? $this->decorated->getSupportedTypes($format) : [];
+    }
+
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();
     }