安装 laravel-ide-helper

简介

安装

  • composer require barryvdh/laravel-ide-helper

注册服务提供者

  • 在config/app.php中providers下添加代码
'providers' => [
    Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class
]

自动运行 generate

  • 想在依赖包更新是自动更新注释,可以在 composer.json 文件中做如下配置
"scripts":{
    "post-update-cmd": [
        "Illuminate\\Foundation\\ComposerScripts::postUpdate",
        "php artisan ide-helper:generate",
        "php artisan ide-helper:meta"
    ]
}

生成配置文件

php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config

  • 然后在生成的config/ide-helper.php中第28行将 ‘include_fluent’ => false, 修改为 ‘include_fluent’ => true,
  • 建议将 ‘include_helpers’ => false,’ (66行)改为true 作用:让Laravel Ide Helper帮我们建立helper function注解
  • 当你的model目录修改时在 配置文件中82行将 'app’修改为你的model所在目录

使用

php artisan ide-helper:generate - 为 Facades 生成注释
php artisan ide-helper:models - 为数据模型生成注释
php artisan ide-helper:meta - 生成 PhpStorm Meta file

自动为 Laravel 的 Facades 生成注释

php artisan ide-helper:generate

自动为模型生成注释

//输入 yes 则会直接在模型文件中写入注释,否则会生「_ide_helper_models.php」文件
php artisan ide-helper:models

生成 .phpStorm.meta.php

可以生成一个 PhpStorm meta 文件去支持工厂模式。对于 Laravel, 这意味着我们可以让 PhpStorm 理解我们从 IoC 容器中解决了什么类型的对象
php artisan ide-helper:meta

结束

  • 感谢阅读

推荐阅读更多精彩内容