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

Author: mrossard

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}
  *

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,
+ ];
+ }
 }

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,
+ ];
+ }
 }

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,
+ ];
+ }
 }

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,
+ ];
+ }
 }

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}
  *

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();
  }
 

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;
  }
 }

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}
  */

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();
  }