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

wemallshop 发布于2019-06-28 18:48 / 531人阅读

摘要：是一个极其好用的代码提示及补全工具，可以给编写代码带来极大的便利。例如事件将返回一个对象，利用文件您可以调用并且它将自动完成的方法。提示您可能需要重启使文件生效。

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" 这两个包，不用做什么配置就可以愉快的玩耍了。

如发现文中错误，请！斧！正！

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/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