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

wemallshop 發布于2019-06-28 18:48 / 544人閱讀

摘要：是一個極其好用的代碼提示及補全工具，可以給編寫代碼帶來極大的便利。例如事件將返回一個對象，利用文件您可以調用并且它將自動完成的方法。提示您可能需要重啟使文件生效。

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」數組中加入

BarryvdhLaravelIdeHelperIdeHelperServiceProvider::class

如果你的 Laravel 版本小于 5.5 「如果沒記錯」的話，請注冊服務提供者，否則請忽略

如果你只在開發環境中安裝「larave-ide-helper」，那么可以在「app/Providers/AppServiceProvider.php」的「register」方法中寫入下面代碼：

public function register()
{
    if ($this->app->environment() !== "production") {
        $this->app->register(BarryvdhLaravelIdeHelperIdeHelperServiceProvider::class);
    }
    // ...
}

導出配置文件（如果默認配置就滿足需求了，也可以忽略這一步）

php artisan vendor:publish --provider="BarryvdhLaravelIdeHelperIdeHelperServiceProvider" --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 IlluminateFoundationApplication $app */
$app->make("events")->fire();

// When the key is not found, it uses the argument as class name
app("AppSomeClass");

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

自動運行 generate

想在依賴包更新是自動更新注釋，可以在 composer.json 文件中做如下配置：

"scripts":{
    "post-update-cmd": [
        "IlluminateFoundationComposerScripts::postUpdate",
        "php artisan ide-helper:generate",
        "php artisan ide-helper:meta"
    ]
}

提示：如果只在 dev 環境下部署 ide helper 還是不要這么做了，防止在生產環境中報錯導致不必要的麻煩。

結尾

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

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

GPU云服務器云服務器 -laravel laravel laravel cdn php laravel

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/28666.html

Laravel5.5 綜合使用

摘要：使用開發一個自動交割的項目，把使用到的開源擴展包及特性整理起來，以供后續使用。一安裝提示工具是一個極其好用的代碼提示及補全工具，可以給編寫代碼帶來極大的便利。更多關于的任務調度，請看考該文的任務調度計劃任務功能使用 Laravel5.5 開發一個自動交割的項目，把使用到的開源擴展包及特性整理起來，以供后續使用。一、安裝IDE提示工具 Laravel IDE Helper 是一個極其...

banana_pi 2019-07-01 10:28 評論0 收藏0
[譯] 使用 PHPStorm 開發 Laravel 應用

摘要：很多程序員使用創建他們的應用程序。是一個免費開源的應用程序框架。是的模板語言，對藝術家友好，這個程序員的命令行工具可以在中工作使用插件和幫助器我們可以進一步擴展對應用的支持。很多PHP程序員使用 [laravel] 創建他們的應用程序。[laravel] 是一個免費開源的PHP web應用程序框架。它基于多個Symfony 組件，提供了一個開發框架，包括authentication,...

buildupchao 2019-06-28 13:35 評論0 收藏0
laravel使用手札——使用PHPStorm提升開發速度

摘要：安裝支持和請移步到使用手札。在安裝支持菜單欄搜索和安裝使用時可不用完全參照插件的備注方式，使用自動補全內容的格式便可以，即建設的備注格式在自動補全小結從官方文檔能看出對于支持可選和，經過試驗后發覺必須安裝才能很好地使用備注補全功能。 PHPStorm安裝 PHPStorm 使用手札——安裝看這里代碼自動提示支持 laravel引入laravel-ide-helper能為PHPStor...

caozhijian 2019-07-01 12:14 評論0 收藏0
Laravel學習筆記之Seeder填充數據小技巧

摘要：而且，與是一對多關系一個分類下有很多，一個只能歸屬于一個與是一對多關系一篇博客下有很多，一條只能歸屬于一篇與是多對多關系一篇有很多，一個下有很多。說明：本文主要聊一聊Laravel測試數據填充器Seeder的小技巧，同時介紹下Laravel開發插件三件套，這三個插件挺好用哦。同時，作者會將開發過程中的一些截圖和代碼黏上去，提高閱讀效率。備注：在設計個人博客軟件時，總會碰到有分類Ca...

cgspine 2019-06-27 13:52 評論0 收藏0
Laravel 5 IDE Helper 安裝

摘要：一項目地址二安裝方法方法一直接使用已經生成的文件下載中的，放置于項目根目錄。方法手動生成引入庫在的中添加生成輔助文件提示需要首先清除，所以生成前需要執行，生成后執行。配置以在每次提交之后執行。一、項目地址 https://github.com/barryvdh/laravel-ide-helper 二、安裝方法 1、方法一：直接使用已經生成的文件下載 https://gist.gi...

ASCH 2019-06-27 11:59 評論0 收藏0