feat: Add ActiveRecordGetAttributeDynamicMethodReturnTypeExtension to provide precise type inference for getAttribute() method calls based on PHPDoc annotations. (#47)

Author: terabytesoftw

CHANGELOG.md

@@ -14,6 +14,7 @@
 - Bug #44: Move `UserPropertiesClassReflectionExtension` to `property` directory and add testing (@terabytesoftw)
 - Bug #45: Improve `ServiceMap` configuration for application types (`Base`, `Console`, `Web`) (@terabytesoftw)
 - Bug #46: Update `README.md` to enhance clarity and structure of `docs/installation.md`, `docs/configuration.md` and `docs/examples.md` (@terabytesoftw)
+- Enh #47: Add `ActiveRecordGetAttributeDynamicMethodReturnTypeExtension` to provide precise type inference for `getAttribute()` method calls based on PHPDoc annotations (@terabytesoftw)
 
 ## 0.2.3 June 09, 2025
 

README.md

@@ -41,7 +41,11 @@ composer require --dev yii2-extensions/phpstan
 - Array/object result type inference based on `asArray()` usage.
 - Dynamic return type inference for `find()`, `findOne()`, `findAll()` methods.
 - Generic type support for `ActiveQuery<Model>` with proper chaining.
+- Hierarchical type resolution: model properties take precedence over behavior properties.
+- Precise type inference for `getAttribute()` method calls based on PHPDoc annotations.
+- Property type resolution from both model classes and attached behaviors.
 - Relation methods (`hasOne()`, `hasMany()`) with accurate return types.
+- Support for behavior property definitions through ServiceMap integration.
 
 ✅ **Application Component Resolution**
 - Automatic type inference for `Yii::$app->component` access.
@@ -119,6 +123,12 @@ $query = User::find()->where(['active' => 1])->orderBy('name');
 
 // ✅ Array results properly typed as array{id: int, name: string}[]
 $userData = User::find()->asArray()->all();
+
+// ✅ Properly typed based on model property annotations string
+$userName = $user->getAttribute('name');
+
+// ✅ Behavior property resolution string
+$slug = $user->getAttribute('slug');
 ```
 
 ### Application Components

docs/configuration.md

@@ -209,6 +209,28 @@ return [
 ];
 ```
 
+### Behavior PHPDoc Requirements
+
+For accurate type inference, behaviors should define their properties using PHPDoc.
+
+```php
+<?php
+
+use yii\base\Behavior;
+use yii\db\ActiveRecord;
+
+/**
+ * @template T of ActiveRecord
+ * @extends Behavior<T>
+ *
+ * @property int $depth
+ * @property int $lft
+ * @property int $rgt
+ * @property int|false $tree
+ */
+class NestedSetsBehavior extends Behavior {}
+```
+
 ### Container Configuration
 
 Define DI container services.

docs/examples.md

@@ -552,6 +552,75 @@ class ServiceFactory
 
 ## Behavior Examples
 
+### Dynamic Attribute Type Inference
+
+```php
+<?php
+
+use yii\behaviors\Behavior;
+use yii\db\ActiveRecord;
+
+/**
+ * Behavior with PHPDoc property definitions.
+ * 
+ * @template T of ActiveRecord
+ * @extends Behavior<T>
+ *
+ * @property int $lft
+ * @property int $rgt
+ * @property int $depth
+ * @property int|false $tree
+ */
+class NestedSetsBehavior extends Behavior
+{
+    /** @phpstan-var 'lft' */
+    public string $leftAttribute = 'lft';
+    
+    /** @phpstan-var 'rgt' */
+    public string $rightAttribute = 'rgt';
+    
+    /** @phpstan-var 'depth' */
+    public string $depthAttribute = 'depth';
+    
+    public function moveAsRoot(): bool
+    {
+        // ✅ PHPStan now knows these are int types
+        $leftValue = $this->getOwner()->getAttribute($this->leftAttribute);   // int
+        $rightValue = $this->getOwner()->getAttribute($this->rightAttribute); // int
+        $depthValue = $this->getOwner()->getAttribute($this->depthAttribute); // int
+        
+        // No more manual casting needed!
+        return $this->performMove($leftValue, $rightValue, $depthValue);
+    }
+}
+
+class Category extends ActiveRecord
+{
+    public function behaviors(): array
+    {
+        return [
+            'nestedSets' => [
+                'class' => NestedSetsBehavior::class,
+            ],
+        ];
+    }
+}
+
+class CategoryService
+{
+    public function getNodeInfo(Category $category): array
+    {
+        // ✅ PHPStan knows these are int types from behavior
+        return [
+            'left' => $category->getAttribute('lft'),    // int
+            'right' => $category->getAttribute('rgt'),   // int
+            'depth' => $category->getAttribute('depth'), // int
+            'tree' => $category->getAttribute('tree'),   // int|false
+        ];
+    }
+}
+```
+
 ### Property and Method Access through Behaviors
 
 ```php

extension.neon

@@ -38,6 +38,9 @@ services:
     -
         class: yii2\extensions\phpstan\type\ActiveRecordDynamicStaticMethodReturnTypeExtension
         tags: [phpstan.broker.dynamicStaticMethodReturnTypeExtension]
+    -
+        class: yii2\extensions\phpstan\type\ActiveRecordGetAttributeDynamicMethodReturnTypeExtension
+        tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
     -
         class: yii2\extensions\phpstan\type\ContainerDynamicMethodReturnTypeExtension
         tags: [phpstan.broker.dynamicMethodReturnTypeExtension]