Fix: Handle generic type components in ApplicationPropertiesClassReflectionExtension. (#59)

Author: terabytesoftw

CHANGELOG.md

@@ -25,6 +25,7 @@
 - Bug #55: Remove `OS` and `PHP` version specifications from workflow files for simplification (@terabytesoftw)
 - Enh #56: Add `ServiceLocatorDynamicMethodReturnTypeExtension` to provide precise type inference for `get()` method (@terabytesoftw)
 - Bug #57: Clarify exception documentation and improve type inference descriptions in test cases (@terabytesoftw)
+- Bug #58: Handle generic type components in `ApplicationPropertiesClassReflectionExtension`.
 
 ## 0.2.3 June 09, 2025
 

README.md

@@ -44,6 +44,8 @@ inference, dynamic method resolution, and comprehensive property reflection.
 ✅ **Application Component Resolution**
 - Automatic type inference for `Yii::$app->component` access.
 - Behavior property and method reflection.
+- Generic component support with configurable type parameters.
+- Non-destructive generic configuration - extend without overriding defaults.
 - Support for custom component configurations.
 - User component with `identity`, `id`, `isGuest` property types.
 
@@ -90,6 +92,9 @@ parameters:
     
     yii2:
         config_path: config/phpstan-config.php
+        component_generics:
+            user: identityClass      # Built-in (already configured)
+            repository: modelClass   # Custom generic component        
 ```
 
 Create a PHPStan-specific config file (`config/phpstan-config.php`).

docs/configuration.md

@@ -206,6 +206,176 @@ return [
 ];
 ```
 
+### Generic component configuration
+
+You can configure which property in the component definition contains the generic type information.
+
+#### Default generic components
+
+The extension comes with pre-configured generic support for common Yii components:
+
+```neon
+parameters:
+    yii2:
+        component_generics:
+            user: identityClass         # Built-in: User<IdentityClass>
+```
+
+#### Adding custom generic components
+
+You can extend the generic configuration without overriding the defaults:
+
+```neon
+parameters:
+    yii2:
+        component_generics:
+            userRepository: modelClass  # Add custom generic
+            postCollection: elementType # Add another custom generic
+```
+
+#### Service configuration
+
+```php
+<?php
+
+declare(strict_types=1);
+
+// config/phpstan-config.php
+return [
+    'components' => [
+        'user' => [
+            'class' => \yii\web\User::class,
+            'identityClass' => \app\models\User::class, // Generic type parameter
+        ],
+        'userRepository' => [
+            'class' => \app\repositories\Repository::class,
+            'modelClass' => \app\models\User::class,    // Generic type parameter
+        ],
+        'postCollection' => [
+            'class' => \app\collections\Collection::class,
+            'elementType' => \app\models\Post::class,   // Generic type parameter
+        ],
+    ],
+];
+```
+
+#### Usage with proper type inference
+
+```php
+<?php
+
+declare(strict_types=1);
+
+use Yii;
+
+class UserController
+{
+    public function actionProfile(): string
+    {
+        // ✅ PHPStan knows this is User<app\models\User>
+        $user = Yii::$app->user;
+        
+        // ✅ PHPStan knows identity is app\models\User
+        $identity = $user->identity;
+        
+        // ✅ PHPStan knows this is Repository<app\models\User>
+        $repository = Yii::$app->userRepository;
+        
+        // ✅ PHPStan knows this is Collection<app\models\Post>
+        $collection = Yii::$app->postCollection;
+        
+        return $this->render('profile', ['user' => $identity]);
+    }
+}
+```
+
+#### Creating generic-aware components
+
+For your custom components to work with generics, define them using PHPDoc annotations:
+
+```php
+<?php
+
+declare(strict_types=1);
+
+namespace app\repositories;
+
+use yii\base\Component;
+
+/**
+ * Generic repository component.
+ * 
+ * @template T of \yii\db\ActiveRecord
+ */
+class Repository extends Component
+{
+    /** 
+     * @phpstan-var class-string<T>
+     */
+    public string $modelClass;
+    
+    /**
+     * @phpstan-return T|null
+     */
+    public function findOne(int $id): \yii\db\ActiveRecord|null
+    {
+        return $this->modelClass::findOne($id);
+    }
+    
+    /**
+     * @phpstan-return T[]
+     */
+    public function findAll(): array
+    {
+        return $this->modelClass::find()->all();
+    }
+}
+```
+
+```php
+<?php
+
+declare(strict_types=1);
+
+namespace app\collections;
+
+use yii\base\Component;
+
+/**
+ * Generic collection component.
+ * 
+ * @template T
+ */
+class Collection extends Component
+{
+    /** 
+     * @phpstan-var class-string<T>
+     */
+    public string $elementType;
+    
+    /** 
+     * @phpstan-var T[]
+     */
+    private array $items = [];
+    
+    /**
+     * @phpstan-param T $item
+     */
+    public function add($item): void
+    {
+        $this->items[] = $item;
+    }
+    
+    /**
+     * @phpstan-return T[]
+     */
+    public function getAll(): array
+    {
+        return $this->items;
+    }
+}
+```
+
 ### Behavior configuration
 
 Configure behaviors for proper method and property reflection.

docs/examples.md

@@ -345,35 +345,57 @@ class UserService
 }
 ```
 
-### Custom components
+### Custom components with generics
 
 ```php
 <?php
 
 declare(strict_types=1);
 
-// Component configuration in config/phpstan.php
+// Component configuration in config/phpstan-config.php
 return [
     'components' => [
         'paymentService' => [
             'class' => \app\services\PaymentService::class,
         ],
-        'imageProcessor' => [
-            'class' => \app\services\ImageProcessor::class,
+        'userRepository' => [
+            'class' => \app\repositories\Repository::class,
+            'modelClass' => \app\models\User::class,
+        ],
+        'postRepository' => [
+            'class' => \app\repositories\Repository::class,
+            'modelClass' => \app\models\Post::class,
         ],
     ],
 ];
+```
+
+Generic configuration in phpstan.neon.
+
+```neon
+parameters:
+    yii2:
+        component_generics:
+            userRepository: modelClass
+            postRepository: modelClass
+```            
+
+Usage in controllers and services:
+
+```php
+<?php
+
+declare(strict_types=1);
 
-// Usage in controllers
 use Yii;
 use yii\web\Controller;
 
 class PaymentController extends Controller
 {
     public function actionProcess(): array
     {
-        // ✅ PHPStan knows this is PaymentService
-        $paymentService = Yii::$app->paymentService; // PaymentService
+        // ✅ PHPStan knows this is PaymentService (non-generic component)
+        $paymentService = Yii::$app->paymentService;
 
         $result = $paymentService->processPayment(
             [
@@ -386,22 +408,60 @@ class PaymentController extends Controller
         // ✅ PHPStan knows the return type based on method signature
         return $result; // array
     }
+}
+```
+
+```php
+<?php
+
+declare(strict_types=1);
+
+use Yii;
+
+class UserController extends Controller
+{
+    public function actionIndex(): array
+    {
+        // ✅ PHPStan knows this is Repository<app\models\User> (generic component)
+        $userRepository = Yii::$app->userRepository;
+        
+        // ✅ PHPStan knows findAll() returns app\models\User[]
+        $users = $userRepository->findAll();
+        
+        // ✅ PHPStan knows this is Repository<app\models\Post> (generic component)
+        $postRepository = Yii::$app->postRepository;
+        
+        // ✅ PHPStan knows findOne() returns app\models\Post|null
+        $post = $postRepository->findOne(1);
+        
+        return $this->render(
+            'index', 
+            [
+                'users' => $users,
+                'post' => $post,
+            ],
+        );
+    }
 
-    public function actionProcessImage(): string
+    public function actionUserProfile(int $id): string
     {
-        // ✅ PHPStan knows this is ImageProcessor
-        $imageProcessor = Yii::$app->imageProcessor; // ImageProcessor
+        // ✅ PHPStan knows this is Repository<app\models\User> (generic component)
+        $repository = Yii::$app->userRepository;
 
-        $uploadedFile = \yii\web\UploadedFile::getInstanceByName('image');
+        // ✅ PHPStan knows findOne() returns app\models\User|null
+        $user = $repository->findOne($id); // app\models\User|null
 
-        if ($uploadedFile !== null) {
-            // ✅ Method calls are typed
-            $processedPath = $imageProcessor->resize($uploadedFile->tempName, 800, 600);
-            
-            return $processedPath; // string
+        if ($user === null) {
+            throw new \yii\web\NotFoundHttpException('User not found');
         }
 
-        throw new \yii\web\BadRequestHttpException('No image uploaded');
+        // ✅ PHPStan knows $user is app\models\User (not null)
+        return $this->render(
+            'profile',
+            [
+                'user' => $user,
+            ],
+        );
     }
 }
 ```
@@ -438,7 +498,7 @@ class ServiceManager
         // ✅ Type-safe service resolution
         $paymentService = $this->container->get(PaymentService::class); // PaymentService
         $emailService = $this->container->get(EmailService::class);     // EmailService
-        $cache = $this->container->get('cache');                        // CacheService (if configured)
+        $cache = $this->container->get('cache');                        // CacheService (if configured) or mixed
 
         $paymentResult = $paymentService->charge($orderData['total']);
 
@@ -505,7 +565,7 @@ class CustomServiceManager extends ServiceLocator
 
 declare(strict_types=1);
 
-// config/phpstan.php - Container configuration
+// config/phpstan-config.php - Container configuration
 return [
     'container' => [
         'definitions' => [

extension.neon

@@ -8,11 +8,14 @@ parameters:
 
     yii2:
         config_path: ''
+        component_generics:
+            user: identityClass
 
 parametersSchema:
 	yii2: structure(
         [
-		    config_path: schema(string())
+		    config_path: schema(string()),
+            component_generics: schema(arrayOf(string(), string()))
 	    ]
     )
 
@@ -23,12 +26,11 @@ services:
     -
         class: yii2\extensions\phpstan\property\ApplicationPropertiesClassReflectionExtension
         tags: [phpstan.broker.propertiesClassReflectionExtension]
+        arguments:
+            genericComponents: %yii2.component_generics%
     -
         class: yii2\extensions\phpstan\property\BehaviorPropertiesClassReflectionExtension
         tags: [phpstan.broker.propertiesClassReflectionExtension]
-    -
-        class: yii2\extensions\phpstan\property\UserPropertiesClassReflectionExtension
-        tags: [phpstan.broker.propertiesClassReflectionExtension]
     -
         class: yii2\extensions\phpstan\type\ActiveQueryDynamicMethodReturnTypeExtension
         tags: [phpstan.broker.dynamicMethodReturnTypeExtension]