Layer model casts over column types in array row shapes

Author: paulbalandan

src/Type/ModelFetchedReturnTypeHelper.php

@@ -13,6 +13,8 @@
 
 namespace CodeIgniter\PHPStan\Type;
 
+use CodeIgniter\PHPStan\Database\Schema\CastTypeResolver;
+use CodeIgniter\PHPStan\Database\Schema\Column;
 use CodeIgniter\PHPStan\Database\Schema\ColumnTypeResolver;
 use CodeIgniter\PHPStan\Database\SchemaProvider;
 use CodeIgniter\PHPStan\NodeVisitor\ModelReturnTypeTransformVisitor;
@@ -33,14 +35,15 @@
 
 /**
  * Resolves the type of a single fetched row for a model, honoring its `$returnType` (or the
- * `asArray()`/`asObject()` override) and shaping array rows from the live table columns.
+ * `asArray()`/`asObject()` override) and shaping array rows from the live columns and `$casts`.
  */
 final class ModelFetchedReturnTypeHelper
 {
     public function __construct(
         private readonly ReflectionProvider $reflectionProvider,
         private readonly SchemaProvider $schemaProvider,
         private readonly ColumnTypeResolver $columnTypeResolver,
+        private readonly CastTypeResolver $castTypeResolver,
     ) {}
 
     public function getFetchedReturnType(ClassReflection $classReflection, ?MethodCall $methodCall, Scope $scope): Type
@@ -91,12 +94,47 @@ private function resolveArrayRowType(ClassReflection $classReflection): Type
             return new ArrayType(new StringType(), new MixedType());
         }
 
+        $casts   = $this->readStringMap($classReflection, 'casts');
         $builder = ConstantArrayTypeBuilder::createEmpty();
 
         foreach ($table->columns as $column) {
-            $builder->setOffsetValueType(new ConstantStringType($column->name), $this->columnTypeResolver->resolve($column));
+            $builder->setOffsetValueType(new ConstantStringType($column->name), $this->resolveFieldType($column, $casts));
         }
 
         return $builder->getArray();
     }
+
+    /**
+     * @param array<string, string> $casts
+     */
+    private function resolveFieldType(Column $column, array $casts): Type
+    {
+        if (isset($casts[$column->name])) {
+            return $this->castTypeResolver->resolve($casts[$column->name]) ?? new MixedType();
+        }
+
+        return $this->columnTypeResolver->resolve($column);
+    }
+
+    /**
+     * @return array<string, string>
+     */
+    private function readStringMap(ClassReflection $classReflection, string $property): array
+    {
+        $value = $classReflection->getNativeReflection()->getDefaultProperties()[$property] ?? [];
+
+        if (! is_array($value)) {
+            return [];
+        }
+
+        $map = [];
+
+        foreach ($value as $key => $cast) {
+            if (is_string($key) && is_string($cast)) {
+                $map[$key] = $cast;
+            }
+        }
+
+        return $map;
+    }
 }

tests/Fixtures/Models/BlogPostModel.php

@@ -17,5 +17,9 @@
 
 final class BlogPostModel extends Model
 {
-    protected $table = 'blog_posts';
+    protected $table       = 'blog_posts';
+    protected array $casts = [
+        'user_id' => 'string',
+        'title'   => 'datetime',
+    ];
 }

tests/data/type-inference/model-return-types.php

@@ -31,5 +31,5 @@
 
 $posts = new BlogPostModel();
 
-assertType('array{id: int, user_id: int, title: string}|null', $posts->first());
-assertType('list<array{id: int, user_id: int, title: string}>', $posts->findAll());
+assertType('array{id: int, user_id: string, title: CodeIgniter\I18n\Time}|null', $posts->first());
+assertType('list<array{id: int, user_id: string, title: CodeIgniter\I18n\Time}>', $posts->findAll());