Laravel 代码提示工具 Laravel IDE Helper

1. 前言

Laravel IDE Helper 是一个极其好用的代码提示及补全工具，可以给编写代码带来极大的便利。本文主要讲解使用 PHPStorm 进行 Laravel 开发时，如何安装 Laravel IDE Helper 进行代码提示。

2. 安装

由于代码提示仅在开发时使用，所以我们只在开发环境安装对应的扩展包。

2.1 安装 barryvdh/larave-ide-helper

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

2.2 安装 doctrine/dbal

composer require doctrine/dbal --dev

3. 配置

Laravel 5.5 及以上版本引入了扩展包自动发现功能，安装后会自动注册并加载扩展包，所以基本不需要额外配置。

有一点需要修改下，如果需要在链式操作时进行代码提示（例如数据库迁移文件中定义字段），只需要发布配置文件，找到第 28 行：

.
.
.
    'include_fluent' => false,
.
.
.

将 false 修改为 true 即可。

4. 使用

4.1 Facade 代码提示

注意：如果存在 bootstrap/compiled.php 文件需要先删除，可以在运行命令前运行 php artisan clear-compiled。

php artisan ide-helper:generate

执行成功后，会生成 _ide_helper.php 文件。

4.2 模型代码提示

php artisan ide-helper:models

输入 yes 即可。

执行成功后，会在模型中添加 PHPDoc 注释。

4.3 容器解析代码提示

php artisan ide-helper:meta

执行成功后，会生成 .phpstorm.meta.php 文件。

5. 其他

如果添加了新的模型，需要重新执行命令。

参考资料：

• Laravel 超好用代码提示工具 Laravel IDE Helper