✅ 作用#

laravel-ide-helper 是一个为 Laravel 项目生成 PHPDocs 的开发辅助工具。它可以让你的 IDE （PhpStorm / VS Code ）能够：

• 智能补全 Laravel Facade 方法
• 识别 Eloquent 模型的属性与关系
• 添加 IoC 容器解析类的类型提示
• 自动生成 macro / mixin / Fluent 方法文档

🔍 说白了：让 IDE 更懂 Laravel。

1. 安装#

1
composer require --dev barryvdh/laravel-ide-helper

1. Facade PHPDocs#

1
php artisan ide-helper:generate

🔹 生成 _ide_helper.php，使 IDE 识别如 DB, Auth, Cache 等 Facade。

2. 生成模型注释#

1
php artisan ide-helper:models -RW

🔍 需正常数据库连接。

3. PhpStorm Meta 文件#

1
php artisan ide-helper:meta

🔹 生成 .phpstorm.meta.php 文件，使 PhpStorm 能识别 app('events')等的对象类型。

1. Composer 自动生成#

1
"scripts": {
2
  "post-update-cmd": [
3
    "@php artisan ide-helper:generate",
4
    "@php artisan ide-helper:meta"
5
  ]
6
}

2. Fluent 方法支持#

开启后，IDE 可识别 $table->string()->nullable()->index();

1
'include_fluent' => true,

3. Macros / Mixins#

当使用 Str::macro() 时，如果定义有类型提示，IDE Helper 会自动生成相应 PHPDocs。

4. 自定义 Model Hooks#

允许在模型生成过程中动态添加属性或方法：

1
'model_hooks' => [
2
   MyCustomHook::class,
3
],

5. 忽略某些模型#

1
php artisan ide-helper:models --ignore="App\Models\User,App\Models\Post"