[Serializer] Rename CacheableSupportsMethodInterface to SupportsVaryInterface

teohhanhui · teohhanhui · commit 72de9df726f2 · 2018-05-09T14:49:14.000+02:00
diff --git a/src/Symfony/Component/Serializer/CHANGELOG.md b/src/Symfony/Component/Serializer/CHANGELOG.md
@@ -4,7 +4,7 @@ CHANGELOG
 4.1.0
 -----
 
-* added `CacheableSupportsMethodInterface` for normalizers and denormalizers that use
+* added `SupportsVaryInterface` for normalizers and denormalizers that use
   only the type and the format in their `supports*()` methods
 * added `MissingConstructorArgumentsException` new exception for deserialization failure
   of objects that needs data insertion in constructor
diff --git a/src/Symfony/Component/Serializer/Normalizer/AbstractNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/AbstractNormalizer.php
@@ -27,7 +27,7 @@
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
-abstract class AbstractNormalizer implements NormalizerInterface, DenormalizerInterface, SerializerAwareInterface, CacheableSupportsMethodInterface
+abstract class AbstractNormalizer implements NormalizerInterface, DenormalizerInterface, SerializerAwareInterface, SupportsVaryInterface
 {
     use ObjectToPopulateTrait;
     use SerializerAwareTrait;
@@ -150,9 +150,9 @@ public function setIgnoredAttributes(array $ignoredAttributes)
     /**
      * {@inheritdoc}
      */
-    public function hasCacheableSupportsMethod(): bool
+    public function isSupportsVaryByData(): bool
     {
-        return false;
+        return true;
     }
 
     /**
diff --git a/src/Symfony/Component/Serializer/Normalizer/ArrayDenormalizer.php b/src/Symfony/Component/Serializer/Normalizer/ArrayDenormalizer.php
@@ -24,7 +24,7 @@
  *
  * @final
  */
-class ArrayDenormalizer implements ContextAwareDenormalizerInterface, SerializerAwareInterface, CacheableSupportsMethodInterface
+class ArrayDenormalizer implements ContextAwareDenormalizerInterface, SerializerAwareInterface, SupportsVaryInterface
 {
     /**
      * @var SerializerInterface|DenormalizerInterface
@@ -87,8 +87,8 @@ public function setSerializer(SerializerInterface $serializer)
     /**
      * {@inheritdoc}
      */
-    public function hasCacheableSupportsMethod(): bool
+    public function isSupportsVaryByData(): bool
     {
-        return $this->serializer instanceof CacheableSupportsMethodInterface && $this->serializer->hasCacheableSupportsMethod();
+        return !$this->serializer instanceof SupportsVaryInterface || $this->serializer->isSupportsVaryByData();
     }
 }
diff --git a/src/Symfony/Component/Serializer/Normalizer/CacheableSupportsMethodInterface.php b/src/Symfony/Component/Serializer/Normalizer/CacheableSupportsMethodInterface.php
diff --git a/src/Symfony/Component/Serializer/Normalizer/ConstraintViolationListNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/ConstraintViolationListNormalizer.php
@@ -22,7 +22,7 @@
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
-class ConstraintViolationListNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
+class ConstraintViolationListNormalizer implements NormalizerInterface, SupportsVaryInterface
 {
     /**
      * {@inheritdoc}
@@ -60,8 +60,8 @@ public function supportsNormalization($data, $format = null)
     /**
      * {@inheritdoc}
      */
-    public function hasCacheableSupportsMethod(): bool
+    public function isSupportsVaryByData(): bool
     {
-        return __CLASS__ === \get_class($this);
+        return __CLASS__ !== \get_class($this);
     }
 }
diff --git a/src/Symfony/Component/Serializer/Normalizer/CustomNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/CustomNormalizer.php
@@ -17,7 +17,7 @@
 /**
  * @author Jordi Boggiano <j.boggiano@seld.be>
  */
-class CustomNormalizer implements NormalizerInterface, DenormalizerInterface, SerializerAwareInterface, CacheableSupportsMethodInterface
+class CustomNormalizer implements NormalizerInterface, DenormalizerInterface, SerializerAwareInterface, SupportsVaryInterface
 {
     use ObjectToPopulateTrait;
     use SerializerAwareTrait;
@@ -71,8 +71,8 @@ public function supportsDenormalization($data, $type, $format = null)
     /**
      * {@inheritdoc}
      */
-    public function hasCacheableSupportsMethod(): bool
+    public function isSupportsVaryByData(): bool
     {
-        return __CLASS__ === \get_class($this);
+        return __CLASS__ !== \get_class($this);
     }
 }
diff --git a/src/Symfony/Component/Serializer/Normalizer/DataUriNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/DataUriNormalizer.php
@@ -23,7 +23,7 @@
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
-class DataUriNormalizer implements NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface
+class DataUriNormalizer implements NormalizerInterface, DenormalizerInterface, SupportsVaryInterface
 {
     private static $supportedTypes = array(
         \SplFileInfo::class => true,
@@ -122,9 +122,9 @@ public function supportsDenormalization($data, $type, $format = null)
     /**
      * {@inheritdoc}
      */
-    public function hasCacheableSupportsMethod(): bool
+    public function isSupportsVaryByData(): bool
     {
-        return __CLASS__ === \get_class($this);
+        return __CLASS__ !== \get_class($this);
     }
 
     /**
diff --git a/src/Symfony/Component/Serializer/Normalizer/DateIntervalNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/DateIntervalNormalizer.php
@@ -20,7 +20,7 @@
  *
  * @author Jérôme Parmentier <jerome@prmntr.me>
  */
-class DateIntervalNormalizer implements NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface
+class DateIntervalNormalizer implements NormalizerInterface, DenormalizerInterface, SupportsVaryInterface
 {
     const FORMAT_KEY = 'dateinterval_format';
 
@@ -58,9 +58,9 @@ public function supportsNormalization($data, $format = null)
     /**
      * {@inheritdoc}
      */
-    public function hasCacheableSupportsMethod(): bool
+    public function isSupportsVaryByData(): bool
     {
-        return __CLASS__ === \get_class($this);
+        return __CLASS__ !== \get_class($this);
     }
 
     /**
diff --git a/src/Symfony/Component/Serializer/Normalizer/DateTimeNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/DateTimeNormalizer.php
@@ -20,7 +20,7 @@
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
-class DateTimeNormalizer implements NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface
+class DateTimeNormalizer implements NormalizerInterface, DenormalizerInterface, SupportsVaryInterface
 {
     const FORMAT_KEY = 'datetime_format';
     const TIMEZONE_KEY = 'datetime_timezone';
@@ -119,9 +119,9 @@ public function supportsDenormalization($data, $type, $format = null)
     /**
      * {@inheritdoc}
      */
-    public function hasCacheableSupportsMethod(): bool
+    public function isSupportsVaryByData(): bool
     {
-        return __CLASS__ === \get_class($this);
+        return __CLASS__ !== \get_class($this);
     }
 
     /**
diff --git a/src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php
@@ -55,9 +55,9 @@ public function supportsDenormalization($data, $type, $format = null)
     /**
      * {@inheritdoc}
      */
-    public function hasCacheableSupportsMethod(): bool
+    public function isSupportsVaryByData(): bool
     {
-        return __CLASS__ === \get_class($this);
+        return __CLASS__ !== \get_class($this);
     }
 
     /**
diff --git a/src/Symfony/Component/Serializer/Normalizer/JsonSerializableNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/JsonSerializableNormalizer.php
@@ -68,8 +68,8 @@ public function denormalize($data, $class, $format = null, array $context = arra
     /**
      * {@inheritdoc}
      */
-    public function hasCacheableSupportsMethod(): bool
+    public function isSupportsVaryByData(): bool
     {
-        return __CLASS__ === \get_class($this);
+        return __CLASS__ !== \get_class($this);
     }
 }
diff --git a/src/Symfony/Component/Serializer/Normalizer/ObjectNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/ObjectNormalizer.php
@@ -43,9 +43,9 @@ public function __construct(ClassMetadataFactoryInterface $classMetadataFactory
     /**
      * {@inheritdoc}
      */
-    public function hasCacheableSupportsMethod(): bool
+    public function isSupportsVaryByData(): bool
     {
-        return __CLASS__ === \get_class($this);
+        return __CLASS__ !== \get_class($this);
     }
 
     /**
diff --git a/src/Symfony/Component/Serializer/Normalizer/PropertyNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/PropertyNormalizer.php
@@ -49,9 +49,9 @@ public function supportsDenormalization($data, $type, $format = null)
     /**
      * {@inheritdoc}
      */
-    public function hasCacheableSupportsMethod(): bool
+    public function isSupportsVaryByData(): bool
     {
-        return __CLASS__ === \get_class($this);
+        return __CLASS__ !== \get_class($this);
     }
 
     /**
diff --git a/src/Symfony/Component/Serializer/Normalizer/SupportsVaryInterface.php b/src/Symfony/Component/Serializer/Normalizer/SupportsVaryInterface.php
@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Serializer\Normalizer;
+
+/**
+ * Defines how normalizers and denormalizers vary their supports*() methods.
+ *
+ * @author Kévin Dunglas <dunglas@gmail.com>
+ */
+interface SupportsVaryInterface
+{
+    /**
+     * Checks whether the return value of supports*() methods varies by the $data
+     * argument.
+     *
+     * If this method returns false, the return value of the supports*() methods
+     * will be cached by type and format.
+     */
+    public function isSupportsVaryByData(): bool;
+}
diff --git a/src/Symfony/Component/Serializer/Serializer.php b/src/Symfony/Component/Serializer/Serializer.php
@@ -19,13 +19,13 @@
 use Symfony\Component\Serializer\Encoder\DecoderInterface;
 use Symfony\Component\Serializer\Exception\NotEncodableValueException;
 use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
-use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\ContextAwareDenormalizerInterface;
 use Symfony\Component\Serializer\Normalizer\ContextAwareNormalizerInterface;
 use Symfony\Component\Serializer\Normalizer\DenormalizerAwareInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
+use Symfony\Component\Serializer\Normalizer\SupportsVaryInterface;
 use Symfony\Component\Serializer\Exception\LogicException;
 
 /**
@@ -221,7 +221,7 @@ private function getNormalizer($data, ?string $format, array $context)
                     continue;
                 }
 
-                if (!$normalizer instanceof CacheableSupportsMethodInterface || !$normalizer->hasCacheableSupportsMethod()) {
+                if (!$normalizer instanceof SupportsVaryInterface || $normalizer->isSupportsVaryByData()) {
                     $this->normalizerCache[$format][$type][$k] = false;
                 } elseif ($normalizer->supportsNormalization($data, $format)) {
                     $this->normalizerCache[$format][$type][$k] = true;
@@ -262,7 +262,7 @@ private function getDenormalizer($data, string $class, ?string $format, array $c
                     continue;
                 }
 
-                if (!$normalizer instanceof CacheableSupportsMethodInterface || !$normalizer->hasCacheableSupportsMethod()) {
+                if (!$normalizer instanceof SupportsVaryInterface || $normalizer->isSupportsVaryByData()) {
                     $this->denormalizerCache[$format][$class][$k] = false;
                 } elseif ($normalizer->supportsDenormalization(null, $class, $format)) {
                     $this->denormalizerCache[$format][$class][$k] = true;

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`*`
`28`	`28`	`* @author Kévin Dunglas <dunglas@gmail.com>`
`29`	`29`	`*/`
`30`		`-abstract class AbstractNormalizer implements NormalizerInterface, DenormalizerInterface, SerializerAwareInterface, CacheableSupportsMethodInterface`
	`30`	`+abstract class AbstractNormalizer implements NormalizerInterface, DenormalizerInterface, SerializerAwareInterface, SupportsVaryInterface`
`31`	`31`	`{`
`32`	`32`	`use ObjectToPopulateTrait;`
`33`	`33`	`use SerializerAwareTrait;`
`@@ -150,9 +150,9 @@ public function setIgnoredAttributes(array $ignoredAttributes)`
`150`	`150`	`/**`
`151`	`151`	`* {@inheritdoc}`
`152`	`152`	`*/`
`153`		`- public function hasCacheableSupportsMethod(): bool`
	`153`	`+ public function isSupportsVaryByData(): bool`
`154`	`154`	`{`
`155`		`- return false;`
	`155`	`+ return true;`
`156`	`156`	`}`
`157`	`157`
`158`	`158`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`*`
`25`	`25`	`* @final`
`26`	`26`	`*/`
`27`		`-class ArrayDenormalizer implements ContextAwareDenormalizerInterface, SerializerAwareInterface, CacheableSupportsMethodInterface`
	`27`	`+class ArrayDenormalizer implements ContextAwareDenormalizerInterface, SerializerAwareInterface, SupportsVaryInterface`
`28`	`28`	`{`
`29`	`29`	`/**`
`30`	`30`	`* @var SerializerInterface\|DenormalizerInterface`
`@@ -87,8 +87,8 @@ public function setSerializer(SerializerInterface $serializer)`
`87`	`87`	`/**`
`88`	`88`	`* {@inheritdoc}`
`89`	`89`	`*/`
`90`		`- public function hasCacheableSupportsMethod(): bool`
	`90`	`+ public function isSupportsVaryByData(): bool`
`91`	`91`	`{`
`92`		`- return $this->serializer instanceof CacheableSupportsMethodInterface && $this->serializer->hasCacheableSupportsMethod();`
	`92`	`+ return !$this->serializer instanceof SupportsVaryInterface \|\| $this->serializer->isSupportsVaryByData();`
`93`	`93`	`}`
`94`	`94`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`* @author Grégoire Pineau <lyrixx@lyrixx.info>`
`23`	`23`	`* @author Kévin Dunglas <dunglas@gmail.com>`
`24`	`24`	`*/`
`25`		`-class ConstraintViolationListNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface`
	`25`	`+class ConstraintViolationListNormalizer implements NormalizerInterface, SupportsVaryInterface`
`26`	`26`	`{`
`27`	`27`	`/**`
`28`	`28`	`* {@inheritdoc}`
`@@ -60,8 +60,8 @@ public function supportsNormalization($data, $format = null)`
`60`	`60`	`/**`
`61`	`61`	`* {@inheritdoc}`
`62`	`62`	`*/`
`63`		`- public function hasCacheableSupportsMethod(): bool`
	`63`	`+ public function isSupportsVaryByData(): bool`
`64`	`64`	`{`
`65`		`- return __CLASS__ === \get_class($this);`
	`65`	`+ return __CLASS__ !== \get_class($this);`
`66`	`66`	`}`
`67`	`67`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`/**`
`18`	`18`	`* @author Jordi Boggiano <j.boggiano@seld.be>`
`19`	`19`	`*/`
`20`		`-class CustomNormalizer implements NormalizerInterface, DenormalizerInterface, SerializerAwareInterface, CacheableSupportsMethodInterface`
	`20`	`+class CustomNormalizer implements NormalizerInterface, DenormalizerInterface, SerializerAwareInterface, SupportsVaryInterface`
`21`	`21`	`{`
`22`	`22`	`use ObjectToPopulateTrait;`
`23`	`23`	`use SerializerAwareTrait;`
`@@ -71,8 +71,8 @@ public function supportsDenormalization($data, $type, $format = null)`
`71`	`71`	`/**`
`72`	`72`	`* {@inheritdoc}`
`73`	`73`	`*/`
`74`		`- public function hasCacheableSupportsMethod(): bool`
	`74`	`+ public function isSupportsVaryByData(): bool`
`75`	`75`	`{`
`76`		`- return __CLASS__ === \get_class($this);`
	`76`	`+ return __CLASS__ !== \get_class($this);`
`77`	`77`	`}`
`78`	`78`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`*`
`24`	`24`	`* @author Kévin Dunglas <dunglas@gmail.com>`
`25`	`25`	`*/`
`26`		`-class DataUriNormalizer implements NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface`
	`26`	`+class DataUriNormalizer implements NormalizerInterface, DenormalizerInterface, SupportsVaryInterface`
`27`	`27`	`{`
`28`	`28`	`private static $supportedTypes = array(`
`29`	`29`	`\SplFileInfo::class => true,`
`@@ -122,9 +122,9 @@ public function supportsDenormalization($data, $type, $format = null)`
`122`	`122`	`/**`
`123`	`123`	`* {@inheritdoc}`
`124`	`124`	`*/`
`125`		`- public function hasCacheableSupportsMethod(): bool`
	`125`	`+ public function isSupportsVaryByData(): bool`
`126`	`126`	`{`
`127`		`- return __CLASS__ === \get_class($this);`
	`127`	`+ return __CLASS__ !== \get_class($this);`
`128`	`128`	`}`
`129`	`129`
`130`	`130`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`*`
`21`	`21`	`* @author Jérôme Parmentier <jerome@prmntr.me>`
`22`	`22`	`*/`
`23`		`-class DateIntervalNormalizer implements NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface`
	`23`	`+class DateIntervalNormalizer implements NormalizerInterface, DenormalizerInterface, SupportsVaryInterface`
`24`	`24`	`{`
`25`	`25`	`const FORMAT_KEY = 'dateinterval_format';`
`26`	`26`
`@@ -58,9 +58,9 @@ public function supportsNormalization($data, $format = null)`
`58`	`58`	`/**`
`59`	`59`	`* {@inheritdoc}`
`60`	`60`	`*/`
`61`		`- public function hasCacheableSupportsMethod(): bool`
	`61`	`+ public function isSupportsVaryByData(): bool`
`62`	`62`	`{`
`63`		`- return __CLASS__ === \get_class($this);`
	`63`	`+ return __CLASS__ !== \get_class($this);`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -55,9 +55,9 @@ public function supportsDenormalization($data, $type, $format = null)`
`55`	`55`	`/**`
`56`	`56`	`* {@inheritdoc}`
`57`	`57`	`*/`
`58`		`- public function hasCacheableSupportsMethod(): bool`
	`58`	`+ public function isSupportsVaryByData(): bool`
`59`	`59`	`{`
`60`		`- return __CLASS__ === \get_class($this);`
	`60`	`+ return __CLASS__ !== \get_class($this);`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`/**`