barryvdh/laravel-ide-helper

这是什么？

核心功能

• 01通过 `ide-helper:generate` 生成门面的自动补全文件。
• 02根据字段、关联关系和访问器为模型生成 PHPDoc。
• 03生成 PhpStorm meta 文件，支持容器解析结果的类型推断。
• 04支持将模型注释输出到独立文件，并通过 @mixin 关联。
• 05支持宏、Fluent 迁移方法和工厂构建器的补全。

适用场景

• 在 PhpStorm 中获得 Eloquent 模型属性和关联关系的准确补全。
• 数据表结构或依赖变化后重新生成，保持 IDE 提示同步。
• 帮助 IDE 理解 Laravel 项目中的门面和容器绑定。

快速上手

1. 1

   使用 Composer 将此包安装为开发依赖

   composer require --dev barryvdh/laravel-ide-helper
2. 2

   生成 Facade 自动补全文件

   php artisan ide-helper:generate
3. 3

   为模型生成 PHPDoc 并直接写入模型文件

   php artisan ide-helper:models -RW

使用前须知

• !生成模型 PHPDoc 需要可用的数据库连接。
• !3.x 分支仅支持 Laravel 10 及更高版本，更早的版本需使用 2.x 发行版。

标签

常见问题

laravel-ide-helper 是什么？

为 Laravel 门面和 Eloquent 模型生成 PHPDoc 辅助文件，让 IDE 提供准确的代码补全。 IDE Helper for Laravel 是一个通过 Composer 安装的开发依赖，它根据项目自身的代码生成辅助文件，让编辑器提供准确的自动补全。运行 `php artisan ide-helper:generate` 会生成门面的类型描述文件；`ide-helper:models` 则会根据数据表字段、关联关系和 getter/setter 为 Eloquent 模型生成 PHPDoc。

laravel-ide-helper 可以免费使用吗？用的什么许可证？

laravel-ide-helper 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。

laravel-ide-helper 还在维护吗？

活跃维护中。laravel-ide-helper 最近一次提交是在 2026年11月3日。

laravel-ide-helper 适合用来做什么？

在 PhpStorm 中获得 Eloquent 模型属性和关联关系的准确补全。 数据表结构或依赖变化后重新生成，保持 IDE 提示同步。 帮助 IDE 理解 Laravel 项目中的门面和容器绑定。

laravel-ide-helper 怎么安装和运行？

使用 Composer 将此包安装为开发依赖: composer require --dev barryvdh/laravel-ide-helper 生成 Facade 自动补全文件: php artisan ide-helper:generate 为模型生成 PHPDoc 并直接写入模型文件: php artisan ide-helper:models -RW

在哪里获取 laravel-ide-helper？

源代码和安装说明在 GitHub 上：https://github.com/barryvdh/laravel-ide-helper