小編給大家分享一下如何使用Laravel IDE Helper提示工具,相信大部分人都還不怎么了解,因此分享這篇文章給大家參考一下,希望大家閱讀完這篇文章后大有收獲,下面讓我們一起去了解一下吧!
創(chuàng)新互聯長期為超過千家客戶提供的網站建設服務,團隊從業(yè)經驗10年,關注不同地域、不同群體,并針對不同對象提供差異化的產品和服務;打造開放共贏平臺,與合作伙伴共同營造健康的互聯網生態(tài)環(huán)境。為肇州企業(yè)提供專業(yè)的做網站、網站制作,肇州網站改版等技術服務。擁有十年豐富建站經驗和眾多成功案例,為您定制開發(fā)。
安裝 larave-ide-helper
# 如果只想在開發(fā)環(huán)境 安裝請加上 --dev composer require barryvdh/laravel-ide-helper
安裝 doctrine/dbal 「請裝上它,在為模型注釋字段的時候必須用到它」
# 如果只想在開發(fā)環(huán)境安裝請加上 --dev composer require "doctrine/dbal: ~2.3"
在 「config/app.php」的 「providers」數組中加入
Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class
如果你的 Laravel 版本小于 5.5 「如果沒記錯」的話,請注冊服務提供者,否則請忽略
如果你只在開發(fā)環(huán)境中安裝「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 文件去支持工廠模式。對于 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 環(huán)境下部署 ide helper 還是不要這么做了,防止在生產環(huán)境中報錯導致不必要的麻煩。
以上是“如何使用Laravel IDE Helper提示工具”這篇文章的所有內容,感謝各位的閱讀!相信大家都有了一定的了解,希望分享的內容對大家有所幫助,如果還想學習更多知識,歡迎關注創(chuàng)新互聯行業(yè)資訊頻道!