[Form] Add generics to DataTransformerInterface

VincentLanglet · fabpot · commit 8778f5e060d6 · 2022-09-13T08:32:14.000+02:00
diff --git a/DataTransformerInterface.php b/DataTransformerInterface.php
@@ -17,6 +17,9 @@
  * Transforms a value between different representations.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @template TValue
+ * @template TTransformedValue
  */
 interface DataTransformerInterface
 {
@@ -53,9 +56,9 @@ interface DataTransformerInterface
      * of the first data transformer outputs NULL, the second must be able to
      * process that value.
      *
-     * @param mixed $value The value in the original representation
+     * @param TValue|null $value The value in the original representation
      *
-     * @return mixed
+     * @return TTransformedValue|null
      *
      * @throws TransformationFailedException when the transformation fails
      */
@@ -82,9 +85,9 @@ public function transform(mixed $value);
      * By convention, reverseTransform() should return NULL if an empty string
      * is passed.
      *
-     * @param mixed $value The value in the transformed representation
+     * @param TTransformedValue|null $value The value in the transformed representation
      *
-     * @return mixed
+     * @return TValue|null
      *
      * @throws TransformationFailedException when the transformation fails
      */
diff --git a/Extension/Core/DataTransformer/ArrayToPartsTransformer.php b/Extension/Core/DataTransformer/ArrayToPartsTransformer.php
@@ -16,6 +16,8 @@
 
 /**
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @implements DataTransformerInterface<array, array>
  */
 class ArrayToPartsTransformer implements DataTransformerInterface
 {
diff --git a/Extension/Core/DataTransformer/BaseDateTimeTransformer.php b/Extension/Core/DataTransformer/BaseDateTimeTransformer.php
@@ -14,6 +14,10 @@
 use Symfony\Component\Form\DataTransformerInterface;
 use Symfony\Component\Form\Exception\InvalidArgumentException;
 
+/**
+ * @template TTransformedValue
+ * @implements DataTransformerInterface<\DateTimeInterface, TTransformedValue>
+ */
 abstract class BaseDateTimeTransformer implements DataTransformerInterface
 {
     protected static $formats = [
diff --git a/Extension/Core/DataTransformer/BooleanToStringTransformer.php b/Extension/Core/DataTransformer/BooleanToStringTransformer.php
@@ -20,6 +20,8 @@
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  * @author Florian Eckerstorfer <florian@eckerstorfer.org>
+ *
+ * @implements DataTransformerInterface<bool, string>
  */
 class BooleanToStringTransformer implements DataTransformerInterface
 {
diff --git a/Extension/Core/DataTransformer/ChoiceToValueTransformer.php b/Extension/Core/DataTransformer/ChoiceToValueTransformer.php
@@ -17,6 +17,8 @@
 
 /**
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @implements DataTransformerInterface<string, string>
  */
 class ChoiceToValueTransformer implements DataTransformerInterface
 {
diff --git a/Extension/Core/DataTransformer/ChoicesToValuesTransformer.php b/Extension/Core/DataTransformer/ChoicesToValuesTransformer.php
@@ -17,6 +17,8 @@
 
 /**
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @implements DataTransformerInterface<array, array>
  */
 class ChoicesToValuesTransformer implements DataTransformerInterface
 {
diff --git a/Extension/Core/DataTransformer/DateIntervalToArrayTransformer.php b/Extension/Core/DataTransformer/DateIntervalToArrayTransformer.php
@@ -19,6 +19,8 @@
  * Transforms between a normalized date interval and an interval string/array.
  *
  * @author Steffen Roßkamp <steffen.rosskamp@gimmickmedia.de>
+ *
+ * @implements DataTransformerInterface<\DateInterval, array>
  */
 class DateIntervalToArrayTransformer implements DataTransformerInterface
 {
diff --git a/Extension/Core/DataTransformer/DateIntervalToStringTransformer.php b/Extension/Core/DataTransformer/DateIntervalToStringTransformer.php
@@ -19,6 +19,8 @@
  * Transforms between a date string and a DateInterval object.
  *
  * @author Steffen Roßkamp <steffen.rosskamp@gimmickmedia.de>
+ *
+ * @implements DataTransformerInterface<\DateInterval, string>
  */
 class DateIntervalToStringTransformer implements DataTransformerInterface
 {
diff --git a/Extension/Core/DataTransformer/DateTimeImmutableToDateTimeTransformer.php b/Extension/Core/DataTransformer/DateTimeImmutableToDateTimeTransformer.php
@@ -18,6 +18,8 @@
  * Transforms between a DateTimeImmutable object and a DateTime object.
  *
  * @author Valentin Udaltsov <udaltsov.valentin@gmail.com>
+ *
+ * @implements DataTransformerInterface<\DateTimeImmutable, \DateTime>
  */
 final class DateTimeImmutableToDateTimeTransformer implements DataTransformerInterface
 {
diff --git a/Extension/Core/DataTransformer/DateTimeToArrayTransformer.php b/Extension/Core/DataTransformer/DateTimeToArrayTransformer.php
@@ -18,6 +18,8 @@
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  * @author Florian Eckerstorfer <florian@eckerstorfer.org>
+ *
+ * @extends BaseDateTimeTransformer<array>
  */
 class DateTimeToArrayTransformer extends BaseDateTimeTransformer
 {
diff --git a/Extension/Core/DataTransformer/DateTimeToHtml5LocalDateTimeTransformer.php b/Extension/Core/DataTransformer/DateTimeToHtml5LocalDateTimeTransformer.php
@@ -17,6 +17,8 @@
  * @author Franz Wilding <franz.wilding@me.com>
  * @author Bernhard Schussek <bschussek@gmail.com>
  * @author Fred Cox <mcfedr@gmail.com>
+ *
+ * @extends BaseDateTimeTransformer<string>
  */
 class DateTimeToHtml5LocalDateTimeTransformer extends BaseDateTimeTransformer
 {
@@ -29,7 +31,7 @@ class DateTimeToHtml5LocalDateTimeTransformer extends BaseDateTimeTransformer
      * input is an RFC3339 date followed by 'T', followed by an RFC3339 time.
      * https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#valid-local-date-and-time-string
      *
-     * @param \DateTime|\DateTimeInterface $dateTime A DateTime object
+     * @param \DateTimeInterface $dateTime
      *
      * @throws TransformationFailedException If the given value is not an
      *                                       instance of \DateTime or \DateTimeInterface
@@ -40,8 +42,8 @@ public function transform(mixed $dateTime): string
             return '';
         }
 
-        if (!$dateTime instanceof \DateTime && !$dateTime instanceof \DateTimeInterface) {
-            throw new TransformationFailedException('Expected a \DateTime or \DateTimeInterface.');
+        if (!$dateTime instanceof \DateTimeInterface) {
+            throw new TransformationFailedException('Expected a \DateTimeInterface.');
         }
 
         if ($this->inputTimezone !== $this->outputTimezone) {
diff --git a/Extension/Core/DataTransformer/DateTimeToLocalizedStringTransformer.php b/Extension/Core/DataTransformer/DateTimeToLocalizedStringTransformer.php
@@ -19,6 +19,8 @@
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  * @author Florian Eckerstorfer <florian@eckerstorfer.org>
+ *
+ * @extends BaseDateTimeTransformer<string>
  */
 class DateTimeToLocalizedStringTransformer extends BaseDateTimeTransformer
 {
@@ -95,7 +97,7 @@ public function transform(mixed $dateTime): string
     /**
      * Transforms a localized date string/array into a normalized date.
      *
-     * @param string|array $value Localized date string/array
+     * @param string $value Localized date string
      *
      * @throws TransformationFailedException if the given value is not a string,
      *                                       if the date could not be parsed
diff --git a/Extension/Core/DataTransformer/DateTimeToRfc3339Transformer.php b/Extension/Core/DataTransformer/DateTimeToRfc3339Transformer.php
@@ -15,6 +15,8 @@
 
 /**
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @extends BaseDateTimeTransformer<string>
  */
 class DateTimeToRfc3339Transformer extends BaseDateTimeTransformer
 {
diff --git a/Extension/Core/DataTransformer/DateTimeToStringTransformer.php b/Extension/Core/DataTransformer/DateTimeToStringTransformer.php
@@ -18,6 +18,8 @@
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  * @author Florian Eckerstorfer <florian@eckerstorfer.org>
+ *
+ * @extends BaseDateTimeTransformer<string>
  */
 class DateTimeToStringTransformer extends BaseDateTimeTransformer
 {
diff --git a/Extension/Core/DataTransformer/DateTimeToTimestampTransformer.php b/Extension/Core/DataTransformer/DateTimeToTimestampTransformer.php
@@ -18,6 +18,8 @@
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  * @author Florian Eckerstorfer <florian@eckerstorfer.org>
+ *
+ * @extends BaseDateTimeTransformer<int|numeric-string>
  */
 class DateTimeToTimestampTransformer extends BaseDateTimeTransformer
 {
diff --git a/Extension/Core/DataTransformer/DateTimeZoneToStringTransformer.php b/Extension/Core/DataTransformer/DateTimeZoneToStringTransformer.php
@@ -18,6 +18,8 @@
  * Transforms between a timezone identifier string and a DateTimeZone object.
  *
  * @author Roland Franssen <franssen.roland@gmail.com>
+ *
+ * @implements DataTransformerInterface<\DateTimeZone|array<\DateTimeZone>, string|array<string>>
  */
 class DateTimeZoneToStringTransformer implements DataTransformerInterface
 {
diff --git a/Extension/Core/DataTransformer/IntlTimeZoneToStringTransformer.php b/Extension/Core/DataTransformer/IntlTimeZoneToStringTransformer.php
@@ -18,6 +18,8 @@
  * Transforms between a timezone identifier string and a IntlTimeZone object.
  *
  * @author Roland Franssen <franssen.roland@gmail.com>
+ *
+ * @implements DataTransformerInterface<\IntlTimeZone|array<\IntlTimeZone>, string|array<string>>
  */
 class IntlTimeZoneToStringTransformer implements DataTransformerInterface
 {
diff --git a/Extension/Core/DataTransformer/NumberToLocalizedStringTransformer.php b/Extension/Core/DataTransformer/NumberToLocalizedStringTransformer.php
@@ -20,6 +20,8 @@
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  * @author Florian Eckerstorfer <florian@eckerstorfer.org>
+ *
+ * @implements DataTransformerInterface<int|float, string>
  */
 class NumberToLocalizedStringTransformer implements DataTransformerInterface
 {
diff --git a/Extension/Core/DataTransformer/PercentToLocalizedStringTransformer.php b/Extension/Core/DataTransformer/PercentToLocalizedStringTransformer.php
@@ -20,6 +20,8 @@
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  * @author Florian Eckerstorfer <florian@eckerstorfer.org>
+ *
+ * @implements DataTransformerInterface<int|float, string>
  */
 class PercentToLocalizedStringTransformer implements DataTransformerInterface
 {
diff --git a/Extension/Core/DataTransformer/StringToFloatTransformer.php b/Extension/Core/DataTransformer/StringToFloatTransformer.php
@@ -14,6 +14,9 @@
 use Symfony\Component\Form\DataTransformerInterface;
 use Symfony\Component\Form\Exception\TransformationFailedException;
 
+/**
+ * @implements DataTransformerInterface<numeric-string, float>
+ */
 class StringToFloatTransformer implements DataTransformerInterface
 {
     private ?int $scale;
diff --git a/Extension/Core/DataTransformer/UlidToStringTransformer.php b/Extension/Core/DataTransformer/UlidToStringTransformer.php
@@ -19,6 +19,8 @@
  * Transforms between a ULID string and a Ulid object.
  *
  * @author Pavel Dyakonov <wapinet@mail.ru>
+ *
+ * @implements DataTransformerInterface<Ulid, string>
  */
 class UlidToStringTransformer implements DataTransformerInterface
 {
diff --git a/Extension/Core/DataTransformer/UuidToStringTransformer.php b/Extension/Core/DataTransformer/UuidToStringTransformer.php
@@ -19,6 +19,8 @@
  * Transforms between a UUID string and a Uuid object.
  *
  * @author Pavel Dyakonov <wapinet@mail.ru>
+ *
+ * @implements DataTransformerInterface<Uuid, string>
  */
 class UuidToStringTransformer implements DataTransformerInterface
 {
diff --git a/Extension/Core/DataTransformer/ValueToDuplicatesTransformer.php b/Extension/Core/DataTransformer/ValueToDuplicatesTransformer.php
@@ -16,6 +16,8 @@
 
 /**
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @implements DataTransformerInterface<mixed, array>
  */
 class ValueToDuplicatesTransformer implements DataTransformerInterface
 {
diff --git a/Extension/Core/DataTransformer/WeekToArrayTransformer.php b/Extension/Core/DataTransformer/WeekToArrayTransformer.php
@@ -18,6 +18,8 @@
  * Transforms between an ISO 8601 week date string and an array.
  *
  * @author Damien Fayet <damienf1521@gmail.com>
+ *
+ * @implements DataTransformerInterface<string, array{year: int|null, week: int|null}>
  */
 class WeekToArrayTransformer implements DataTransformerInterface
 {

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,9 @@`
`17`	`17`	`* Transforms a value between different representations.`
`18`	`18`	`*`
`19`	`19`	`* @author Bernhard Schussek <bschussek@gmail.com>`
	`20`	`+ *`
	`21`	`+ * @template TValue`
	`22`	`+ * @template TTransformedValue`
`20`	`23`	`*/`
`21`	`24`	`interface DataTransformerInterface`
`22`	`25`	`{`
`@@ -53,9 +56,9 @@ interface DataTransformerInterface`
`53`	`56`	`* of the first data transformer outputs NULL, the second must be able to`
`54`	`57`	`* process that value.`
`55`	`58`	`*`
`56`		`- * @param mixed $value The value in the original representation`
	`59`	`+ * @param TValue\|null $value The value in the original representation`
`57`	`60`	`*`
`58`		`- * @return mixed`
	`61`	`+ * @return TTransformedValue\|null`
`59`	`62`	`*`
`60`	`63`	`* @throws TransformationFailedException when the transformation fails`
`61`	`64`	`*/`
`@@ -82,9 +85,9 @@ public function transform(mixed $value);`
`82`	`85`	`* By convention, reverseTransform() should return NULL if an empty string`
`83`	`86`	`* is passed.`
`84`	`87`	`*`
`85`		`- * @param mixed $value The value in the transformed representation`
	`88`	`+ * @param TTransformedValue\|null $value The value in the transformed representation`
`86`	`89`	`*`
`87`		`- * @return mixed`
	`90`	`+ * @return TValue\|null`
`88`	`91`	`*`
`89`	`92`	`* @throws TransformationFailedException when the transformation fails`
`90`	`93`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,8 @@`
`16`	`16`
`17`	`17`	`/**`
`18`	`18`	`* @author Bernhard Schussek <bschussek@gmail.com>`
	`19`	`+ *`
	`20`	`+ * @implements DataTransformerInterface<array, array>`
`19`	`21`	`*/`
`20`	`22`	`class ArrayToPartsTransformer implements DataTransformerInterface`
`21`	`23`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,8 @@`
`20`	`20`	`*`
`21`	`21`	`* @author Bernhard Schussek <bschussek@gmail.com>`
`22`	`22`	`* @author Florian Eckerstorfer <florian@eckerstorfer.org>`
	`23`	`+ *`
	`24`	`+ * @implements DataTransformerInterface<bool, string>`
`23`	`25`	`*/`
`24`	`26`	`class BooleanToStringTransformer implements DataTransformerInterface`
`25`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@`
`17`	`17`
`18`	`18`	`/**`
`19`	`19`	`* @author Bernhard Schussek <bschussek@gmail.com>`
	`20`	`+ *`
	`21`	`+ * @implements DataTransformerInterface<string, string>`
`20`	`22`	`*/`
`21`	`23`	`class ChoiceToValueTransformer implements DataTransformerInterface`
`22`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,8 @@`
`19`	`19`	`* Transforms between a normalized date interval and an interval string/array.`
`20`	`20`	`*`
`21`	`21`	`* @author Steffen Roßkamp <steffen.rosskamp@gimmickmedia.de>`
	`22`	`+ *`
	`23`	`+ * @implements DataTransformerInterface<\DateInterval, array>`
`22`	`24`	`*/`
`23`	`25`	`class DateIntervalToArrayTransformer implements DataTransformerInterface`
`24`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,8 @@`
`18`	`18`	`* Transforms between a DateTimeImmutable object and a DateTime object.`
`19`	`19`	`*`
`20`	`20`	`* @author Valentin Udaltsov <udaltsov.valentin@gmail.com>`
	`21`	`+ *`
	`22`	`+ * @implements DataTransformerInterface<\DateTimeImmutable, \DateTime>`
`21`	`23`	`*/`
`22`	`24`	`final class DateTimeImmutableToDateTimeTransformer implements DataTransformerInterface`
`23`	`25`	`{`