IBX-9727: Defined generic types for Forms transformers after SF 7 upgrade

alongosz · alongosz · commit 5be509e96bd9 · 2025-05-28T14:20:37.000+02:00
diff --git a/src/lib/FieldType/DataTransformer/AbstractBinaryBaseTransformer.php b/src/lib/FieldType/DataTransformer/AbstractBinaryBaseTransformer.php
@@ -10,38 +10,33 @@
 
 use Ibexa\Contracts\Core\Repository\FieldType;
 use Ibexa\Core\FieldType\Value;
-use Symfony\Component\Form\Exception\TransformationFailedException;
 
 /**
- * Base transformer for binary file based field types.
- *
- * {@inheritdoc}
+ * Base transformer for binary file-based field types.
  */
 abstract class AbstractBinaryBaseTransformer
 {
     protected FieldType $fieldType;
 
     protected Value $initialValue;
 
-    /** @var string */
-    protected $valueClass;
+    /** @phpstan-var class-string */
+    protected string $valueClass;
 
     /**
-     * @param \Ibexa\Contracts\Core\Repository\FieldType $fieldType
-     * @param \Ibexa\Core\FieldType\Value $initialValue
-     * @param string $valueClass
+     * @phpstan-param class-string $valueClass
      */
-    public function __construct(FieldType $fieldType, Value $initialValue, $valueClass)
+    public function __construct(FieldType $fieldType, Value $initialValue, string $valueClass)
     {
         $this->fieldType = $fieldType;
         $this->initialValue = $initialValue;
         $this->valueClass = $valueClass;
     }
 
     /**
-     * @return array|null
+     * @return array{file: string|null, remove: bool}
      */
-    public function getDefaultProperties()
+    public function getDefaultProperties(): array
     {
         return [
             'file' => null,
@@ -50,23 +45,17 @@ public function getDefaultProperties()
     }
 
     /**
-     * @param array $value
-     *
-     * @return \Ibexa\Core\FieldType\Value
+     * @param array<string, mixed> $value
      *
      * @throws \Symfony\Component\Form\Exception\TransformationFailedException
      */
-    public function getReverseTransformedValue($value)
+    public function getReverseTransformedValue(array $value): Value
     {
-        if (!is_array($value)) {
-            throw new TransformationFailedException(sprintf('Received %s instead of an array', gettype($value)));
-        }
-
         if ($value['remove']) {
             return $this->fieldType->getEmptyValue();
         }
 
-        /* in case file is not modified, overwrite settings only */
+        /* in case the file is not modified, overwrite settings only */
         if (null === $value['file']) {
             return clone $this->initialValue;
         }
diff --git a/src/lib/FieldType/DataTransformer/AuthorValueTransformer.php b/src/lib/FieldType/DataTransformer/AuthorValueTransformer.php
@@ -14,16 +14,23 @@
 
 /**
  * DataTransformer for Author\Value.
+ *
+ * @phpstan-type TAuthorData array{id: int, name: string, email: string}|array{}
+ *
+ * @implements \Symfony\Component\Form\DataTransformerInterface<\Ibexa\Core\FieldType\Author\Value, list<TAuthorData>>
  */
 class AuthorValueTransformer implements DataTransformerInterface
 {
+    /**
+     * @phpstan-return list<TAuthorData>|array{}
+     */
     public function transform(mixed $value): array
     {
         if (is_array($value)) {
             return $value;
         }
 
-        if (!$value instanceof Value || $value->authors->count() == 0) {
+        if (!$value instanceof Value || $value->authors->count() === 0) {
             return [[]];
         }
 
@@ -41,7 +48,7 @@ public function transform(mixed $value): array
 
     public function reverseTransform(mixed $value): ?Value
     {
-        if ($value === null || !is_array($value)) {
+        if (!is_array($value)) {
             return null;
         }
 
diff --git a/src/lib/FieldType/DataTransformer/BinaryFileValueTransformer.php b/src/lib/FieldType/DataTransformer/BinaryFileValueTransformer.php
@@ -12,17 +12,14 @@
 use Symfony\Component\Form\DataTransformerInterface;
 
 /**
- * Data transformer for ezbinaryfile field type.
+ * Data transformer for an `ezbinaryfile` field type.
  *
- * {@inheritdoc}
+ * @phpstan-type TBinaryFileData array{file: string|null, remove: bool, downloadCount: int}
+ *
+ * @implements \Symfony\Component\Form\DataTransformerInterface<\Ibexa\Core\FieldType\BinaryFile\Value, TBinaryFileData>
  */
 class BinaryFileValueTransformer extends AbstractBinaryBaseTransformer implements DataTransformerInterface
 {
-    /**
-     * @param \Ibexa\Core\FieldType\BinaryFile\Value $value
-     *
-     * @return array
-     */
     public function transform(mixed $value): array
     {
         if (null === $value) {
@@ -36,21 +33,13 @@ public function transform(mixed $value): array
     }
 
     /**
-     * @param array $value
-     *
-     * @return \Ibexa\Core\FieldType\BinaryFile\Value
+     * @phpstan-param TBinaryFileData $value
      *
      * @throws \Symfony\Component\Form\Exception\TransformationFailedException
      */
     public function reverseTransform(mixed $value): ?Value
     {
-        /** @var \Ibexa\Core\FieldType\BinaryFile\Value $valueObject */
-        $valueObject = $this->getReverseTransformedValue($value);
-
-        if ($this->fieldType->isEmptyValue($valueObject)) {
-            return $valueObject;
-        }
-
-        return $valueObject;
+        /** @var \Ibexa\Core\FieldType\BinaryFile\Value */
+        return $this->getReverseTransformedValue($value);
     }
 }
diff --git a/src/lib/FieldType/DataTransformer/DateTimeValueTransformer.php b/src/lib/FieldType/DataTransformer/DateTimeValueTransformer.php
@@ -14,14 +14,12 @@
 
 /**
  * DataTransformer for DateAndTime\Value.
+ *
+ * @implements \Symfony\Component\Form\DataTransformerInterface<\Ibexa\Core\FieldType\DateAndTime\Value, int|null>
  */
 class DateTimeValueTransformer implements DataTransformerInterface
 {
     /**
-     * @param mixed $value
-     *
-     * @return int|null
-     *
      * @throws \Symfony\Component\Form\Exception\TransformationFailedException
      */
     public function transform(mixed $value): ?int
@@ -44,10 +42,7 @@ public function transform(mixed $value): ?int
     }
 
     /**
-     * @param mixed $value
-     *
-     * @return \Ibexa\Core\FieldType\DateAndTime\Value|null
-     *
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException
      * @throws \Symfony\Component\Form\Exception\TransformationFailedException
      */
     public function reverseTransform(mixed $value): ?Value
diff --git a/src/lib/FieldType/DataTransformer/DateValueTransformer.php b/src/lib/FieldType/DataTransformer/DateValueTransformer.php
@@ -14,14 +14,12 @@
 
 /**
  * DataTransformer for Date\Value.
+ *
+ * @implements \Symfony\Component\Form\DataTransformerInterface<\Ibexa\Core\FieldType\Date\Value, int|null>
  */
 class DateValueTransformer implements DataTransformerInterface
 {
     /**
-     * @param mixed $value
-     *
-     * @return int|null
-     *
      * @throws \Symfony\Component\Form\Exception\TransformationFailedException
      */
     public function transform(mixed $value): ?int
diff --git a/src/lib/FieldType/DataTransformer/FieldValueTransformer.php b/src/lib/FieldType/DataTransformer/FieldValueTransformer.php
@@ -15,6 +15,8 @@
 /**
  * Generic data transformer for FieldTypes values.
  * Uses FieldType::toHash() / FieldType::fromHash().
+ *
+ * @implements \Symfony\Component\Form\DataTransformerInterface<mixed, mixed>
  */
 class FieldValueTransformer implements DataTransformerInterface
 {
@@ -29,9 +31,7 @@ public function __construct(FieldType $fieldType)
      * Transforms a FieldType Value into a hash using `FieldTpe::toHash()`.
      * This hash is compatible with `reverseTransform()`.
      *
-     * @param mixed $value
-     *
-     * @return array|null the value's hash, or null if $value was not a FieldType Value
+     * @return mixed the value's hash, or null if $value was not a FieldType Value
      */
     public function transform(mixed $value): mixed
     {
@@ -45,10 +45,6 @@ public function transform(mixed $value): mixed
     /**
      * Transforms a hash into a FieldType Value using `FieldType::fromHash()`.
      * The FieldValue is compatible with `transform()`.
-     *
-     * @param mixed $value
-     *
-     * @return \Ibexa\Contracts\Core\FieldType\Value
      */
     public function reverseTransform(mixed $value): Value
     {
diff --git a/src/lib/FieldType/DataTransformer/ImageAssetValueTransformer.php b/src/lib/FieldType/DataTransformer/ImageAssetValueTransformer.php
@@ -12,14 +12,15 @@
 use Symfony\Component\Form\DataTransformerInterface;
 use Symfony\Component\Form\Exception\TransformationFailedException;
 
+/**
+ * @phpstan-type TImageAssetData array{file: string|null, remove: boolean, destinationContentId: int, alternativeText: string|null}
+ *
+ * @implements \Symfony\Component\Form\DataTransformerInterface<\Ibexa\Core\FieldType\ImageAsset\Value, TImageAssetData|null>
+ */
 class ImageAssetValueTransformer extends AbstractBinaryBaseTransformer implements DataTransformerInterface
 {
     /**
-     * @param \Ibexa\Core\FieldType\ImageAsset\Value|null $value
-     *
      * @throws \Symfony\Component\Form\Exception\TransformationFailedException
-     *
-     * @return array|null
      */
     public function transform($value): ?array
     {
@@ -36,7 +37,7 @@ public function transform($value): ?array
         return array_merge(
             $this->getDefaultProperties(),
             [
-                'destinationContentId' => $value->destinationContentId,
+                'destinationContentId' => (int)$value->destinationContentId,
                 'alternativeText' => $value->alternativeText,
             ]
         );
diff --git a/src/lib/FieldType/DataTransformer/ImageValueTransformer.php b/src/lib/FieldType/DataTransformer/ImageValueTransformer.php
@@ -13,6 +13,10 @@
 
 /**
  * Data transformer for the `ezimage` field type.
+ *
+ * @phpstan-type TImageData array{file: string|null, remove: boolean, alternativeText: string|null, additionalData: array<string>}
+ *
+ * @implements \Symfony\Component\Form\DataTransformerInterface<\Ibexa\Core\FieldType\Image\Value, array<string, mixed>>
  */
 class ImageValueTransformer extends AbstractBinaryBaseTransformer implements DataTransformerInterface
 {
diff --git a/src/lib/FieldType/DataTransformer/KeywordValueTransformer.php b/src/lib/FieldType/DataTransformer/KeywordValueTransformer.php
@@ -13,6 +13,8 @@
 
 /**
  * DataTransformer for Keyword\Value.
+ *
+ * @implements \Symfony\Component\Form\DataTransformerInterface<\Ibexa\Core\FieldType\Keyword\Value, string|null>
  */
 class KeywordValueTransformer implements DataTransformerInterface
 {
diff --git a/src/lib/FieldType/DataTransformer/MediaValueTransformer.php b/src/lib/FieldType/DataTransformer/MediaValueTransformer.php
@@ -14,15 +14,12 @@
 /**
  * Data transformer for ezmedia field type.
  *
- * {@inheritdoc}
+ * @phpstan-type TMediaData array{file: string|null, remove: bool, hasController: bool, loop: bool, autoplay: bool, width: int, height: int}
+ *
+ * @implements \Symfony\Component\Form\DataTransformerInterface<\Ibexa\Core\FieldType\Media\Value, TMediaData>
  */
 class MediaValueTransformer extends AbstractBinaryBaseTransformer implements DataTransformerInterface
 {
-    /**
-     * @param \Ibexa\Core\FieldType\Media\Value $value
-     *
-     * @return array
-     */
     public function transform(mixed $value): array
     {
         if (null === $value) {
@@ -42,9 +39,7 @@ public function transform(mixed $value): array
     }
 
     /**
-     * @param array $value
-     *
-     * @return \Ibexa\Core\FieldType\Media\Value
+     * @phpstan-param TMediaData $value
      *
      * @throws \Symfony\Component\Form\Exception\TransformationFailedException
      */
diff --git a/src/lib/FieldType/DataTransformer/MultiSelectionValueTransformer.php b/src/lib/FieldType/DataTransformer/MultiSelectionValueTransformer.php
@@ -13,6 +13,8 @@
 
 /**
  * DataTransformer for Selection\Value in multi select mode.
+ *
+ * @implements \Symfony\Component\Form\DataTransformerInterface<\Ibexa\Core\FieldType\Selection\Value, int[]|null>
  */
 class MultiSelectionValueTransformer implements DataTransformerInterface
 {
diff --git a/src/lib/FieldType/DataTransformer/MultipleCountryValueTransformer.php b/src/lib/FieldType/DataTransformer/MultipleCountryValueTransformer.php
@@ -12,18 +12,24 @@
 use Symfony\Component\Form\DataTransformerInterface;
 
 /**
- * DataTransformer for Country\Value to be used with form type handling multiple selections.
+ * DataTransformer for Country\Value to be used with a form type handling multiple selections.
  * Needed to display the form field correctly and transform it back to an appropriate value object.
+ *
+ * @phpstan-import-type TCountryValueData from \Ibexa\ContentForms\FieldType\DataTransformer\SingleCountryValueTransformer
+ *
+ * @implements \Symfony\Component\Form\DataTransformerInterface<\Ibexa\Core\FieldType\Country\Value, string[]|null>
  */
 class MultipleCountryValueTransformer implements DataTransformerInterface
 {
     /**
-     * @var array Array of countries from "ibexa.field_type.country.data"
+     * Array of countries from "ibexa.field_type.country.data".
+     *
+     * @phpstan-var array<string, TCountryValueData>
      */
     protected array $countriesInfo;
 
     /**
-     * @param array $countriesInfo
+     * @phpstan-param array<string, TCountryValueData> $countriesInfo
      */
     public function __construct(array $countriesInfo)
     {
diff --git a/src/lib/FieldType/DataTransformer/RelationListValueTransformer.php b/src/lib/FieldType/DataTransformer/RelationListValueTransformer.php
@@ -13,6 +13,8 @@
 
 /**
  * DataTransformer for RelationList\Value in single select mode.
+ *
+ * @implements \Symfony\Component\Form\DataTransformerInterface<\Ibexa\Core\FieldType\RelationList\Value, string|null>
  */
 class RelationListValueTransformer implements DataTransformerInterface
 {
diff --git a/src/lib/FieldType/DataTransformer/RelationValueTransformer.php b/src/lib/FieldType/DataTransformer/RelationValueTransformer.php
@@ -11,6 +11,9 @@
 use Ibexa\Core\FieldType\Relation\Value;
 use Symfony\Component\Form\DataTransformerInterface;
 
+/**
+ * @implements \Symfony\Component\Form\DataTransformerInterface<\Ibexa\Core\FieldType\Relation\Value, int|null>
+ */
 class RelationValueTransformer implements DataTransformerInterface
 {
     public function transform(mixed $value): ?int
@@ -19,16 +22,12 @@ public function transform(mixed $value): ?int
             return null;
         }
 
-        if ($value->destinationContentId === null) {
-            return null;
-        }
-
-        return $value->destinationContentId;
+        return $value->destinationContentId ?? null;
     }
 
     public function reverseTransform(mixed $value): ?Value
     {
-        if ($value === null || !is_numeric($value)) {
+        if (!is_numeric($value)) {
             return null;
         }
 
diff --git a/src/lib/FieldType/DataTransformer/SingleCountryValueTransformer.php b/src/lib/FieldType/DataTransformer/SingleCountryValueTransformer.php
diff --git a/src/lib/FieldType/DataTransformer/SingleSelectionValueTransformer.php b/src/lib/FieldType/DataTransformer/SingleSelectionValueTransformer.php
diff --git a/src/lib/FieldType/DataTransformer/TimeValueTransformer.php b/src/lib/FieldType/DataTransformer/TimeValueTransformer.php
diff --git a/src/lib/Form/Transformer/JsonToArrayTransformer.php b/src/lib/Form/Transformer/JsonToArrayTransformer.php
diff --git a/src/lib/Form/Transformer/RelationTransformer.php b/src/lib/Form/Transformer/RelationTransformer.php

Original file line number	Diff line number	Diff line change
`@@ -14,16 +14,23 @@`
`14`	`14`
`15`	`15`	`/**`
`16`	`16`	`* DataTransformer for Author\Value.`
	`17`	`+ *`
	`18`	`+ * @phpstan-type TAuthorData array{id: int, name: string, email: string}\|array{}`
	`19`	`+ *`
	`20`	`+ * @implements \Symfony\Component\Form\DataTransformerInterface<\Ibexa\Core\FieldType\Author\Value, list<TAuthorData>>`
`17`	`21`	`*/`
`18`	`22`	`class AuthorValueTransformer implements DataTransformerInterface`
`19`	`23`	`{`
	`24`	`+ /**`
	`25`	`+ * @phpstan-return list<TAuthorData>\|array{}`
	`26`	`+ */`
`20`	`27`	`public function transform(mixed $value): array`
`21`	`28`	`{`
`22`	`29`	`if (is_array($value)) {`
`23`	`30`	`return $value;`
`24`	`31`	`}`
`25`	`32`
`26`		`- if (!$value instanceof Value \|\| $value->authors->count() == 0) {`
	`33`	`+ if (!$value instanceof Value \|\| $value->authors->count() === 0) {`
`27`	`34`	`return [[]];`
`28`	`35`	`}`
`29`	`36`
`@@ -41,7 +48,7 @@ public function transform(mixed $value): array`
`41`	`48`
`42`	`49`	`public function reverseTransform(mixed $value): ?Value`
`43`	`50`	`{`
`44`		`- if ($value === null \|\| !is_array($value)) {`
	`51`	`+ if (!is_array($value)) {`
`45`	`52`	`return null;`
`46`	`53`	`}`
`47`	`54`
Original file line number	Diff line number	Diff line change
`@@ -12,17 +12,14 @@`
`12`	`12`	`use Symfony\Component\Form\DataTransformerInterface;`
`13`	`13`
`14`	`14`	`/**`
`15`		`- * Data transformer for ezbinaryfile field type.`
	`15`	+ * Data transformer for an `ezbinaryfile` field type.
`16`	`16`	`*`
`17`		`- * {@inheritdoc}`
	`17`	`+ * @phpstan-type TBinaryFileData array{file: string\|null, remove: bool, downloadCount: int}`
	`18`	`+ *`
	`19`	`+ * @implements \Symfony\Component\Form\DataTransformerInterface<\Ibexa\Core\FieldType\BinaryFile\Value, TBinaryFileData>`
`18`	`20`	`*/`
`19`	`21`	`class BinaryFileValueTransformer extends AbstractBinaryBaseTransformer implements DataTransformerInterface`
`20`	`22`	`{`
`21`		`- /**`
`22`		`- * @param \Ibexa\Core\FieldType\BinaryFile\Value $value`
`23`		`- *`
`24`		`- * @return array`
`25`		`- */`
`26`	`23`	`public function transform(mixed $value): array`
`27`	`24`	`{`
`28`	`25`	`if (null === $value) {`
`@@ -36,21 +33,13 @@ public function transform(mixed $value): array`
`36`	`33`	`}`
`37`	`34`
`38`	`35`	`/**`
`39`		`- * @param array $value`
`40`		`- *`
`41`		`- * @return \Ibexa\Core\FieldType\BinaryFile\Value`
	`36`	`+ * @phpstan-param TBinaryFileData $value`
`42`	`37`	`*`
`43`	`38`	`* @throws \Symfony\Component\Form\Exception\TransformationFailedException`
`44`	`39`	`*/`
`45`	`40`	`public function reverseTransform(mixed $value): ?Value`
`46`	`41`	`{`
`47`		`- /** @var \Ibexa\Core\FieldType\BinaryFile\Value $valueObject */`
`48`		`- $valueObject = $this->getReverseTransformedValue($value);`
`49`		`-`
`50`		`- if ($this->fieldType->isEmptyValue($valueObject)) {`
`51`		`- return $valueObject;`
`52`		`- }`
`53`		`-`
`54`		`- return $valueObject;`
	`42`	`+ /** @var \Ibexa\Core\FieldType\BinaryFile\Value */`
	`43`	`+ return $this->getReverseTransformedValue($value);`
`55`	`44`	`}`
`56`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,8 @@`
`13`	`13`
`14`	`14`	`/**`
`15`	`15`	`* DataTransformer for Keyword\Value.`
	`16`	`+ *`
	`17`	`+ * @implements \Symfony\Component\Form\DataTransformerInterface<\Ibexa\Core\FieldType\Keyword\Value, string\|null>`
`16`	`18`	`*/`
`17`	`19`	`class KeywordValueTransformer implements DataTransformerInterface`
`18`	`20`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,15 +14,12 @@`
`14`	`14`	`/**`
`15`	`15`	`* Data transformer for ezmedia field type.`
`16`	`16`	`*`
`17`		`- * {@inheritdoc}`
	`17`	`+ * @phpstan-type TMediaData array{file: string\|null, remove: bool, hasController: bool, loop: bool, autoplay: bool, width: int, height: int}`
	`18`	`+ *`
	`19`	`+ * @implements \Symfony\Component\Form\DataTransformerInterface<\Ibexa\Core\FieldType\Media\Value, TMediaData>`
`18`	`20`	`*/`
`19`	`21`	`class MediaValueTransformer extends AbstractBinaryBaseTransformer implements DataTransformerInterface`
`20`	`22`	`{`
`21`		`- /**`
`22`		`- * @param \Ibexa\Core\FieldType\Media\Value $value`
`23`		`- *`
`24`		`- * @return array`
`25`		`- */`
`26`	`23`	`public function transform(mixed $value): array`
`27`	`24`	`{`
`28`	`25`	`if (null === $value) {`
`@@ -42,9 +39,7 @@ public function transform(mixed $value): array`
`42`	`39`	`}`
`43`	`40`
`44`	`41`	`/**`
`45`		`- * @param array $value`
`46`		`- *`
`47`		`- * @return \Ibexa\Core\FieldType\Media\Value`
	`42`	`+ * @phpstan-param TMediaData $value`
`48`	`43`	`*`
`49`	`44`	`* @throws \Symfony\Component\Form\Exception\TransformationFailedException`
`50`	`45`	`*/`