https://learnku.com/articles/10172/laravel-super-good-code-prompt-tool-laravel-ide-helper
- 安装ide-helper插件 最好在项目目录下安装
# 如果只想在开发环境安装请加上 --dev
composer require barryvdh/laravel-ide-helper
安装 doctrine/dbal 「请装上它,在为模型注释字段的时候必须用到它
# 如果只想在开发环境安装请加上 --dev
composer require "doctrine/dbal: ~2.3"
如果安装失败的话先执行下 composer update 命令即可。
Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
# 如果你的 Laravel 版本小于 5.5 「如果没记错」的话,请注册服务提供者,否则请忽略
- 如果你只在开发环境中安装「larave-ide-helper」,那么可以在「app/Providers/AppServiceProvider.php」的「register」方法中写入下面代码:
public function register()
{
if ($this->app->environment() !== 'production') {
$this->app->register(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
}
// ...
}
- 导出配置文件(如果默认配置就满足需求了,也可以忽略这一步)
php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config
使用
composer update
php artisan ide-helper:eloquent
php artisan ide-helper:generate //为 Facades 生成注释。 注:如果存在文件 「bootstrap/compiled.php」 需要先删除, 可以在生成文当前运行 php artisan clear-compiled
php artisan ide-helper:models // 为数据模型生成注释,为所有模型生成注释 php artisan ide-helper:models, 这时会出现询问yes/no; 输入 yes 则会直接在模型文件中写入注释,否则会生成「_ide_helper_models.php」文件
php artisan ide-helper:meta // 生成 PhpStorm Meta file
- 自动为链式操作注释
这是什么意思呢?举个例子,在 migration 文件中经常可以看见这样的代码:
$table->string('email')->unique();
这时候就算调用过了 php artisan ide-helper:generate,在调用像 ->unique() 这样的链式操作的时候也无法实现代码提示,这时候需要将配置文件「如果导出的话」‘include_fluent’ => false 修改为 ‘include_fluent’ => true,重新运行 php artisan ide-helper:generate。试试效果吧!