Laravel 超好用代碼提示工具 Laravel IDE Helper

Laravel IDE Helper 是一個極其好用的代碼提示及補全工具，能夠給編寫代碼帶來極大的便利。

原文連接

Github

安裝

安裝 larave-ide-helper

# 若是隻想在開發環境安裝請加上 --dev
composer require barryvdh/laravel-ide-helper

安裝 doctrine/dbal 「請裝上它，在爲模型註釋字段的時候必須用到它」

# 若是隻想在開發環境安裝請加上 --dev
composer require "doctrine/dbal: ~2.3"

在 「config/app.php」的 「providers」數組中加入

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

好了，接下去能夠愉快的使用了

使用

• 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

注: 若是存在文件 「bootstrap/compiled.php」 須要先刪除， 能夠在生成文當前運行 php artisan clear-compiled。

自動爲模型生成註釋

爲全部模型生成註釋 php artisan ide-helper:models, 這時會出現詢問：

Do you want to overwrite the existing model files? Choose no to write to _ide_helper_models.php instead? (Yes/No):  (yes/no) [no]:

輸入 yes 則會直接在模型文件中寫入註釋，不然會生成「_ide_helper_models.php」文件。建議選擇 yes，這樣在跟蹤文件的時候不會跳轉到「_ide_helper_models.php」文件，不過這麼作最好對模型文件作個備份，至少在生成註釋以前用 git 控制一下版本，以防萬一。

提示： 爲模型生成字段信息必須在數據庫中存在相應的數據表，不要生成 migration 還沒運行 migrate 的時候就生成註釋，這樣是得不到字段信息的。

自動爲鏈式操做註釋

這是什麼意思呢？舉個例子，在 migration 文件中常常能夠看見這樣的代碼：

$table->string('email')->unique();

這時候就算調用過了 php artisan ide-helper:generate，在調用像 ->unique() 這樣的鏈式操做的時候也沒法實現代碼提示，這時候須要將配置文件「若是導出的話」'include_fluent' => false 修改成 'include_fluent' => true，從新運行 php artisan ide-helper:generate。試試效果吧！

生成 .phpStorm.meta.php

能夠生成一個PhpStorm meta 文件去支持工廠模式. 對於 Laravel, 這意味着咱們可讓 PhpStorm 理解咱們從 IoC 容器中解決了什麼類型的對象。例如：事件將返回一個「IlluminateEventsDispatcher」對象，利用 meta 文件您能夠調用 app('events') 而且它將自動完成 Dispatcher 的方法。

app('events')->fire();
\App::make('events')->fire();

/** @var \Illuminate\Foundation\Application $app */
$app->make('events')->fire();

// When the key is not found, it uses the argument as class name
app('App\SomeClass');

提示：您可能須要重啓 Phpstorm 使 .phpStorm.meta.php 文件生效。

自動運行 generate

想在依賴包更新是自動更新註釋，能夠在 composer.json 文件中作以下配置：

"scripts":{
    "post-update-cmd": [
        "Illuminate\\Foundation\\ComposerScripts::postUpdate",
        "php artisan ide-helper:generate",
        "php artisan ide-helper:meta"
    ]
}

提示：若是隻在 dev 環境下部署 ide helper 仍是不要這麼作了，防止在生產環境中報錯致使沒必要要的麻煩。

結尾

整個使用大概就是這樣了，其實在 Laravel 5.5 以上版本只須要裝上 "larave-ide-helper" 和 "doctrine/dbal: ~2.3" 這兩個包，不用作什麼配置就能夠愉快的玩耍了。

如發現文中錯誤，請！斧！正！