Merge pull request #1988 from dunglas/serializer-41

Implement CacheableSupportsMethodInterface introduced in Symfony 4.1

Author: dunglas

.travis.yml

@@ -13,7 +13,6 @@ env:
 
 matrix:
   include:
-    - php: '7.0'
     - php: '7.1'
     - php: '7.2'
     - php: '7.2'

composer.json

@@ -13,7 +13,7 @@
         }
     ],
     "require": {
-        "php": ">=7.0",
+        "php": ">=7.1",
 
         "doctrine/inflector": "^1.0",
         "psr/cache": "^1.0",
@@ -22,7 +22,7 @@
         "symfony/http-kernel": "^2.7 || ^3.0 || ^4.0",
         "symfony/property-access": "^2.7 || ^3.0 || ^4.0",
         "symfony/property-info": "^3.3.11 || ^4.0",
-        "symfony/serializer": "^3.1 || ^4.0",
+        "symfony/serializer": "^4.1",
         "willdurand/negotiation": "^2.0.3"
     },
     "require-dev": {

src/Hal/Serializer/EntrypointNormalizer.php

@@ -18,14 +18,15 @@
 use ApiPlatform\Core\Api\UrlGeneratorInterface;
 use ApiPlatform\Core\Exception\InvalidArgumentException;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
+use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
 /**
  * Normalizes the API entrypoint.
  *
  * @author Kévin Dunglas <[email protected]>
  */
-final class EntrypointNormalizer implements NormalizerInterface
+final class EntrypointNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
 {
     const FORMAT = 'jsonhal';
 
@@ -70,4 +71,12 @@ public function supportsNormalization($data, $format = null)
     {
         return self::FORMAT === $format && $data instanceof Entrypoint;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function hasCacheableSupportsMethod(): bool
+    {
+        return true;
+    }
 }

src/Hydra/Serializer/CollectionFiltersNormalizer.php

@@ -20,6 +20,7 @@
 use ApiPlatform\Core\JsonLd\Serializer\JsonLdContextTrait;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use Psr\Container\ContainerInterface;
+use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
@@ -28,7 +29,7 @@
  *
  * @author Samuel ROZE <[email protected]>
  */
-final class CollectionFiltersNormalizer implements NormalizerInterface, NormalizerAwareInterface
+final class CollectionFiltersNormalizer implements NormalizerInterface, NormalizerAwareInterface, CacheableSupportsMethodInterface
 {
     use JsonLdContextTrait;
     use FilterLocatorTrait;
@@ -57,6 +58,14 @@ public function supportsNormalization($data, $format = null)
         return $this->collectionNormalizer->supportsNormalization($data, $format);
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function hasCacheableSupportsMethod(): bool
+    {
+        return $this->collectionNormalizer instanceof CacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod();
+    }
+
     /**
      * {@inheritdoc}
      */

src/Hydra/Serializer/CollectionNormalizer.php

@@ -21,6 +21,7 @@
 use ApiPlatform\Core\JsonLd\ContextBuilderInterface;
 use ApiPlatform\Core\JsonLd\Serializer\JsonLdContextTrait;
 use ApiPlatform\Core\Serializer\ContextTrait;
+use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
@@ -31,7 +32,7 @@
  * @author Kevin Dunglas <[email protected]>
  * @author Samuel ROZE <[email protected]>
  */
-final class CollectionNormalizer implements NormalizerInterface, NormalizerAwareInterface
+final class CollectionNormalizer implements NormalizerInterface, NormalizerAwareInterface, CacheableSupportsMethodInterface
 {
     use ContextTrait;
     use JsonLdContextTrait;
@@ -100,4 +101,12 @@ public function normalize($object, $format = null, array $context = [])
 
         return $data;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function hasCacheableSupportsMethod(): bool
+    {
+        return true;
+    }
 }

src/Hydra/Serializer/DocumentationNormalizer.php

@@ -29,14 +29,15 @@
 use Symfony\Component\PropertyInfo\Type;
 use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
+use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
 /**
  * Creates a machine readable Hydra API documentation.
  *
  * @author Kévin Dunglas <[email protected]>
  */
-final class DocumentationNormalizer implements NormalizerInterface
+final class DocumentationNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
 {
     const FORMAT = 'jsonld';
 
@@ -581,4 +582,12 @@ public function supportsNormalization($data, $format = null, array $context = []
     {
         return self::FORMAT === $format && $data instanceof Documentation;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function hasCacheableSupportsMethod(): bool
+    {
+        return true;
+    }
 }

src/Hydra/Serializer/EntrypointNormalizer.php

@@ -18,14 +18,15 @@
 use ApiPlatform\Core\Api\UrlGeneratorInterface;
 use ApiPlatform\Core\Exception\InvalidArgumentException;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
+use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
 /**
  * Normalizes the API entrypoint.
  *
  * @author Kévin Dunglas <[email protected]>
  */
-final class EntrypointNormalizer implements NormalizerInterface
+final class EntrypointNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
 {
     const FORMAT = 'jsonld';
 
@@ -74,4 +75,12 @@ public function supportsNormalization($data, $format = null, array $context = []
     {
         return self::FORMAT === $format && $data instanceof Entrypoint;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function hasCacheableSupportsMethod(): bool
+    {
+        return true;
+    }
 }

src/Hydra/Serializer/ErrorNormalizer.php

@@ -16,6 +16,7 @@
 use ApiPlatform\Core\Api\UrlGeneratorInterface;
 use ApiPlatform\Core\Problem\Serializer\ErrorNormalizerTrait;
 use Symfony\Component\Debug\Exception\FlattenException;
+use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
 /**
@@ -24,7 +25,7 @@
  * @author Kévin Dunglas <[email protected]>
  * @author Samuel ROZE <[email protected]>
  */
-final class ErrorNormalizer implements NormalizerInterface
+final class ErrorNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
 {
     const FORMAT = 'jsonld';
 
@@ -65,4 +66,12 @@ public function supportsNormalization($data, $format = null)
     {
         return self::FORMAT === $format && ($data instanceof \Exception || $data instanceof FlattenException);
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function hasCacheableSupportsMethod(): bool
+    {
+        return true;
+    }
 }

src/Hydra/Serializer/PartialCollectionViewNormalizer.php

@@ -17,6 +17,7 @@
 use ApiPlatform\Core\DataProvider\PartialPaginatorInterface;
 use ApiPlatform\Core\JsonLd\Serializer\JsonLdContextTrait;
 use ApiPlatform\Core\Util\IriHelper;
+use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
@@ -26,7 +27,7 @@
  * @author Kévin Dunglas <[email protected]>
  * @author Samuel ROZE <[email protected]>
  */
-final class PartialCollectionViewNormalizer implements NormalizerInterface, NormalizerAwareInterface
+final class PartialCollectionViewNormalizer implements NormalizerInterface, NormalizerAwareInterface, CacheableSupportsMethodInterface
 {
     use JsonLdContextTrait;
 
@@ -102,6 +103,14 @@ public function supportsNormalization($data, $format = null)
         return $this->collectionNormalizer->supportsNormalization($data, $format);
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function hasCacheableSupportsMethod(): bool
+    {
+        return $this->collectionNormalizer instanceof CacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod();
+    }
+
     /**
      * {@inheritdoc}
      */

src/Identifier/Normalizer/DateTimeIdentifierDenormalizer.php

@@ -14,18 +14,25 @@
 namespace ApiPlatform\Core\Identifier\Normalizer;
 
 use ApiPlatform\Core\Exception\InvalidIdentifierException;
-use Symfony\Component\Serializer\Exception\InvalidArgumentException;
+use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
 use Symfony\Component\Serializer\Normalizer\DateTimeNormalizer;
-use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
 
-final class DateTimeIdentifierDenormalizer extends DateTimeNormalizer implements DenormalizerInterface
+final class DateTimeIdentifierDenormalizer extends DateTimeNormalizer
 {
     public function denormalize($data, $class, $format = null, array $context = [])
     {
         try {
             return parent::denormalize($data, $class, $format, $context);
-        } catch (InvalidArgumentException $e) {
+        } catch (NotNormalizableValueException $e) {
             throw new InvalidIdentifierException($e->getMessage(), $e->getCode(), $e);
         }
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function hasCacheableSupportsMethod(): bool
+    {
+        return true;
+    }
 }