symfony · fabpot · Jan 9, 2022 · Jan 7, 2022
diff --git a/UPGRADE-6.1.md b/UPGRADE-6.1.md
@@ -0,0 +1,10 @@
+UPGRADE FROM 6.0 to 6.1
+=======================
+
+Serializer
+----------
+
+ * Deprecate `ContextAwareNormalizerInterface`, use `NormalizerInterface` instead
+ * Deprecate `ContextAwareDenormalizerInterface`, use `DenormalizerInterface` instead
+ * Deprecate `ContextAwareEncoderInterface`, use `EncoderInterface` instead
+ * Deprecate `ContextAwareDecoderInterface`, use `DecoderInterface` instead
@@ -1,6 +1,14 @@
 CHANGELOG
 =========

+6.1
+---
+
+ * Deprecate `ContextAwareNormalizerInterface`, use `NormalizerInterface` instead
+ * Deprecate `ContextAwareDenormalizerInterface`, use `DenormalizerInterface` instead
+ * Deprecate `ContextAwareEncoderInterface`, use `EncoderInterface` instead
+ * Deprecate `ContextAwareDecoderInterface`, use `DecoderInterface` instead
+
 6.0
 ---


@@ -15,6 +15,8 @@
 * Adds the support of an extra $context parameter for the supportsDecoding method.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
+ *
+ * @deprecated since symfony/serializer 6.1, use DecoderInterface instead
 */
 interface ContextAwareDecoderInterface extends DecoderInterface
 {

@@ -15,6 +15,8 @@
 * Adds the support of an extra $context parameter for the supportsEncoding method.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
+ *
+ * @deprecated since symfony/serializer 6.1, use EncoderInterface instead
 */
 interface ContextAwareEncoderInterface extends EncoderInterface
 {

@@ -123,8 +123,10 @@ public function encode(mixed $data, string $format, array $context = []): string

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsEncoding(string $format): bool
+    public function supportsEncoding(string $format /*, array $context = [] */): bool
    {
        return self::FORMAT === $format;
    }
@@ -209,8 +211,10 @@ public function decode(string $data, string $format, array $context = []): mixed

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsDecoding(string $format): bool
+    public function supportsDecoding(string $format /*, array $context = [] */): bool
    {
        return self::FORMAT === $format;
    }

@@ -40,8 +40,9 @@ public function decode(string $data, string $format, array $context = []);
     * Checks whether the deserializer can decode from given format.
     *
     * @param string $format Format name
+     * @param array  $context Options that decoders have access to
     *
     * @return bool
     */
-    public function supportsDecoding(string $format);
+    public function supportsDecoding(string $format /*, array $context = [] */);
 }
@@ -32,7 +32,8 @@ public function encode(mixed $data, string $format, array $context = []): string
    /**
     * Checks whether the serializer can encode to given format.
     *
-     * @param string $format Format name
+     * @param string $format  Format name
+     * @param array  $context Options that normalizers/encoders have access to
     */
-    public function supportsEncoding(string $format): bool;
+    public function supportsEncoding(string $format /*, array $context = [] */): bool;
 }
@@ -95,8 +95,10 @@ public function decode(string $data, string $format, array $context = []): mixed

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsDecoding(string $format): bool
+    public function supportsDecoding(string $format /*, array $context = [] */): bool
    {
        return JsonEncoder::FORMAT === $format;
    }

@@ -57,8 +57,10 @@ public function encode(mixed $data, string $format, array $context = []): string

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsEncoding(string $format): bool
+    public function supportsEncoding(string $format /*, array $context = [] */): bool
    {
        return JsonEncoder::FORMAT === $format;
    }

@@ -47,16 +47,20 @@ public function decode(string $data, string $format, array $context = []): mixed

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsEncoding(string $format): bool
+    public function supportsEncoding(string $format /*, array $context = [] */): bool
    {
        return self::FORMAT === $format;
    }

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsDecoding(string $format): bool
+    public function supportsDecoding(string $format /*, array $context = [] */): bool
    {
        return self::FORMAT === $format;
    }

@@ -174,16 +174,20 @@ public function decode(string $data, string $format, array $context = []): mixed

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsEncoding(string $format): bool
+    public function supportsEncoding(string $format /*, array $context = [] */): bool
    {
        return self::FORMAT === $format;
    }

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsDecoding(string $format): bool
+    public function supportsDecoding(string $format /*, array $context = [] */): bool
    {
        return self::FORMAT === $format;
    }

@@ -67,8 +67,10 @@ public function encode(mixed $data, string $format, array $context = []): string

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsEncoding(string $format): bool
+    public function supportsEncoding(string $format /*, array $context = [] */): bool
    {
        return self::FORMAT === $format || self::ALTERNATIVE_FORMAT === $format;
    }
@@ -85,8 +87,10 @@ public function decode(string $data, string $format, array $context = []): mixed

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsDecoding(string $format): bool
+    public function supportsDecoding(string $format /*, array $context = [] */): bool
    {
        return self::FORMAT === $format || self::ALTERNATIVE_FORMAT === $format;
    }

@@ -134,8 +134,10 @@ public function __construct(ClassMetadataFactoryInterface $classMetadataFactory

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsNormalization(mixed $data, string $format = null)
+    public function supportsNormalization(mixed $data, string $format = null /*, array $context = [] */)
    {
        return \is_object($data) && !$data instanceof \Traversable;
    }
@@ -349,8 +351,10 @@ abstract protected function getAttributeValue(object $object, string $attribute,

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsDenormalization(mixed $data, string $type, string $format = null)
+    public function supportsDenormalization(mixed $data, string $type, string $format = null /*, array $context = [] */)
    {
        return class_exists($type) || (interface_exists($type, false) && $this->classDiscriminatorResolver && null !== $this->classDiscriminatorResolver->getMappingForClass($type));
    }

@@ -37,7 +37,7 @@ public function normalize($object, $format = null, array $context = []): int|str
    /**
     * {@inheritdoc}
     */
-    public function supportsNormalization($data, $format = null): bool
+    public function supportsNormalization($data, $format = null, array $context = []): bool
    {
        return $data instanceof \BackedEnum;
    }
@@ -67,7 +67,7 @@ public function denormalize($data, $type, $format = null, array $context = []):
    /**
     * {@inheritdoc}
     */
-    public function supportsDenormalization($data, $type, $format = null): bool
+    public function supportsDenormalization($data, $type, $format = null, array $context = []): bool
    {
        return is_subclass_of($type, \BackedEnum::class);
    }

@@ -106,8 +106,10 @@ public function normalize(mixed $object, string $format = null, array $context =

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsNormalization(mixed $data, string $format = null): bool
+    public function supportsNormalization(mixed $data, string $format = null /*, array $context = [] */): bool
    {
        return $data instanceof ConstraintViolationListInterface;
    }

@@ -15,6 +15,8 @@
 * Adds the support of an extra $context parameter for the supportsDenormalization method.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
+ *
+ * @deprecated since symfony/serializer 6.1, use DenormalizerInterface instead
 */
 interface ContextAwareDenormalizerInterface extends DenormalizerInterface
 {

@@ -15,6 +15,8 @@
 * Adds the support of an extra $context parameter for the supportsNormalization method.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
+ *
+ * @deprecated since symfony/serializer 6.1, use NormalizerInterface instead
 */
 interface ContextAwareNormalizerInterface extends NormalizerInterface
 {

@@ -44,22 +44,24 @@ public function denormalize(mixed $data, string $type, string $format = null, ar
    /**
     * Checks if the given class implements the NormalizableInterface.
     *
-     * @param mixed  $data   Data to normalize
-     * @param string $format The format being (de-)serialized from or into
+     * @param mixed  $data    Data to normalize
+     * @param string $format  The format being (de-)serialized from or into
+     * @param array  $context
     */
-    public function supportsNormalization(mixed $data, string $format = null): bool
+    public function supportsNormalization(mixed $data, string $format = null /*, array $context = [] */): bool
    {
        return $data instanceof NormalizableInterface;
    }

    /**
     * Checks if the given class implements the DenormalizableInterface.
     *
-     * @param mixed  $data   Data to denormalize from
-     * @param string $type   The class to which the data should be denormalized
-     * @param string $format The format being deserialized from
+     * @param mixed  $data    Data to denormalize from
+     * @param string $type    The class to which the data should be denormalized
+     * @param string $format  The format being deserialized from
+     * @param array  $context
     */
-    public function supportsDenormalization(mixed $data, string $type, string $format = null): bool
+    public function supportsDenormalization(mixed $data, string $type, string $format = null /*, array $context = [] */): bool
    {
        return is_subclass_of($type, DenormalizableInterface::class);
    }

@@ -73,8 +73,10 @@ public function normalize(mixed $object, string $format = null, array $context =

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsNormalization(mixed $data, string $format = null): bool
+    public function supportsNormalization(mixed $data, string $format = null /*, array $context = [] */): bool
    {
        return $data instanceof \SplFileInfo;
    }
@@ -117,8 +119,10 @@ public function denormalize(mixed $data, string $type, string $format = null, ar

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsDenormalization(mixed $data, string $type, string $format = null): bool
+    public function supportsDenormalization(mixed $data, string $type, string $format = null /*, array $context = [] */): bool
    {
        return isset(self::SUPPORTED_TYPES[$type]);
    }

@@ -49,8 +49,10 @@ public function normalize(mixed $object, string $format = null, array $context =

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsNormalization(mixed $data, string $format = null): bool
+    public function supportsNormalization(mixed $data, string $format = null /*, array $context = [] */): bool
    {
        return $data instanceof \DateInterval;
    }
@@ -117,8 +119,10 @@ public function denormalize(mixed $data, string $type, string $format = null, ar

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsDenormalization(mixed $data, string $type, string $format = null): bool
+    public function supportsDenormalization(mixed $data, string $type, string $format = null /*, array $context = [] */): bool
    {
        return \DateInterval::class === $type;
    }

@@ -71,8 +71,10 @@ public function normalize(mixed $object, string $format = null, array $context =

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsNormalization(mixed $data, string $format = null): bool
+    public function supportsNormalization(mixed $data, string $format = null /*, array $context = [] */): bool
    {
        return $data instanceof \DateTimeInterface;
    }
@@ -112,8 +114,10 @@ public function denormalize(mixed $data, string $type, string $format = null, ar

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsDenormalization(mixed $data, string $type, string $format = null): bool
+    public function supportsDenormalization(mixed $data, string $type, string $format = null /*, array $context = [] */): bool
    {
        return isset(self::SUPPORTED_TYPES[$type]);
    }

@@ -38,8 +38,10 @@ public function normalize(mixed $object, string $format = null, array $context =

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsNormalization(mixed $data, string $format = null): bool
+    public function supportsNormalization(mixed $data, string $format = null /*, array $context = [] */): bool
    {
        return $data instanceof \DateTimeZone;
    }
@@ -64,8 +66,10 @@ public function denormalize(mixed $data, string $type, string $format = null, ar

    /**
     * {@inheritdoc}
+     *
+     * @param array $context
     */
-    public function supportsDenormalization(mixed $data, string $type, string $format = null): bool
+    public function supportsDenormalization(mixed $data, string $type, string $format = null /*, array $context = [] */): bool
    {
        return \DateTimeZone::class === $type;
    }