Added template to Types that defines underlying data type (#1326)

* Added template to Types that defines underlying data type * CS Fixes
flow-php · Jan 4, 2025 · 257e7f4 · 257e7f4
1 parent 972da37
commit 257e7f4
Show file tree

Hide file tree

Showing 41 changed files with 107 additions and 18 deletions.
diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Caster/ArrayCastingHandler.php b/src/core/etl/src/Flow/ETL/PHP/Type/Caster/ArrayCastingHandler.php
@@ -16,7 +16,7 @@ public function supports(Type $type) : bool
         return $type instanceof ArrayType;
     }
 
-    public function value(mixed $value, Type $type, Caster $caster, Options $options) : mixed
+    public function value(mixed $value, Type $type, Caster $caster, Options $options) : array
     {
         try {
             if (\is_array($value)) {

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Caster/BooleanCastingHandler.php b/src/core/etl/src/Flow/ETL/PHP/Type/Caster/BooleanCastingHandler.php
@@ -14,7 +14,7 @@ public function supports(Type $type) : bool
         return $type instanceof BooleanType;
     }
 
-    public function value(mixed $value, Type $type, Caster $caster, Options $options) : mixed
+    public function value(mixed $value, Type $type, Caster $caster, Options $options) : bool
     {
         if (\is_bool($value)) {
             return $value;

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Caster/CastingHandler.php b/src/core/etl/src/Flow/ETL/PHP/Type/Caster/CastingHandler.php
@@ -10,5 +10,12 @@ interface CastingHandler
 {
     public function supports(Type $type) : bool;
 
+    /**
+     * @template T
+     *
+     * @param Type<T> $type
+     *
+     * @return T
+     */
     public function value(mixed $value, Type $type, Caster $caster, Options $options) : mixed;
 }
diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Caster/DateCastingHandler.php b/src/core/etl/src/Flow/ETL/PHP/Type/Caster/DateCastingHandler.php
@@ -15,7 +15,7 @@ public function supports(Type $type) : bool
         return $type instanceof DateType;
     }
 
-    public function value(mixed $value, Type $type, Caster $caster, Options $options) : mixed
+    public function value(mixed $value, Type $type, Caster $caster, Options $options) : \DateTimeImmutable
     {
         if ($value instanceof \DateTimeImmutable) {
             return $value->setTime(0, 0, 0, 0);

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Caster/DateTimeCastingHandler.php b/src/core/etl/src/Flow/ETL/PHP/Type/Caster/DateTimeCastingHandler.php
@@ -16,7 +16,7 @@ public function supports(Type $type) : bool
         return $type instanceof DateTimeType;
     }
 
-    public function value(mixed $value, Type $type, Caster $caster, Options $options) : mixed
+    public function value(mixed $value, Type $type, Caster $caster, Options $options) : \DateTimeImmutable
     {
         if ($value instanceof \DateTimeImmutable) {
             return $value;

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Caster/EnumCastingHandler.php b/src/core/etl/src/Flow/ETL/PHP/Type/Caster/EnumCastingHandler.php
@@ -15,7 +15,7 @@ public function supports(Type $type) : bool
         return $type instanceof EnumType;
     }
 
-    public function value(mixed $value, Type $type, Caster $caster, Options $options) : mixed
+    public function value(mixed $value, Type $type, Caster $caster, Options $options) : \UnitEnum
     {
         /** @var EnumType $type */
         if ($value instanceof $type->class) {

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Caster/FloatCastingHandler.php b/src/core/etl/src/Flow/ETL/PHP/Type/Caster/FloatCastingHandler.php
@@ -18,7 +18,7 @@ public function supports(Type $type) : bool
         return $type instanceof FloatType;
     }
 
-    public function value(mixed $value, Type $type, Caster $caster, Options $options) : mixed
+    public function value(mixed $value, Type $type, Caster $caster, Options $options) : float
     {
         /**
          * @var FloatType $type

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Caster/IntegerCastingHandler.php b/src/core/etl/src/Flow/ETL/PHP/Type/Caster/IntegerCastingHandler.php
@@ -14,7 +14,7 @@ public function supports(Type $type) : bool
         return $type instanceof IntegerType;
     }
 
-    public function value(mixed $value, Type $type, Caster $caster, Options $options) : mixed
+    public function value(mixed $value, Type $type, Caster $caster, Options $options) : int
     {
         if (\is_int($value)) {
             return $value;

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Caster/ListCastingHandler.php b/src/core/etl/src/Flow/ETL/PHP/Type/Caster/ListCastingHandler.php
@@ -15,7 +15,7 @@ public function supports(Type $type) : bool
         return $type instanceof ListType;
     }
 
-    public function value(mixed $value, Type $type, Caster $caster, Options $options) : mixed
+    public function value(mixed $value, Type $type, Caster $caster, Options $options) : array
     {
         /** @var ListType $type */
         try {

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Caster/MapCastingHandler.php b/src/core/etl/src/Flow/ETL/PHP/Type/Caster/MapCastingHandler.php
@@ -15,7 +15,7 @@ public function supports(Type $type) : bool
         return $type instanceof MapType;
     }
 
-    public function value(mixed $value, Type $type, Caster $caster, Options $options) : mixed
+    public function value(mixed $value, Type $type, Caster $caster, Options $options) : array
     {
         /** @var MapType $type */
         try {

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Caster/NullCastingHandler.php b/src/core/etl/src/Flow/ETL/PHP/Type/Caster/NullCastingHandler.php
@@ -14,7 +14,7 @@ public function supports(Type $type) : bool
         return $type instanceof NullType;
     }
 
-    public function value(mixed $value, Type $type, Caster $caster, Options $options) : mixed
+    public function value(mixed $value, Type $type, Caster $caster, Options $options) : null
     {
         return null;
     }

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Caster/ObjectCastingHandler.php b/src/core/etl/src/Flow/ETL/PHP/Type/Caster/ObjectCastingHandler.php
@@ -16,7 +16,7 @@ public function supports(Type $type) : bool
         return $type instanceof ObjectType;
     }
 
-    public function value(mixed $value, Type $type, Caster $caster, Options $options) : mixed
+    public function value(mixed $value, Type $type, Caster $caster, Options $options) : object
     {
         if (\is_object($value)) {
             return $value;

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Caster/StringCastingHandler.php b/src/core/etl/src/Flow/ETL/PHP/Type/Caster/StringCastingHandler.php
@@ -15,7 +15,7 @@ public function supports(Type $type) : bool
         return $type instanceof StringType;
     }
 
-    public function value(mixed $value, Type $type, Caster $caster, Options $options) : mixed
+    public function value(mixed $value, Type $type, Caster $caster, Options $options) : string
     {
         if (\is_string($value)) {
             return $value;
@@ -38,11 +38,11 @@ public function value(mixed $value, Type $type, Caster $caster, Options $options
         }
 
         if ($value instanceof \DOMDocument) {
-            return $value->saveXML() ?: null;
+            return $value->saveXML() ?: '';
         }
 
         if ($value instanceof \DOMElement) {
-            return dom_element_to_string($value);
+            return (string) dom_element_to_string($value);
         }
 
         try {

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Caster/StructureCastingHandler.php b/src/core/etl/src/Flow/ETL/PHP/Type/Caster/StructureCastingHandler.php
@@ -15,7 +15,7 @@ public function supports(Type $type) : bool
         return $type instanceof StructureType;
     }
 
-    public function value(mixed $value, Type $type, Caster $caster, Options $options) : mixed
+    public function value(mixed $value, Type $type, Caster $caster, Options $options) : array
     {
         /** @var StructureType $type */
         try {

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Caster/TimeCastingHandler.php b/src/core/etl/src/Flow/ETL/PHP/Type/Caster/TimeCastingHandler.php
@@ -15,7 +15,7 @@ public function supports(Type $type) : bool
         return $type instanceof TimeType;
     }
 
-    public function value(mixed $value, Type $type, Caster $caster, Options $options) : mixed
+    public function value(mixed $value, Type $type, Caster $caster, Options $options) : \DateInterval
     {
         if ($value instanceof \DateTimeInterface) {
             return $value->diff(new \DateTimeImmutable($value->format('Y-m-d')), true);

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Caster/UuidCastingHandler.php b/src/core/etl/src/Flow/ETL/PHP/Type/Caster/UuidCastingHandler.php
@@ -16,7 +16,7 @@ public function supports(Type $type) : bool
         return $type instanceof UuidType;
     }
 
-    public function value(mixed $value, Type $type, Caster $caster, Options $options) : mixed
+    public function value(mixed $value, Type $type, Caster $caster, Options $options) : Uuid
     {
         if ($value instanceof Uuid) {
             return $value;

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Caster/XMLCastingHandler.php b/src/core/etl/src/Flow/ETL/PHP/Type/Caster/XMLCastingHandler.php
@@ -16,7 +16,7 @@ public function supports(Type $type) : bool
         return $type instanceof XMLType;
     }
 
-    public function value(mixed $value, Type $type, Caster $caster, Options $options) : mixed
+    public function value(mixed $value, Type $type, Caster $caster, Options $options) : \DOMDocument
     {
         if ($value instanceof \DOMDocument) {
             return $value;

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Logical/DateTimeType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Logical/DateTimeType.php
@@ -8,6 +8,9 @@
 use Flow\ETL\PHP\Type\Native\NullType;
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements LogicalType<\DateTimeInterface>
+ */
 final class DateTimeType implements LogicalType
 {
     public function __construct(private readonly bool $nullable = false)

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Logical/DateType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Logical/DateType.php
@@ -8,6 +8,9 @@
 use Flow\ETL\PHP\Type\Native\NullType;
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements LogicalType<\DateTimeInterface>
+ */
 final class DateType implements LogicalType
 {
     public function __construct(private readonly bool $nullable = false)

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Logical/JsonType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Logical/JsonType.php
@@ -9,6 +9,9 @@
 use Flow\ETL\PHP\Type\Native\NullType;
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements LogicalType<string>
+ */
 final class JsonType implements LogicalType
 {
     public function __construct(private readonly bool $nullable)

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Logical/ListType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Logical/ListType.php
@@ -9,6 +9,9 @@
 use Flow\ETL\PHP\Type\Native\NullType;
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements LogicalType<array>
+ */
 final class ListType implements LogicalType
 {
     public function __construct(private readonly ListElement $element, private readonly bool $nullable = false)

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Logical/LogicalType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Logical/LogicalType.php
@@ -6,6 +6,11 @@
 
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @template TType
+ *
+ * @extends Type<TType>
+ */
 interface LogicalType extends Type
 {
 }
diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Logical/MapType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Logical/MapType.php
@@ -9,6 +9,9 @@
 use Flow\ETL\PHP\Type\Native\NullType;
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements LogicalType<array>
+ */
 final class MapType implements LogicalType
 {
     public function __construct(private readonly MapKey $key, private readonly MapValue $value, private readonly bool $nullable = false)

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Logical/StructureType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Logical/StructureType.php
@@ -9,6 +9,9 @@
 use Flow\ETL\PHP\Type\Native\NullType;
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements LogicalType<array>
+ */
 final class StructureType implements LogicalType
 {
     /**

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Logical/TimeType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Logical/TimeType.php
@@ -8,6 +8,9 @@
 use Flow\ETL\PHP\Type\Native\NullType;
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements LogicalType<\DateInterval>
+ */
 final class TimeType implements LogicalType
 {
     public function __construct(private readonly bool $nullable = false)

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Logical/UuidType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Logical/UuidType.php
@@ -9,6 +9,9 @@
 use Flow\ETL\PHP\Type\Type;
 use Flow\ETL\PHP\Value\Uuid;
 
+/**
+ * @implements LogicalType<\Ramsey\Uuid\UuidInterface|\Symfony\Component\Uid\Uuid|Uuid>
+ */
 final class UuidType implements LogicalType
 {
     public function __construct(private readonly bool $nullable = false)

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Logical/XMLElementType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Logical/XMLElementType.php
@@ -8,6 +8,9 @@
 use Flow\ETL\PHP\Type\Native\NullType;
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements LogicalType<\DOMDocument>
+ */
 final class XMLElementType implements LogicalType
 {
     public function __construct(private readonly bool $nullable)

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Logical/XMLType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Logical/XMLType.php
@@ -8,6 +8,9 @@
 use Flow\ETL\PHP\Type\Native\NullType;
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements LogicalType<\DOMDocument>
+ */
 final class XMLType implements LogicalType
 {
     public function __construct(private readonly bool $nullable)

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Native/ArrayType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Native/ArrayType.php
@@ -7,6 +7,9 @@
 use Flow\ETL\Exception\InvalidArgumentException;
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements NativeType<array>
+ */
 final class ArrayType implements NativeType
 {
     public function __construct(private readonly bool $empty = false, private readonly bool $nullable = false)

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Native/BooleanType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Native/BooleanType.php
@@ -7,6 +7,9 @@
 use Flow\ETL\Exception\InvalidArgumentException;
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements NativeType<boolean>
+ */
 final readonly class BooleanType implements NativeType
 {
     public function __construct(private bool $nullable = false)

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Native/CallableType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Native/CallableType.php
@@ -7,6 +7,9 @@
 use Flow\ETL\Exception\InvalidArgumentException;
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements NativeType<callable>
+ */
 final class CallableType implements NativeType
 {
     public function __construct(private readonly bool $nullable)

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Native/EnumType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Native/EnumType.php
@@ -7,6 +7,9 @@
 use Flow\ETL\Exception\InvalidArgumentException;
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements NativeType<\UnitEnum>
+ */
 final class EnumType implements NativeType
 {
     /**

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Native/FloatType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Native/FloatType.php
@@ -7,6 +7,9 @@
 use Flow\ETL\Exception\InvalidArgumentException;
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements NativeType<float>
+ */
 final readonly class FloatType implements NativeType
 {
     public function __construct(private readonly bool $nullable = false, public readonly int $precision = 6)

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Native/IntegerType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Native/IntegerType.php
@@ -8,6 +8,9 @@
 use Flow\ETL\Exception\InvalidArgumentException;
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements NativeType<integer>
+ */
 final readonly class IntegerType implements NativeType
 {
     public function __construct(private readonly bool $nullable = false)

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Native/NativeType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Native/NativeType.php
@@ -6,6 +6,11 @@
 
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @template TType
+ *
+ * @extends  Type<TType>
+ */
 interface NativeType extends Type
 {
 }
diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Native/NullType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Native/NullType.php
@@ -6,6 +6,9 @@
 
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements NativeType<null>
+ */
 final class NullType implements NativeType
 {
     public static function fromArray(array $data) : self

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Native/ObjectType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Native/ObjectType.php
@@ -7,6 +7,9 @@
 use Flow\ETL\Exception\InvalidArgumentException;
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements NativeType<object>
+ */
 final class ObjectType implements NativeType
 {
     /**

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Native/ResourceType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Native/ResourceType.php
@@ -7,6 +7,9 @@
 use Flow\ETL\Exception\InvalidArgumentException;
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements NativeType<resource>
+ */
 final class ResourceType implements NativeType
 {
     public function __construct(private readonly bool $nullable)

diff --git a/src/core/etl/src/Flow/ETL/PHP/Type/Native/StringType.php b/src/core/etl/src/Flow/ETL/PHP/Type/Native/StringType.php
@@ -7,6 +7,9 @@
 use Flow\ETL\Exception\InvalidArgumentException;
 use Flow\ETL\PHP\Type\Type;
 
+/**
+ * @implements NativeType<string>
+ */
 final readonly class StringType implements NativeType
 {
     public function __construct(private readonly bool $nullable = false)