yii2-extensions · terabytesoftw · Jun 17, 2025 · Jun 17, 2025 · Jun 17, 2025 · Jun 17, 2025
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@
 - Enh #43: Add tests for session property availability in `Console` and `Web` `Applications` (@terabytesoftw)
 - 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)
 
 ## 0.2.3 June 09, 2025
 

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
     <a href="https://github.com/yii2-extensions/phpstan" target="_blank">
         <img src="https://www.yiiframework.com/image/yii_logo_light.svg" height="100px;">
     </a>
-    <h1 align="center">Extension for PHPStan.</h1>
+    <h1 align="center">Extension for PHPStan</h1>
 </p>
 
 <p align="center">
@@ -26,208 +26,133 @@
     </a>  
 </p>
 
-## Installation
-
-The preferred way to install this extension is through [composer](https://getcomposer.org/download/).
+A comprehensive PHPStan extension that provides enhanced static analysis for Yii2 applications with precise type 
+inference, dynamic method resolution, and comprehensive property reflection.
 
-Either run
+## Installation
 
-```shell
-composer require --dev --prefer-dist yii2-extensions/phpstan:^0.2
+```bash
+composer require --dev yii2-extensions/phpstan
 ```
 
-or add
+## Features
 
-```json
-"yii2-extensions/phpstan": "^0.2"
-```
+✅ **ActiveRecord & ActiveQuery Analysis**
+- 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.
+- Relation methods (`hasOne()`, `hasMany()`) with accurate return types.
 
-## Usage
+✅ **Application Component Resolution**
+- Automatic type inference for `Yii::$app->component` access.
+- Behavior property and method reflection.
+- Support for custom component configurations.
+- User component with `identity`, `id`, `isGuest` property types.
 
-This extension provides enhanced static analysis for `Yii2` applications by adding:
+✅ **Dependency Injection Container**
+- Service map integration for custom services.
+- Support for closures, singletons, and nested definitions.
+- Type-safe `Container::get()` method resolution.
 
-- **Container service resolution** with proper type inference.
-- **Dynamic method return types** for `ActiveRecord` and `ActiveQuery`.
-- **Header collection dynamic methods** support.
-- **Property reflection extensions** for `Application`, `Request`, `Response`, and `User` components.
-- **Service map integration** for dependency injection analysis.
+✅ **Framework Integration**
+- Header collection dynamic method types.
+- Stub files for different application types (web, console, base).
+- Support for Yii2 constants (`YII_DEBUG`, `YII_ENV_*`).
 
-### Basic Configuration
+## Quick Start
 
-To use this extension, you need to add the following configuration to your `phpstan.neon` file:
+Create a `phpstan.neon` file in your project root.
 
 ```neon
 includes:
     - vendor/yii2-extensions/phpstan/extension.neon
 
 parameters:
-    bootstrapFiles:
-        - tests/bootstrap.php
-
     level: 5
-
     paths:
         - src
-
-    # Exclude paths from analysis
-    excludePaths:
-        - c3.php
-        - requirements.php
-        - config
-        - tests
-        - vendor
-
+        - controllers
+        - models
+
     yii2:
-        # Path to your `Yii2` configuration file (optional)
-        # If not provided or empty, will work without explicit configuration 
-        config_path: %currentWorkingDirectory%/config/test.php
+        config_path: config/test.php
 ```
 
-### Dynamic Constants Configuration
-
-The extension automatically recognizes common `Yii2` dynamic constants:
+Create a PHPStan-specific config file (`config/test.php`).
 
-- `YII_DEBUG`
-- `YII_ENV`
-- `YII_ENV_DEV`
-- `YII_ENV_PROD`
-- `YII_ENV_TEST`
-
-If you need to add additional dynamic constants, you can extend the configuration:
-
-```neon
-includes:
-    - vendor/yii2-extensions/phpstan/extension.neon
+```php
+<?php
+return [
+    'components' => [
+        'db' => [
+            'class' => yii\db\Connection::class,
+            'dsn' => 'sqlite::memory:',
+        ],
+        'user' => [
+            'class' => yii\web\User::class,
+            'identityClass' => app\models\User::class,
+        ],
+        // Add your custom components here
+    ],
+];
+```
 
-parameters:
-    # Your existing dynamic constants will be merged with the extension's defaults
-    dynamicConstantNames:
-        - YII_DEBUG         # Already included by the extension
-        - YII_ENV           # Already included by the extension
-        - YII_ENV_DEV       # Already included by the extension
-        - YII_ENV_PROD      # Already included by the extension
-        - YII_ENV_TEST      # Already included by the extension
-        - MY_CUSTOM_CONSTANT
-        - ANOTHER_CONSTANT
+Run `PHPStan`.
 
-    yii2:
-        config_path: %currentWorkingDirectory%/config/test.php
+```bash
+vendor/bin/phpstan analyse
 ```
 
-**Note:** When you define `dynamicConstantNames` in your configuration, it **replaces** the extension's default 
-constants. 
-To maintain the `Yii2` constants recognition, you must include them explicitly along with your custom constants, as
-shown above.
+## Type Inference Examples
 
-### Strict Configuration
+### ActiveRecord
 
-```neon
-includes:
-    - phar://phpstan.phar/conf/bleedingEdge.neon
-    - vendor/phpstan/phpstan-strict-rules/rules.neon
-    - vendor/yii2-extensions/phpstan/extension.neon
+```php
+// ✅ Properly typed as User|null
+$user = User::findOne(1);
 
-parameters:
-    bootstrapFiles:
-        - tests/bootstrap.php
-
-    # Complete dynamic constants list (extension defaults + custom)
-    dynamicConstantNames:
-        - YII_DEBUG
-        - YII_ENV
-        - YII_ENV_DEV
-        - YII_ENV_PROD
-        - YII_ENV_TEST
-        - APP_VERSION
-        - MAINTENANCE_MODE        
-
-    level: 8    
-
-    paths:
-        - src
-        - controllers
-        - models
-        - widgets
+// ✅ Properly typed as User[]
+$users = User::findAll(['status' => 'active']);
 
-    excludePaths:
-        - src/legacy
-        - tests/_support
-        - vendor
+// ✅ Generic ActiveQuery<User> with method chaining
+$query = User::find()->where(['active' => 1])->orderBy('name');
 
-    yii2:
-        config_path: %currentWorkingDirectory%/config/web.php
-
-    # Enable strict advanced checks
-    checkImplicitMixed: true
-    checkBenevolentUnionTypes: true
-    checkUninitializedProperties: true
-    checkMissingCallableSignature: true
-    checkTooWideReturnTypesInProtectedAndPublicMethods: true
-    reportAnyTypeWideningInVarTag: true
-    reportPossiblyNonexistentConstantArrayOffset: true
-    reportPossiblyNonexistentGeneralArrayOffset: true    
+// ✅ Array results properly typed as array{id: int, name: string}[]
+$userData = User::find()->asArray()->all();
 ```
 
-### PHPstan extension installer
+### Application Components
 
-You can use the `phpstan-extension-installer` to automatically install this extension.
-
-To do this, you need to add the following configuration to your `composer.json` file:
-
-```shell
-composer require --dev phpstan/extension-installer
-```
-
-or, add the following to your `composer.json`:
-
-```json
-{
-    "require-dev": {
-        "phpstan/extension-installer": "^1.4"
-    },
-    "config": {
-        "allow-plugins": {
-            "phpstan/extension-installer": true
-        }
-    },
+```php
+// ✅ Properly typed based on your configuration
+$mailer = Yii::$app->mailer; // MailerInterface
+$db = Yii::$app->db;         // Connection
+$user = Yii::$app->user;     // User
+
+// ✅ User identity with proper type inference
+if (Yii::$app->user->isGuest === false) {
+    $userId = Yii::$app->user->id;           // int|string|null
+    $identity = Yii::$app->user->identity;   // YourUserClass
 }
 ```
 
-### Config `yii2` application for PHPStan
-
-To configure the `yii2` application, you can use the `yii2` section in your `phpstan.neon` file:
-
-```neon
-parameters:
-    yii2:
-        # Path to your `Yii2` configuration file
-        config_path: %currentWorkingDirectory%/config/test.php
-```
-
-`config/test.php` file should return an array with the application configuration, similar to the following:
+### Dependency Injection
 
 ```php
-<?php
-
-declare(strict_types=1);
-
-use yii2\extensions\localeurls\UrlLanguageManager;
+$container = new Container();
 
-return [
-    'components' => [
-        // custom component
-        'helper' => [
-            'class' => \yii2\extensions\helper\Helper::class,
-        ],
-        // your component extended
-        'urlManager' => [
-            'class' => UrlLanguageManager::class,
-        ],
-    ],
-];
+// ✅ Type-safe service resolution
+$service = $container->get(MyService::class); // MyService
+$logger = $container->get('logger');          // LoggerInterface (if configured)
 ```
 
+## Documentation
+
+For detailed configuration options and advanced usage.
 
+- 📚 [Installation Guide](docs/installation.md)
+- ⚙️ [Configuration Reference](docs/configuration.md)
+- 💡 [Usage Examples](docs/examples.md)
 
 ## Quality code