Merge pull request #306 from lptn/model-accessors

Optimize property check
psalm · Jan 29, 2023 · 93ff966 · 93ff966
2 parents dd16593 + 096aca4
commit 93ff966
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 6 deletions.
diff --git a/src/Handlers/Eloquent/ModelMethodHandler.php b/src/Handlers/Eloquent/ModelMethodHandler.php
@@ -68,12 +68,8 @@ public static function getMethodReturnType(MethodReturnTypeProviderEvent $event)
         return null;
     }
 
-    /**
-     * @param  FileManipulation[] $file_replacements
-     *
-     * @return void
-     */
-    public static function afterClassLikeVisit(AfterClassLikeVisitEvent $event)
+    /** @inheritDoc */
+    public static function afterClassLikeVisit(AfterClassLikeVisitEvent $event): void
     {
         $storage = $event->getStorage();
         if (

diff --git a/src/Handlers/Eloquent/ModelPropertyAccessorHandler.php b/src/Handlers/Eloquent/ModelPropertyAccessorHandler.php
@@ -32,6 +32,10 @@ public static function doesPropertyExist(PropertyExistenceProviderEvent $event):
             return null;
         }
 
+        if (self::hasNativeProperty($event->getFqClasslikeName(), $event->getPropertyName())) {
+            return true;
+        }
+
         $codebase = $source->getCodebase();
 
         if (self::accessorExists($codebase, $event->getFqClasslikeName(), $event->getPropertyName())) {
@@ -47,6 +51,10 @@ public static function isPropertyVisible(PropertyVisibilityProviderEvent $event)
             return null;
         }
 
+        if (self::hasNativeProperty($event->getFqClasslikeName(), $event->getPropertyName())) {
+            return null;
+        }
+
         $codebase = $event->getSource()->getCodebase();
 
         if (self::accessorExists($codebase, $event->getFqClasslikeName(), $event->getPropertyName())) {
@@ -64,6 +72,11 @@ public static function getPropertyType(PropertyTypeProviderEvent $event): ?Type\
             return null;
         }
 
+        // skip for real properties like $hidden, $casts
+        if (self::hasNativeProperty($event->getFqClasslikeName(), $event->getPropertyName())) {
+            return null;
+        }
+
         $codebase = $source->getCodebase();
         $fq_classlike_name = $event->getFqClasslikeName();
         $property_name = $event->getPropertyName();
@@ -76,6 +89,17 @@ public static function getPropertyType(PropertyTypeProviderEvent $event): ?Type\
         return null;
     }
 
+    private static function hasNativeProperty(string $fqcn, string $property_name): bool
+    {
+        try {
+            new \ReflectionProperty($fqcn, $property_name);
+        } catch (\ReflectionException $exception) {
+            return false;
+        }
+
+        return true;
+    }
+
     private static function accessorExists(Codebase $codebase, string $fq_classlike_name, string $property_name): bool
     {
         return $codebase->methodExists($fq_classlike_name . '::get' . str_replace('_', '', $property_name) . 'Attribute');

diff --git a/tests/Models/User.php b/tests/Models/User.php
@@ -60,4 +60,9 @@ public function scopeActive($query)
     {
         return $query->where('active', 1);
     }
+
+    public function getFirstNameUsingLegacyAccessorAttribute(): string
+    {
+        return $this->name;
+    }
 }
diff --git a/tests/acceptance/EloquentModelPropertyTypes.feature b/tests/acceptance/EloquentModelPropertyTypes.feature
@@ -57,3 +57,14 @@ Feature: Eloquent Model property types
     """
     When I run Psalm
     Then I see no errors
+
+  Scenario: Legacy Attribute accessor
+    Given I have the following code
+    """
+      function test(User $user): string
+      {
+        return $user->first_name_using_legacy_accessor;
+      }
+    """
+    When I run Psalm
+    Then I see no errors