Shape object returnType model rows from their columns

Author: paulbalandan

src/Type/ModelFetchedReturnTypeHelper.php

@@ -27,6 +27,7 @@
 use PHPStan\Type\Constant\ConstantArrayTypeBuilder;
 use PHPStan\Type\Constant\ConstantStringType;
 use PHPStan\Type\MixedType;
+use PHPStan\Type\ObjectShapeType;
 use PHPStan\Type\ObjectType;
 use PHPStan\Type\ObjectWithoutClassType;
 use PHPStan\Type\StringType;
@@ -51,7 +52,7 @@ public function getFetchedReturnType(ClassReflection $classReflection, ?MethodCa
         $returnType = $this->resolveReturnType($classReflection, $methodCall, $scope);
 
         if ($returnType === 'object') {
-            return new ObjectType(stdClass::class);
+            return $this->resolveObjectRowType($classReflection);
         }
 
         if ($returnType === 'array') {
@@ -85,24 +86,55 @@ private function resolveReturnType(ClassReflection $classReflection, ?MethodCall
     }
 
     private function resolveArrayRowType(ClassReflection $classReflection): Type
+    {
+        $fields = $this->resolveRowFieldTypes($classReflection);
+
+        if ($fields === null) {
+            return new ArrayType(new StringType(), new MixedType());
+        }
+
+        $builder = ConstantArrayTypeBuilder::createEmpty();
+
+        foreach ($fields as $name => $type) {
+            $builder->setOffsetValueType(new ConstantStringType($name), $type);
+        }
+
+        return $builder->getArray();
+    }
+
+    private function resolveObjectRowType(ClassReflection $classReflection): Type
+    {
+        $fields = $this->resolveRowFieldTypes($classReflection);
+
+        if ($fields === null) {
+            return new ObjectType(stdClass::class);
+        }
+
+        return new ObjectShapeType($fields, []);
+    }
+
+    /**
+     * @return array<string, Type>|null Null when the model's table cannot be resolved.
+     */
+    private function resolveRowFieldTypes(ClassReflection $classReflection): ?array
     {
         $tableName = $classReflection->getNativeReflection()->getDefaultProperties()['table'] ?? null;
 
         $table = is_string($tableName) && $tableName !== '' ? $this->schemaProvider->get()->getTable($tableName) : null;
 
         if ($table === null) {
-            return new ArrayType(new StringType(), new MixedType());
+            return null;
         }
 
         $casts        = $this->readStringMap($classReflection, 'casts');
         $castHandlers = $this->readStringMap($classReflection, 'castHandlers');
-        $builder      = ConstantArrayTypeBuilder::createEmpty();
+        $fields       = [];
 
         foreach ($table->columns as $column) {
-            $builder->setOffsetValueType(new ConstantStringType($column->name), $this->resolveFieldType($column, $casts, $castHandlers));
+            $fields[$column->name] = $this->resolveFieldType($column, $casts, $castHandlers);
         }
 
-        return $builder->getArray();
+        return $fields;
     }
 
     /**

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

@@ -27,7 +27,7 @@
 assertType('CodeIgniter\PHPStan\Tests\Fixtures\Entity\BlogComment|null', $comments->first());
 
 assertType('array{id: int, body: string|null, votes: int, payload: string|null, created_at: string|null}|null', $comments->asArray()->first());
-assertType('stdClass|null', $comments->asObject()->first());
+assertType('object{id: int, body: string|null, votes: int, payload: string|null, created_at: string|null}|null', $comments->asObject()->first());
 
 $posts = new BlogPostModel();